| Title: | 'Amazon Web Services' Management & Governance Services |
| Version: | 0.9.0 |
| Description: | Interface to 'Amazon Web Services' management and governance services, including 'CloudWatch' application and infrastructure monitoring, 'Auto Scaling' for automatically scaling resources, and more https://aws.amazon.com/. |
| License: | Apache License (≥ 2.0) |
| URL: | https://github.com/paws-r/paws, https://paws-r.r-universe.dev/paws.management |
| BugReports: | https://github.com/paws-r/paws/issues |
| Imports: | paws.common (≥ 0.8.0) |
| Suggests: | testthat |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.2 |
| Collate: | 'applicationautoscaling_service.R' 'applicationautoscaling_interfaces.R' 'applicationautoscaling_operations.R' 'applicationcostprofiler_service.R' 'applicationcostprofiler_interfaces.R' 'applicationcostprofiler_operations.R' 'applicationinsights_service.R' 'applicationinsights_interfaces.R' 'applicationinsights_operations.R' 'appregistry_service.R' 'appregistry_interfaces.R' 'appregistry_operations.R' 'auditmanager_service.R' 'auditmanager_interfaces.R' 'auditmanager_operations.R' 'autoscaling_service.R' 'autoscaling_interfaces.R' 'autoscaling_operations.R' 'autoscalingplans_service.R' 'autoscalingplans_interfaces.R' 'autoscalingplans_operations.R' 'cloudformation_service.R' 'cloudformation_interfaces.R' 'cloudformation_operations.R' 'cloudtrail_service.R' 'cloudtrail_interfaces.R' 'cloudtrail_operations.R' 'cloudtraildataservice_service.R' 'cloudtraildataservice_interfaces.R' 'cloudtraildataservice_operations.R' 'cloudwatch_service.R' 'cloudwatch_interfaces.R' 'cloudwatch_operations.R' 'cloudwatchapplicationsignals_service.R' 'cloudwatchapplicationsignals_interfaces.R' 'cloudwatchapplicationsignals_operations.R' 'cloudwatchevidently_service.R' 'cloudwatchevidently_interfaces.R' 'cloudwatchevidently_operations.R' 'cloudwatchinternetmonitor_service.R' 'cloudwatchinternetmonitor_interfaces.R' 'cloudwatchinternetmonitor_operations.R' 'cloudwatchlogs_service.R' 'cloudwatchlogs_interfaces.R' 'cloudwatchlogs_operations.R' 'cloudwatchobservabilityaccessmanager_service.R' 'cloudwatchobservabilityaccessmanager_interfaces.R' 'cloudwatchobservabilityaccessmanager_operations.R' 'cloudwatchrum_service.R' 'cloudwatchrum_interfaces.R' 'cloudwatchrum_operations.R' 'configservice_service.R' 'configservice_interfaces.R' 'configservice_operations.R' 'controltower_service.R' 'controltower_interfaces.R' 'controltower_operations.R' 'finspace_service.R' 'finspace_interfaces.R' 'finspace_operations.R' 'health_service.R' 'health_interfaces.R' 'health_operations.R' 'licensemanager_service.R' 'licensemanager_interfaces.R' 'licensemanager_operations.R' 'licensemanagerlinuxsubscriptions_service.R' 'licensemanagerlinuxsubscriptions_interfaces.R' 'licensemanagerlinuxsubscriptions_operations.R' 'licensemanagerusersubscriptions_service.R' 'licensemanagerusersubscriptions_interfaces.R' 'licensemanagerusersubscriptions_operations.R' 'managedgrafana_service.R' 'managedgrafana_interfaces.R' 'managedgrafana_operations.R' 'opsworks_service.R' 'opsworks_interfaces.R' 'opsworks_operations.R' 'opsworkscm_service.R' 'opsworkscm_interfaces.R' 'opsworkscm_operations.R' 'organizations_service.R' 'organizations_interfaces.R' 'organizations_operations.R' 'pi_service.R' 'pi_interfaces.R' 'pi_operations.R' 'prometheusservice_service.R' 'prometheusservice_interfaces.R' 'prometheusservice_operations.R' 'reexports_paws.common.R' 'resiliencehub_service.R' 'resiliencehub_interfaces.R' 'resiliencehub_operations.R' 'resourcegroups_service.R' 'resourcegroups_interfaces.R' 'resourcegroups_operations.R' 'resourcegroupstaggingapi_service.R' 'resourcegroupstaggingapi_interfaces.R' 'resourcegroupstaggingapi_operations.R' 'servicecatalog_service.R' 'servicecatalog_interfaces.R' 'servicecatalog_operations.R' 'servicequotas_service.R' 'servicequotas_interfaces.R' 'servicequotas_operations.R' 'ssm_service.R' 'ssm_interfaces.R' 'ssm_operations.R' 'ssmcontacts_service.R' 'ssmcontacts_interfaces.R' 'ssmcontacts_operations.R' 'ssmincidents_service.R' 'ssmincidents_interfaces.R' 'ssmincidents_operations.R' 'ssmsap_service.R' 'ssmsap_interfaces.R' 'ssmsap_operations.R' 'support_service.R' 'support_interfaces.R' 'support_operations.R' 'supportapp_service.R' 'supportapp_interfaces.R' 'supportapp_operations.R' 'synthetics_service.R' 'synthetics_interfaces.R' 'synthetics_operations.R' |
| NeedsCompilation: | no |
| Packaged: | 2025-03-14 09:22:51 UTC; dyfanjones |
| Author: | David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph] |
| Maintainer: | Dyfan Jones <dyfan.r.jones@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-03-14 16:10:02 UTC |
Application Auto Scaling
Description
With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon AppStream 2.0 fleets
Amazon Aurora Replicas
Amazon Comprehend document classification and entity recognizer endpoints
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon ECS services
Amazon ElastiCache for Redis clusters (replication groups)
Amazon EMR clusters
Amazon Keyspaces (for Apache Cassandra) tables
Lambda function provisioned concurrency
Amazon Managed Streaming for Apache Kafka broker storage
Amazon Neptune clusters
Amazon SageMaker endpoint variants
Amazon SageMaker inference components
Amazon SageMaker serverless endpoint provisioned concurrency
Spot Fleets (Amazon EC2)
Pool of WorkSpaces
Custom resources provided by your own applications or services
To learn more about Application Auto Scaling, see the Application Auto Scaling User Guide.
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the
register_scalable_targetAPI action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.
Usage
applicationautoscaling(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- applicationautoscaling(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| delete_scaling_policy | Deletes the specified scaling policy for an Application Auto Scaling scalable target |
| delete_scheduled_action | Deletes the specified scheduled action for an Application Auto Scaling scalable target |
| deregister_scalable_target | Deregisters an Application Auto Scaling scalable target when you have finished using it |
| describe_scalable_targets | Gets information about the scalable targets in the specified namespace |
| describe_scaling_activities | Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks |
| describe_scaling_policies | Describes the Application Auto Scaling scaling policies for the specified service namespace |
| describe_scheduled_actions | Describes the Application Auto Scaling scheduled actions for the specified service namespace |
| get_predictive_scaling_forecast | Retrieves the forecast data for a predictive scaling policy |
| list_tags_for_resource | Returns all the tags on the specified Application Auto Scaling scalable target |
| put_scaling_policy | Creates or updates a scaling policy for an Application Auto Scaling scalable target |
| put_scheduled_action | Creates or updates a scheduled action for an Application Auto Scaling scalable target |
| register_scalable_target | Registers or updates a scalable target, which is the resource that you want to scale |
| tag_resource | Adds or edits tags on an Application Auto Scaling scalable target |
| untag_resource | Deletes tags from an Application Auto Scaling scalable target |
Examples
## Not run:
svc <- applicationautoscaling()
# This example deletes a scaling policy for the Amazon ECS service called
# web-app, which is running in the default cluster.
svc$delete_scaling_policy(
PolicyName = "web-app-cpu-lt-25",
ResourceId = "service/default/web-app",
ScalableDimension = "ecs:service:DesiredCount",
ServiceNamespace = "ecs"
)
## End(Not run)
Deletes the specified scaling policy for an Application Auto Scaling scalable target
Description
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_delete_scaling_policy/ for full documentation.
Usage
applicationautoscaling_delete_scaling_policy(
PolicyName,
ServiceNamespace,
ResourceId,
ScalableDimension
)
Arguments
PolicyName |
[required] The name of the scaling policy. |
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
[required] The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
|
Deletes the specified scheduled action for an Application Auto Scaling scalable target
Description
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_delete_scheduled_action/ for full documentation.
Usage
applicationautoscaling_delete_scheduled_action(
ServiceNamespace,
ScheduledActionName,
ResourceId,
ScalableDimension
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ScheduledActionName |
[required] The name of the scheduled action. |
ResourceId |
[required] The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
|
Deregisters an Application Auto Scaling scalable target when you have finished using it
Description
Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use describe_scalable_targets.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_deregister_scalable_target/ for full documentation.
Usage
applicationautoscaling_deregister_scalable_target(
ServiceNamespace,
ResourceId,
ScalableDimension
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
[required] The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
|
Gets information about the scalable targets in the specified namespace
Description
Gets information about the scalable targets in the specified namespace.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_describe_scalable_targets/ for full documentation.
Usage
applicationautoscaling_describe_scalable_targets(
ServiceNamespace,
ResourceIds = NULL,
ScalableDimension = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceIds |
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
|
ScalableDimension |
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
|
MaxResults |
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to |
NextToken |
The token for the next set of results. |
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks
Description
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_describe_scaling_activities/ for full documentation.
Usage
applicationautoscaling_describe_scaling_activities(
ServiceNamespace,
ResourceId = NULL,
ScalableDimension = NULL,
MaxResults = NULL,
NextToken = NULL,
IncludeNotScaledActivities = NULL
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
|
ScalableDimension |
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
|
MaxResults |
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to |
NextToken |
The token for the next set of results. |
IncludeNotScaledActivities |
Specifies whether to include activities that aren't scaled (not scaled activities) in the response. Not scaled activities are activities that aren't completed or started for various reasons, such as preventing infinite scaling loops. For help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling. |
Describes the Application Auto Scaling scaling policies for the specified service namespace
Description
Describes the Application Auto Scaling scaling policies for the specified service namespace.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_describe_scaling_policies/ for full documentation.
Usage
applicationautoscaling_describe_scaling_policies(
PolicyNames = NULL,
ServiceNamespace,
ResourceId = NULL,
ScalableDimension = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
PolicyNames |
The names of the scaling policies to describe. |
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
|
ScalableDimension |
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
|
MaxResults |
The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10. If this parameter is used, the operation returns up to |
NextToken |
The token for the next set of results. |
Describes the Application Auto Scaling scheduled actions for the specified service namespace
Description
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_describe_scheduled_actions/ for full documentation.
Usage
applicationautoscaling_describe_scheduled_actions(
ScheduledActionNames = NULL,
ServiceNamespace,
ResourceId = NULL,
ScalableDimension = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ScheduledActionNames |
The names of the scheduled actions to describe. |
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
|
ScalableDimension |
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
|
MaxResults |
The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to |
NextToken |
The token for the next set of results. |
Retrieves the forecast data for a predictive scaling policy
Description
Retrieves the forecast data for a predictive scaling policy.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_get_predictive_scaling_forecast/ for full documentation.
Usage
applicationautoscaling_get_predictive_scaling_forecast(
ServiceNamespace,
ResourceId,
ScalableDimension,
PolicyName,
StartTime,
EndTime
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
[required] The identifier of the resource. |
ScalableDimension |
[required] The scalable dimension. |
PolicyName |
[required] The name of the policy. |
StartTime |
[required] The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time |
EndTime |
[required] The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days. |
Returns all the tags on the specified Application Auto Scaling scalable target
Description
Returns all the tags on the specified Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_list_tags_for_resource/ for full documentation.
Usage
applicationautoscaling_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] Specify the ARN of the scalable target. For example:
To get the ARN for a scalable target, use
|
Creates or updates a scaling policy for an Application Auto Scaling scalable target
Description
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_put_scaling_policy/ for full documentation.
Usage
applicationautoscaling_put_scaling_policy(
PolicyName,
ServiceNamespace,
ResourceId,
ScalableDimension,
PolicyType = NULL,
StepScalingPolicyConfiguration = NULL,
TargetTrackingScalingPolicyConfiguration = NULL,
PredictiveScalingPolicyConfiguration = NULL
)
Arguments
PolicyName |
[required] The name of the scaling policy. You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name. |
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
[required] The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
|
PolicyType |
The scaling policy type. This parameter is required if you are creating a scaling policy. The following policy types are supported:
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. |
StepScalingPolicyConfiguration |
A step scaling policy. This parameter is required if you are creating a policy and the policy
type is |
TargetTrackingScalingPolicyConfiguration |
A target tracking scaling policy. Includes support for predefined or customized metrics. This parameter is required if you are creating a policy and the policy
type is |
PredictiveScalingPolicyConfiguration |
The configuration of the predictive scaling policy. |
Creates or updates a scheduled action for an Application Auto Scaling scalable target
Description
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_put_scheduled_action/ for full documentation.
Usage
applicationautoscaling_put_scheduled_action(
ServiceNamespace,
Schedule = NULL,
Timezone = NULL,
ScheduledActionName,
ResourceId,
ScalableDimension,
StartTime = NULL,
EndTime = NULL,
ScalableTargetAction = NULL
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
Schedule |
The schedule for this action. The following formats are supported:
At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is
For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide. |
Timezone |
Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default. Valid values are the canonical names of the IANA time zones supported by
Joda-Time (such as |
ScheduledActionName |
[required] The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target. |
ResourceId |
[required] The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
|
StartTime |
The date and time for this scheduled action to start, in UTC. |
EndTime |
The date and time for the recurring schedule to end, in UTC. |
ScalableTargetAction |
The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. |
Registers or updates a scalable target, which is the resource that you want to scale
Description
Registers or updates a scalable target, which is the resource that you want to scale.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_register_scalable_target/ for full documentation.
Usage
applicationautoscaling_register_scalable_target(
ServiceNamespace,
ResourceId,
ScalableDimension,
MinCapacity = NULL,
MaxCapacity = NULL,
RoleARN = NULL,
SuspendedState = NULL,
Tags = NULL
)
Arguments
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use |
ResourceId |
[required] The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
|
MinCapacity |
The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target. For the following resources, the minimum value allowed is 0.
It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization. For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept. |
MaxCapacity |
The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target. Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference. |
RoleARN |
This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see How Application Auto Scaling works with IAM. |
SuspendedState |
An embedded object that contains attributes and attribute values that
are used to suspend and resume automatic scaling. Setting the value of
an attribute to Suspension Outcomes
For more information, see Suspend and resume scaling in the Application Auto Scaling User Guide. |
Tags |
Assigns one or more tags to the scalable target. Use this parameter to
tag the scalable target when it is created. To tag an existing scalable
target, use the Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide. |
Adds or edits tags on an Application Auto Scaling scalable target
Description
Adds or edits tags on an Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_tag_resource/ for full documentation.
Usage
applicationautoscaling_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] Identifies the Application Auto Scaling scalable target that you want to apply tags to. For example:
To get the ARN for a scalable target, use
|
Tags |
[required] The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a tag key and a tag value. You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key. If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the current tag value with the specified one. For information about the rules that apply to tag keys and tag values, see User-defined tag restrictions in the Amazon Web Services Billing User Guide. |
Deletes tags from an Application Auto Scaling scalable target
Description
Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
See https://www.paws-r-sdk.com/docs/applicationautoscaling_untag_resource/ for full documentation.
Usage
applicationautoscaling_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] Identifies the Application Auto Scaling scalable target from which to remove tags. For example:
To get the ARN for a scalable target, use
|
TagKeys |
[required] One or more tag keys. Specify only the tag keys, not the tag values. |
AWS Application Cost Profiler
Description
This reference provides descriptions of the AWS Application Cost Profiler API.
The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete application cost report definitions, as well as to import your usage data into the Application Cost Profiler service.
For more information about using this service, see the AWS Application Cost Profiler User Guide.
Usage
applicationcostprofiler(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- applicationcostprofiler(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| delete_report_definition | Deletes the specified report definition in AWS Application Cost Profiler |
| get_report_definition | Retrieves the definition of a report already configured in AWS Application Cost Profiler |
| import_application_usage | Ingests application usage data from Amazon Simple Storage Service (Amazon S3) |
| list_report_definitions | Retrieves a list of all reports and their configurations for your AWS account |
| put_report_definition | Creates the report definition for a report in Application Cost Profiler |
| update_report_definition | Updates existing report in AWS Application Cost Profiler |
Examples
## Not run:
svc <- applicationcostprofiler()
svc$delete_report_definition(
Foo = 123
)
## End(Not run)
Deletes the specified report definition in AWS Application Cost Profiler
Description
Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.
See https://www.paws-r-sdk.com/docs/applicationcostprofiler_delete_report_definition/ for full documentation.
Usage
applicationcostprofiler_delete_report_definition(reportId)
Arguments
reportId |
[required] Required. ID of the report to delete. |
Retrieves the definition of a report already configured in AWS Application Cost Profiler
Description
Retrieves the definition of a report already configured in AWS Application Cost Profiler.
See https://www.paws-r-sdk.com/docs/applicationcostprofiler_get_report_definition/ for full documentation.
Usage
applicationcostprofiler_get_report_definition(reportId)
Arguments
reportId |
[required] ID of the report to retrieve. |
Ingests application usage data from Amazon Simple Storage Service (Amazon S3)
Description
Ingests application usage data from Amazon Simple Storage Service (Amazon S3).
See https://www.paws-r-sdk.com/docs/applicationcostprofiler_import_application_usage/ for full documentation.
Usage
applicationcostprofiler_import_application_usage(sourceS3Location)
Arguments
sourceS3Location |
[required] Amazon S3 location to import application usage data from. |
Retrieves a list of all reports and their configurations for your AWS account
Description
Retrieves a list of all reports and their configurations for your AWS account.
See https://www.paws-r-sdk.com/docs/applicationcostprofiler_list_report_definitions/ for full documentation.
Usage
applicationcostprofiler_list_report_definitions(
nextToken = NULL,
maxResults = NULL
)
Arguments
nextToken |
The token value from a previous call to access the next page of results. |
maxResults |
The maximum number of results to return. |
Creates the report definition for a report in Application Cost Profiler
Description
Creates the report definition for a report in Application Cost Profiler.
See https://www.paws-r-sdk.com/docs/applicationcostprofiler_put_report_definition/ for full documentation.
Usage
applicationcostprofiler_put_report_definition(
reportId,
reportDescription,
reportFrequency,
format,
destinationS3Location
)
Arguments
reportId |
[required] Required. ID of the report. You can choose any valid string matching the pattern for the ID. |
reportDescription |
[required] Required. Description of the report. |
reportFrequency |
[required] Required. The cadence to generate the report. |
format |
[required] Required. The format to use for the generated report. |
destinationS3Location |
[required] Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report. |
Updates existing report in AWS Application Cost Profiler
Description
Updates existing report in AWS Application Cost Profiler.
See https://www.paws-r-sdk.com/docs/applicationcostprofiler_update_report_definition/ for full documentation.
Usage
applicationcostprofiler_update_report_definition(
reportId,
reportDescription,
reportFrequency,
format,
destinationS3Location
)
Arguments
reportId |
[required] Required. ID of the report to update. |
reportDescription |
[required] Required. Description of the report. |
reportFrequency |
[required] Required. The cadence to generate the report. |
format |
[required] Required. The format to use for the generated report. |
destinationS3Location |
[required] Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report. |
Amazon CloudWatch Application Insights
Description
Amazon CloudWatch Application Insights is a service that helps you detect common problems with your applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.
After you onboard your application, CloudWatch Application Insights identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.
Usage
applicationinsights(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- applicationinsights(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| add_workload | Adds a workload to a component |
| create_application | Adds an application that is created from a resource group |
| create_component | Creates a custom component by grouping similar standalone instances to monitor |
| create_log_pattern | Adds an log pattern to a LogPatternSet |
| delete_application | Removes the specified application from monitoring |
| delete_component | Ungroups a custom component |
| delete_log_pattern | Removes the specified log pattern from a LogPatternSet |
| describe_application | Describes the application |
| describe_component | Describes a component and lists the resources that are grouped together in a component |
| describe_component_configuration | Describes the monitoring configuration of the component |
| describe_component_configuration_recommendation | Describes the recommended monitoring configuration of the component |
| describe_log_pattern | Describe a specific log pattern from a LogPatternSet |
| describe_observation | Describes an anomaly or error with the application |
| describe_problem | Describes an application problem |
| describe_problem_observations | Describes the anomalies or errors associated with the problem |
| describe_workload | Describes a workload and its configuration |
| list_applications | Lists the IDs of the applications that you are monitoring |
| list_components | Lists the auto-grouped, standalone, and custom components of the application |
| list_configuration_history | Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights |
| list_log_patterns | Lists the log patterns in the specific log LogPatternSet |
| list_log_pattern_sets | Lists the log pattern sets in the specific application |
| list_problems | Lists the problems with your application |
| list_tags_for_resource | Retrieve a list of the tags (keys and values) that are associated with a specified application |
| list_workloads | Lists the workloads that are configured on a given component |
| remove_workload | Remove workload from a component |
| tag_resource | Add one or more tags (keys and values) to a specified application |
| untag_resource | Remove one or more tags (keys and values) from a specified application |
| update_application | Updates the application |
| update_component | Updates the custom component name and/or the list of resources that make up the component |
| update_component_configuration | Updates the monitoring configurations for the component |
| update_log_pattern | Adds a log pattern to a LogPatternSet |
| update_problem | Updates the visibility of the problem or specifies the problem as RESOLVED |
| update_workload | Adds a workload to a component |
Examples
## Not run:
svc <- applicationinsights()
svc$add_workload(
Foo = 123
)
## End(Not run)
Adds a workload to a component
Description
Adds a workload to a component. Each component can have at most five workloads.
See https://www.paws-r-sdk.com/docs/applicationinsights_add_workload/ for full documentation.
Usage
applicationinsights_add_workload(
ResourceGroupName,
ComponentName,
WorkloadConfiguration
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
WorkloadConfiguration |
[required] The configuration settings of the workload. The value is the escaped JSON of the configuration. |
Adds an application that is created from a resource group
Description
Adds an application that is created from a resource group.
See https://www.paws-r-sdk.com/docs/applicationinsights_create_application/ for full documentation.
Usage
applicationinsights_create_application(
ResourceGroupName = NULL,
OpsCenterEnabled = NULL,
CWEMonitorEnabled = NULL,
OpsItemSNSTopicArn = NULL,
SNSNotificationArn = NULL,
Tags = NULL,
AutoConfigEnabled = NULL,
AutoCreate = NULL,
GroupingType = NULL,
AttachMissingPermission = NULL
)
Arguments
ResourceGroupName |
The name of the resource group. |
OpsCenterEnabled |
When set to |
CWEMonitorEnabled |
Indicates whether Application Insights can listen to CloudWatch events
for the application resources, such as |
OpsItemSNSTopicArn |
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem. |
SNSNotificationArn |
The SNS notification topic ARN. |
Tags |
List of tags to add to the application. tag key ( |
AutoConfigEnabled |
Indicates whether Application Insights automatically configures unmonitored resources in the resource group. |
AutoCreate |
Configures all of the resources in the resource group by applying the recommended configurations. |
GroupingType |
Application Insights can create applications based on a resource group
or on an account. To create an account-based application using all of
the resources in the account, set this parameter to |
AttachMissingPermission |
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing. |
Creates a custom component by grouping similar standalone instances to monitor
Description
Creates a custom component by grouping similar standalone instances to monitor.
See https://www.paws-r-sdk.com/docs/applicationinsights_create_component/ for full documentation.
Usage
applicationinsights_create_component(
ResourceGroupName,
ComponentName,
ResourceList
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
ResourceList |
[required] The list of resource ARNs that belong to the component. |
Adds an log pattern to a LogPatternSet
Description
Adds an log pattern to a LogPatternSet.
See https://www.paws-r-sdk.com/docs/applicationinsights_create_log_pattern/ for full documentation.
Usage
applicationinsights_create_log_pattern(
ResourceGroupName,
PatternSetName,
PatternName,
Pattern,
Rank
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
PatternSetName |
[required] The name of the log pattern set. |
PatternName |
[required] The name of the log pattern. |
Pattern |
[required] The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported. |
Rank |
[required] Rank of the log pattern. Must be a value between |
Removes the specified application from monitoring
Description
Removes the specified application from monitoring. Does not delete the application.
See https://www.paws-r-sdk.com/docs/applicationinsights_delete_application/ for full documentation.
Usage
applicationinsights_delete_application(ResourceGroupName)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
Ungroups a custom component
Description
Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.
See https://www.paws-r-sdk.com/docs/applicationinsights_delete_component/ for full documentation.
Usage
applicationinsights_delete_component(ResourceGroupName, ComponentName)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
Removes the specified log pattern from a LogPatternSet
Description
Removes the specified log pattern from a LogPatternSet.
See https://www.paws-r-sdk.com/docs/applicationinsights_delete_log_pattern/ for full documentation.
Usage
applicationinsights_delete_log_pattern(
ResourceGroupName,
PatternSetName,
PatternName
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
PatternSetName |
[required] The name of the log pattern set. |
PatternName |
[required] The name of the log pattern. |
Describes the application
Description
Describes the application.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_application/ for full documentation.
Usage
applicationinsights_describe_application(ResourceGroupName, AccountId = NULL)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Describes a component and lists the resources that are grouped together in a component
Description
Describes a component and lists the resources that are grouped together in a component.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_component/ for full documentation.
Usage
applicationinsights_describe_component(
ResourceGroupName,
ComponentName,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Describes the monitoring configuration of the component
Description
Describes the monitoring configuration of the component.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_component_configuration/ for full documentation.
Usage
applicationinsights_describe_component_configuration(
ResourceGroupName,
ComponentName,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Describes the recommended monitoring configuration of the component
Description
Describes the recommended monitoring configuration of the component.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_component_configuration_recommendation/ for full documentation.
Usage
applicationinsights_describe_component_configuration_recommendation(
ResourceGroupName,
ComponentName,
Tier,
WorkloadName = NULL,
RecommendationType = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
Tier |
[required] The tier of the application component. |
WorkloadName |
The name of the workload. The name of the workload is required when the
tier of the application component is |
RecommendationType |
The recommended configuration type. |
Describe a specific log pattern from a LogPatternSet
Description
Describe a specific log pattern from a LogPatternSet.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_log_pattern/ for full documentation.
Usage
applicationinsights_describe_log_pattern(
ResourceGroupName,
PatternSetName,
PatternName,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
PatternSetName |
[required] The name of the log pattern set. |
PatternName |
[required] The name of the log pattern. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Describes an anomaly or error with the application
Description
Describes an anomaly or error with the application.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_observation/ for full documentation.
Usage
applicationinsights_describe_observation(ObservationId, AccountId = NULL)
Arguments
ObservationId |
[required] The ID of the observation. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Describes an application problem
Description
Describes an application problem.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_problem/ for full documentation.
Usage
applicationinsights_describe_problem(ProblemId, AccountId = NULL)
Arguments
ProblemId |
[required] The ID of the problem. |
AccountId |
The Amazon Web Services account ID for the owner of the resource group affected by the problem. |
Describes the anomalies or errors associated with the problem
Description
Describes the anomalies or errors associated with the problem.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_problem_observations/ for full documentation.
Usage
applicationinsights_describe_problem_observations(ProblemId, AccountId = NULL)
Arguments
ProblemId |
[required] The ID of the problem. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Describes a workload and its configuration
Description
Describes a workload and its configuration.
See https://www.paws-r-sdk.com/docs/applicationinsights_describe_workload/ for full documentation.
Usage
applicationinsights_describe_workload(
ResourceGroupName,
ComponentName,
WorkloadId,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
WorkloadId |
[required] The ID of the workload. |
AccountId |
The Amazon Web Services account ID for the workload owner. |
Lists the IDs of the applications that you are monitoring
Description
Lists the IDs of the applications that you are monitoring.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_applications/ for full documentation.
Usage
applicationinsights_list_applications(
MaxResults = NULL,
NextToken = NULL,
AccountId = NULL
)
Arguments
MaxResults |
The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token to request the next page of results. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Lists the auto-grouped, standalone, and custom components of the application
Description
Lists the auto-grouped, standalone, and custom components of the application.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_components/ for full documentation.
Usage
applicationinsights_list_components(
ResourceGroupName,
MaxResults = NULL,
NextToken = NULL,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
MaxResults |
The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token to request the next page of results. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights
Description
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
See https://www.paws-r-sdk.com/docs/applicationinsights_list_configuration_history/ for full documentation.
Usage
applicationinsights_list_configuration_history(
ResourceGroupName = NULL,
StartTime = NULL,
EndTime = NULL,
EventStatus = NULL,
MaxResults = NULL,
NextToken = NULL,
AccountId = NULL
)
Arguments
ResourceGroupName |
Resource group to which the application belongs. |
StartTime |
The start time of the event. |
EndTime |
The end time of the event. |
EventStatus |
The status of the configuration update event. Possible values include INFO, WARN, and ERROR. |
MaxResults |
The maximum number of results returned by
|
NextToken |
The |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Lists the log pattern sets in the specific application
Description
Lists the log pattern sets in the specific application.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_log_pattern_sets/ for full documentation.
Usage
applicationinsights_list_log_pattern_sets(
ResourceGroupName,
MaxResults = NULL,
NextToken = NULL,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
MaxResults |
The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token to request the next page of results. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Lists the log patterns in the specific log LogPatternSet
Description
Lists the log patterns in the specific log LogPatternSet.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_log_patterns/ for full documentation.
Usage
applicationinsights_list_log_patterns(
ResourceGroupName,
PatternSetName = NULL,
MaxResults = NULL,
NextToken = NULL,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
PatternSetName |
The name of the log pattern set. |
MaxResults |
The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token to request the next page of results. |
AccountId |
The Amazon Web Services account ID for the resource group owner. |
Lists the problems with your application
Description
Lists the problems with your application.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_problems/ for full documentation.
Usage
applicationinsights_list_problems(
AccountId = NULL,
ResourceGroupName = NULL,
StartTime = NULL,
EndTime = NULL,
MaxResults = NULL,
NextToken = NULL,
ComponentName = NULL,
Visibility = NULL
)
Arguments
AccountId |
The Amazon Web Services account ID for the resource group owner. |
ResourceGroupName |
The name of the resource group. |
StartTime |
The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned. |
EndTime |
The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned. |
MaxResults |
The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token to request the next page of results. |
ComponentName |
The name of the component. |
Visibility |
Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned. |
Retrieve a list of the tags (keys and values) that are associated with a specified application
Description
Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_tags_for_resource/ for full documentation.
Usage
applicationinsights_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for. |
Lists the workloads that are configured on a given component
Description
Lists the workloads that are configured on a given component.
See https://www.paws-r-sdk.com/docs/applicationinsights_list_workloads/ for full documentation.
Usage
applicationinsights_list_workloads(
ResourceGroupName,
ComponentName,
MaxResults = NULL,
NextToken = NULL,
AccountId = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
MaxResults |
The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token to request the next page of results. |
AccountId |
The Amazon Web Services account ID of the owner of the workload. |
Remove workload from a component
Description
Remove workload from a component.
See https://www.paws-r-sdk.com/docs/applicationinsights_remove_workload/ for full documentation.
Usage
applicationinsights_remove_workload(
ResourceGroupName,
ComponentName,
WorkloadId
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
WorkloadId |
[required] The ID of the workload. |
Add one or more tags (keys and values) to a specified application
Description
Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.
See https://www.paws-r-sdk.com/docs/applicationinsights_tag_resource/ for full documentation.
Usage
applicationinsights_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the application that you want to add one or more tags to. |
Tags |
[required] A list of tags that to add to the application. A tag consists of a
required tag key ( |
Remove one or more tags (keys and values) from a specified application
Description
Remove one or more tags (keys and values) from a specified application.
See https://www.paws-r-sdk.com/docs/applicationinsights_untag_resource/ for full documentation.
Usage
applicationinsights_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from. |
TagKeys |
[required] The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value. To remove more than one tag from the application, append the |
Updates the application
Description
Updates the application.
See https://www.paws-r-sdk.com/docs/applicationinsights_update_application/ for full documentation.
Usage
applicationinsights_update_application(
ResourceGroupName,
OpsCenterEnabled = NULL,
CWEMonitorEnabled = NULL,
OpsItemSNSTopicArn = NULL,
SNSNotificationArn = NULL,
RemoveSNSTopic = NULL,
AutoConfigEnabled = NULL,
AttachMissingPermission = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
OpsCenterEnabled |
When set to |
CWEMonitorEnabled |
Indicates whether Application Insights can listen to CloudWatch events
for the application resources, such as |
OpsItemSNSTopicArn |
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem. |
SNSNotificationArn |
The SNS topic ARN. Allows you to receive SNS notifications for updates and issues with an application. |
RemoveSNSTopic |
Disassociates the SNS topic from the opsItem created for detected problems. |
AutoConfigEnabled |
Turns auto-configuration on or off. |
AttachMissingPermission |
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing. |
Updates the custom component name and/or the list of resources that make up the component
Description
Updates the custom component name and/or the list of resources that make up the component.
See https://www.paws-r-sdk.com/docs/applicationinsights_update_component/ for full documentation.
Usage
applicationinsights_update_component(
ResourceGroupName,
ComponentName,
NewComponentName = NULL,
ResourceList = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
NewComponentName |
The new name of the component. |
ResourceList |
The list of resource ARNs that belong to the component. |
Updates the monitoring configurations for the component
Description
Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by describe_component_configuration_recommendation.
See https://www.paws-r-sdk.com/docs/applicationinsights_update_component_configuration/ for full documentation.
Usage
applicationinsights_update_component_configuration(
ResourceGroupName,
ComponentName,
Monitor = NULL,
Tier = NULL,
ComponentConfiguration = NULL,
AutoConfigEnabled = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
Monitor |
Indicates whether the application component is monitored. |
Tier |
The tier of the application component. |
ComponentConfiguration |
The configuration settings of the component. The value is the escaped
JSON of the configuration. For more information about the JSON format,
see Working with JSON.
You can send a request to
|
AutoConfigEnabled |
Automatically configures the component by applying the recommended configurations. |
Adds a log pattern to a LogPatternSet
Description
Adds a log pattern to a LogPatternSet.
See https://www.paws-r-sdk.com/docs/applicationinsights_update_log_pattern/ for full documentation.
Usage
applicationinsights_update_log_pattern(
ResourceGroupName,
PatternSetName,
PatternName,
Pattern = NULL,
Rank = NULL
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
PatternSetName |
[required] The name of the log pattern set. |
PatternName |
[required] The name of the log pattern. |
Pattern |
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported. |
Rank |
Rank of the log pattern. Must be a value between |
Updates the visibility of the problem or specifies the problem as RESOLVED
Description
Updates the visibility of the problem or specifies the problem as RESOLVED.
See https://www.paws-r-sdk.com/docs/applicationinsights_update_problem/ for full documentation.
Usage
applicationinsights_update_problem(
ProblemId,
UpdateStatus = NULL,
Visibility = NULL
)
Arguments
ProblemId |
[required] The ID of the problem. |
UpdateStatus |
The status of the problem. Arguments can be passed for only problems
that show a status of |
Visibility |
The visibility of a problem. When you pass a value of |
Adds a workload to a component
Description
Adds a workload to a component. Each component can have at most five workloads.
See https://www.paws-r-sdk.com/docs/applicationinsights_update_workload/ for full documentation.
Usage
applicationinsights_update_workload(
ResourceGroupName,
ComponentName,
WorkloadId = NULL,
WorkloadConfiguration
)
Arguments
ResourceGroupName |
[required] The name of the resource group. |
ComponentName |
[required] The name of the component. |
WorkloadId |
The ID of the workload. |
WorkloadConfiguration |
[required] The configuration settings of the workload. The value is the escaped JSON of the configuration. |
AWS Service Catalog App Registry
Description
Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.
Usage
appregistry(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- appregistry(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_attribute_group | Associates an attribute group with an application to augment the application's metadata with the group's attributes |
| associate_resource | Associates a resource with an application |
| create_application | Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions |
| create_attribute_group | Creates a new attribute group as a container for user-defined attributes |
| delete_application | Deletes an application that is specified either by its application ID, name, or ARN |
| delete_attribute_group | Deletes an attribute group, specified either by its attribute group ID, name, or ARN |
| disassociate_attribute_group | Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata |
| disassociate_resource | Disassociates a resource from application |
| get_application | Retrieves metadata information about one of your applications |
| get_associated_resource | Gets the resource associated with the application |
| get_attribute_group | Retrieves an attribute group by its ARN, ID, or name |
| get_configuration | Retrieves a TagKey configuration from an account |
| list_applications | Retrieves a list of all of your applications |
| list_associated_attribute_groups | Lists all attribute groups that are associated with specified application |
| list_associated_resources | Lists all of the resources that are associated with the specified application |
| list_attribute_groups | Lists all attribute groups which you have access to |
| list_attribute_groups_for_application | Lists the details of all attribute groups associated with a specific application |
| list_tags_for_resource | Lists all of the tags on the resource |
| put_configuration | Associates a TagKey configuration to an account |
| sync_resource | Syncs the resource with current AppRegistry records |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified resource |
| untag_resource | Removes tags from a resource |
| update_application | Updates an existing application with new attributes |
| update_attribute_group | Updates an existing attribute group with new details |
Examples
## Not run:
svc <- appregistry()
svc$associate_attribute_group(
Foo = 123
)
## End(Not run)
Associates an attribute group with an application to augment the application's metadata with the group's attributes
Description
Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.
See https://www.paws-r-sdk.com/docs/appregistry_associate_attribute_group/ for full documentation.
Usage
appregistry_associate_attribute_group(application, attributeGroup)
Arguments
application |
[required] The name, ID, or ARN of the application. |
attributeGroup |
[required] The name, ID, or ARN of the attribute group that holds the attributes to describe the application. |
Associates a resource with an application
Description
Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.
See https://www.paws-r-sdk.com/docs/appregistry_associate_resource/ for full documentation.
Usage
appregistry_associate_resource(
application,
resourceType,
resource,
options = NULL
)
Arguments
application |
[required] The name, ID, or ARN of the application. |
resourceType |
[required] The type of resource of which the application will be associated. |
resource |
[required] The name or ID of the resource of which the application will be associated. |
options |
Determines whether an application tag is applied or skipped. |
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions
Description
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
See https://www.paws-r-sdk.com/docs/appregistry_create_application/ for full documentation.
Usage
appregistry_create_application(
name,
description = NULL,
tags = NULL,
clientToken
)
Arguments
name |
[required] The name of the application. The name must be unique in the region in which you are creating the application. |
description |
The description of the application. |
tags |
Key-value pairs you can use to associate with the application. |
clientToken |
[required] A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails. |
Creates a new attribute group as a container for user-defined attributes
Description
Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.
See https://www.paws-r-sdk.com/docs/appregistry_create_attribute_group/ for full documentation.
Usage
appregistry_create_attribute_group(
name,
description = NULL,
attributes,
tags = NULL,
clientToken
)
Arguments
name |
[required] The name of the attribute group. |
description |
The description of the attribute group that the user provides. |
attributes |
[required] A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components. |
tags |
Key-value pairs you can use to associate with the attribute group. |
clientToken |
[required] A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails. |
Deletes an application that is specified either by its application ID, name, or ARN
Description
Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.
See https://www.paws-r-sdk.com/docs/appregistry_delete_application/ for full documentation.
Usage
appregistry_delete_application(application)
Arguments
application |
[required] The name, ID, or ARN of the application. |
Deletes an attribute group, specified either by its attribute group ID, name, or ARN
Description
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
See https://www.paws-r-sdk.com/docs/appregistry_delete_attribute_group/ for full documentation.
Usage
appregistry_delete_attribute_group(attributeGroup)
Arguments
attributeGroup |
[required] The name, ID, or ARN of the attribute group that holds the attributes to describe the application. |
Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata
Description
Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts associate_attribute_group.
See https://www.paws-r-sdk.com/docs/appregistry_disassociate_attribute_group/ for full documentation.
Usage
appregistry_disassociate_attribute_group(application, attributeGroup)
Arguments
application |
[required] The name, ID, or ARN of the application. |
attributeGroup |
[required] The name, ID, or ARN of the attribute group that holds the attributes to describe the application. |
Disassociates a resource from application
Description
Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.
See https://www.paws-r-sdk.com/docs/appregistry_disassociate_resource/ for full documentation.
Usage
appregistry_disassociate_resource(application, resourceType, resource)
Arguments
application |
[required] The name or ID of the application. |
resourceType |
[required] The type of the resource that is being disassociated. |
resource |
[required] The name or ID of the resource. |
Retrieves metadata information about one of your applications
Description
Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.
See https://www.paws-r-sdk.com/docs/appregistry_get_application/ for full documentation.
Usage
appregistry_get_application(application)
Arguments
application |
[required] The name, ID, or ARN of the application. |
Gets the resource associated with the application
Description
Gets the resource associated with the application.
See https://www.paws-r-sdk.com/docs/appregistry_get_associated_resource/ for full documentation.
Usage
appregistry_get_associated_resource(
application,
resourceType,
resource,
nextToken = NULL,
resourceTagStatus = NULL,
maxResults = NULL
)
Arguments
application |
[required] The name, ID, or ARN of the application. |
resourceType |
[required] The type of resource associated with the application. |
resource |
[required] The name or ID of the resource associated with the application. |
nextToken |
A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results. |
resourceTagStatus |
States whether an application tag is applied, not applied, in the process of being applied, or skipped. |
maxResults |
The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional. |
Retrieves an attribute group by its ARN, ID, or name
Description
Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
See https://www.paws-r-sdk.com/docs/appregistry_get_attribute_group/ for full documentation.
Usage
appregistry_get_attribute_group(attributeGroup)
Arguments
attributeGroup |
[required] The name, ID, or ARN of the attribute group that holds the attributes to describe the application. |
Retrieves a TagKey configuration from an account
Description
Retrieves a TagKey configuration from an account.
See https://www.paws-r-sdk.com/docs/appregistry_get_configuration/ for full documentation.
Usage
appregistry_get_configuration()
Retrieves a list of all of your applications
Description
Retrieves a list of all of your applications. Results are paginated.
See https://www.paws-r-sdk.com/docs/appregistry_list_applications/ for full documentation.
Usage
appregistry_list_applications(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
The token to use to get the next page of results after a previous API call. |
maxResults |
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional. |
Lists all attribute groups that are associated with specified application
Description
Lists all attribute groups that are associated with specified application. Results are paginated.
See https://www.paws-r-sdk.com/docs/appregistry_list_associated_attribute_groups/ for full documentation.
Usage
appregistry_list_associated_attribute_groups(
application,
nextToken = NULL,
maxResults = NULL
)
Arguments
application |
[required] The name or ID of the application. |
nextToken |
The token to use to get the next page of results after a previous API call. |
maxResults |
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional. |
Lists all of the resources that are associated with the specified application
Description
Lists all of the resources that are associated with the specified application. Results are paginated.
See https://www.paws-r-sdk.com/docs/appregistry_list_associated_resources/ for full documentation.
Usage
appregistry_list_associated_resources(
application,
nextToken = NULL,
maxResults = NULL
)
Arguments
application |
[required] The name, ID, or ARN of the application. |
nextToken |
The token to use to get the next page of results after a previous API call. |
maxResults |
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional. |
Lists all attribute groups which you have access to
Description
Lists all attribute groups which you have access to. Results are paginated.
See https://www.paws-r-sdk.com/docs/appregistry_list_attribute_groups/ for full documentation.
Usage
appregistry_list_attribute_groups(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
The token to use to get the next page of results after a previous API call. |
maxResults |
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional. |
Lists the details of all attribute groups associated with a specific application
Description
Lists the details of all attribute groups associated with a specific application. The results display in pages.
See https://www.paws-r-sdk.com/docs/appregistry_list_attribute_groups_for_application/ for full documentation.
Usage
appregistry_list_attribute_groups_for_application(
application,
nextToken = NULL,
maxResults = NULL
)
Arguments
application |
[required] The name or ID of the application. |
nextToken |
This token retrieves the next page of results after a previous API call. |
maxResults |
The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional. |
Lists all of the tags on the resource
Description
Lists all of the tags on the resource.
See https://www.paws-r-sdk.com/docs/appregistry_list_tags_for_resource/ for full documentation.
Usage
appregistry_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon resource name (ARN) that specifies the resource. |
Associates a TagKey configuration to an account
Description
Associates a TagKey configuration to an account.
See https://www.paws-r-sdk.com/docs/appregistry_put_configuration/ for full documentation.
Usage
appregistry_put_configuration(configuration)
Arguments
configuration |
[required] Associates a |
Syncs the resource with current AppRegistry records
Description
Syncs the resource with current AppRegistry records.
See https://www.paws-r-sdk.com/docs/appregistry_sync_resource/ for full documentation.
Usage
appregistry_sync_resource(resourceType, resource)
Arguments
resourceType |
[required] The type of resource of which the application will be associated. |
resource |
[required] An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket. |
Assigns one or more tags (key-value pairs) to the specified resource
Description
Assigns one or more tags (key-value pairs) to the specified resource.
See https://www.paws-r-sdk.com/docs/appregistry_tag_resource/ for full documentation.
Usage
appregistry_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon resource name (ARN) that specifies the resource. |
tags |
[required] The new or modified tags for the resource. |
Removes tags from a resource
Description
Removes tags from a resource.
See https://www.paws-r-sdk.com/docs/appregistry_untag_resource/ for full documentation.
Usage
appregistry_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon resource name (ARN) that specifies the resource. |
tagKeys |
[required] A list of the tag keys to remove from the specified resource. |
Updates an existing application with new attributes
Description
Updates an existing application with new attributes.
See https://www.paws-r-sdk.com/docs/appregistry_update_application/ for full documentation.
Usage
appregistry_update_application(application, name = NULL, description = NULL)
Arguments
application |
[required] The name, ID, or ARN of the application that will be updated. |
name |
Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates. |
description |
The new description of the application. |
Updates an existing attribute group with new details
Description
Updates an existing attribute group with new details.
See https://www.paws-r-sdk.com/docs/appregistry_update_attribute_group/ for full documentation.
Usage
appregistry_update_attribute_group(
attributeGroup,
name = NULL,
description = NULL,
attributes = NULL
)
Arguments
attributeGroup |
[required] The name, ID, or ARN of the attribute group that holds the attributes to describe the application. |
name |
Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group. Please do not use this field as we have stopped supporting name updates. |
description |
The description of the attribute group that the user provides. |
attributes |
A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components. |
AWS Audit Manager
Description
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.
Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
-
Actions: An alphabetical list of all Audit Manager API operations.
-
Data types: An alphabetical list of all Audit Manager data types.
-
Common parameters: Parameters that all operations can use.
-
Common errors: Client and server errors that all operations can return.
If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
Usage
auditmanager(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- auditmanager(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_assessment_report_evidence_folder | Associates an evidence folder to an assessment report in an Audit Manager assessment |
| batch_associate_assessment_report_evidence | Associates a list of evidence to an assessment report in an Audit Manager assessment |
| batch_create_delegation_by_assessment | Creates a batch of delegations for an assessment in Audit Manager |
| batch_delete_delegation_by_assessment | Deletes a batch of delegations for an assessment in Audit Manager |
| batch_disassociate_assessment_report_evidence | Disassociates a list of evidence from an assessment report in Audit Manager |
| batch_import_evidence_to_assessment_control | Adds one or more pieces of evidence to a control in an Audit Manager assessment |
| create_assessment | Creates an assessment in Audit Manager |
| create_assessment_framework | Creates a custom framework in Audit Manager |
| create_assessment_report | Creates an assessment report for the specified assessment |
| create_control | Creates a new custom control in Audit Manager |
| delete_assessment | Deletes an assessment in Audit Manager |
| delete_assessment_framework | Deletes a custom framework in Audit Manager |
| delete_assessment_framework_share | Deletes a share request for a custom framework in Audit Manager |
| delete_assessment_report | Deletes an assessment report in Audit Manager |
| delete_control | Deletes a custom control in Audit Manager |
| deregister_account | Deregisters an account in Audit Manager |
| deregister_organization_admin_account | Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager |
| disassociate_assessment_report_evidence_folder | Disassociates an evidence folder from the specified assessment report in Audit Manager |
| get_account_status | Gets the registration status of an account in Audit Manager |
| get_assessment | Gets information about a specified assessment |
| get_assessment_framework | Gets information about a specified framework |
| get_assessment_report_url | Gets the URL of an assessment report in Audit Manager |
| get_change_logs | Gets a list of changelogs from Audit Manager |
| get_control | Gets information about a specified control |
| get_delegations | Gets a list of delegations from an audit owner to a delegate |
| get_evidence | Gets information about a specified evidence item |
| get_evidence_by_evidence_folder | Gets all evidence from a specified evidence folder in Audit Manager |
| get_evidence_file_upload_url | Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence |
| get_evidence_folder | Gets an evidence folder from a specified assessment in Audit Manager |
| get_evidence_folders_by_assessment | Gets the evidence folders from a specified assessment in Audit Manager |
| get_evidence_folders_by_assessment_control | Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment |
| get_insights | Gets the latest analytics data for all your current active assessments |
| get_insights_by_assessment | Gets the latest analytics data for a specific active assessment |
| get_organization_admin_account | Gets the name of the delegated Amazon Web Services administrator account for a specified organization |
| get_services_in_scope | Gets a list of the Amazon Web Services from which Audit Manager can collect evidence |
| get_settings | Gets the settings for a specified Amazon Web Services account |
| list_assessment_control_insights_by_control_domain | Lists the latest analytics data for controls within a specific control domain and a specific active assessment |
| list_assessment_frameworks | Returns a list of the frameworks that are available in the Audit Manager framework library |
| list_assessment_framework_share_requests | Returns a list of sent or received share requests for custom frameworks in Audit Manager |
| list_assessment_reports | Returns a list of assessment reports created in Audit Manager |
| list_assessments | Returns a list of current and past assessments from Audit Manager |
| list_control_domain_insights | Lists the latest analytics data for control domains across all of your active assessments |
| list_control_domain_insights_by_assessment | Lists analytics data for control domains within a specified active assessment |
| list_control_insights_by_control_domain | Lists the latest analytics data for controls within a specific control domain across all active assessments |
| list_controls | Returns a list of controls from Audit Manager |
| list_keywords_for_data_source | Returns a list of keywords that are pre-mapped to the specified control data source |
| list_notifications | Returns a list of all Audit Manager notifications |
| list_tags_for_resource | Returns a list of tags for the specified resource in Audit Manager |
| register_account | Enables Audit Manager for the specified Amazon Web Services account |
| register_organization_admin_account | Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager |
| start_assessment_framework_share | Creates a share request for a custom framework in Audit Manager |
| tag_resource | Tags the specified resource in Audit Manager |
| untag_resource | Removes a tag from a resource in Audit Manager |
| update_assessment | Edits an Audit Manager assessment |
| update_assessment_control | Updates a control within an assessment in Audit Manager |
| update_assessment_control_set_status | Updates the status of a control set in an Audit Manager assessment |
| update_assessment_framework | Updates a custom framework in Audit Manager |
| update_assessment_framework_share | Updates a share request for a custom framework in Audit Manager |
| update_assessment_status | Updates the status of an assessment in Audit Manager |
| update_control | Updates a custom control in Audit Manager |
| update_settings | Updates Audit Manager settings for the current account |
| validate_assessment_report_integrity | Validates the integrity of an assessment report in Audit Manager |
Examples
## Not run:
svc <- auditmanager()
svc$associate_assessment_report_evidence_folder(
Foo = 123
)
## End(Not run)
Associates an evidence folder to an assessment report in an Audit Manager assessment
Description
Associates an evidence folder to an assessment report in an Audit Manager assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_associate_assessment_report_evidence_folder/ for full documentation.
Usage
auditmanager_associate_assessment_report_evidence_folder(
assessmentId,
evidenceFolderId
)
Arguments
assessmentId |
[required] The identifier for the assessment. |
evidenceFolderId |
[required] The identifier for the folder that the evidence is stored in. |
Associates a list of evidence to an assessment report in an Audit Manager assessment
Description
Associates a list of evidence to an assessment report in an Audit Manager assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_batch_associate_assessment_report_evidence/ for full documentation.
Usage
auditmanager_batch_associate_assessment_report_evidence(
assessmentId,
evidenceFolderId,
evidenceIds
)
Arguments
assessmentId |
[required] The identifier for the assessment. |
evidenceFolderId |
[required] The identifier for the folder that the evidence is stored in. |
evidenceIds |
[required] The list of evidence identifiers. |
Creates a batch of delegations for an assessment in Audit Manager
Description
Creates a batch of delegations for an assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_batch_create_delegation_by_assessment/ for full documentation.
Usage
auditmanager_batch_create_delegation_by_assessment(
createDelegationRequests,
assessmentId
)
Arguments
createDelegationRequests |
[required] The API request to batch create delegations in Audit Manager. |
assessmentId |
[required] The identifier for the assessment. |
Deletes a batch of delegations for an assessment in Audit Manager
Description
Deletes a batch of delegations for an assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_batch_delete_delegation_by_assessment/ for full documentation.
Usage
auditmanager_batch_delete_delegation_by_assessment(delegationIds, assessmentId)
Arguments
delegationIds |
[required] The identifiers for the delegations. |
assessmentId |
[required] The identifier for the assessment. |
Disassociates a list of evidence from an assessment report in Audit Manager
Description
Disassociates a list of evidence from an assessment report in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_batch_disassociate_assessment_report_evidence/ for full documentation.
Usage
auditmanager_batch_disassociate_assessment_report_evidence(
assessmentId,
evidenceFolderId,
evidenceIds
)
Arguments
assessmentId |
[required] The identifier for the assessment. |
evidenceFolderId |
[required] The identifier for the folder that the evidence is stored in. |
evidenceIds |
[required] The list of evidence identifiers. |
Adds one or more pieces of evidence to a control in an Audit Manager assessment
Description
Adds one or more pieces of evidence to a control in an Audit Manager assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_batch_import_evidence_to_assessment_control/ for full documentation.
Usage
auditmanager_batch_import_evidence_to_assessment_control(
assessmentId,
controlSetId,
controlId,
manualEvidence
)
Arguments
assessmentId |
[required] The identifier for the assessment. |
controlSetId |
[required] The identifier for the control set. |
controlId |
[required] The identifier for the control. |
manualEvidence |
[required] The list of manual evidence objects. |
Creates an assessment in Audit Manager
Description
Creates an assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_create_assessment/ for full documentation.
Usage
auditmanager_create_assessment(
name,
description = NULL,
assessmentReportsDestination,
scope,
roles,
frameworkId,
tags = NULL
)
Arguments
name |
[required] The name of the assessment to be created. |
description |
The optional description of the assessment to be created. |
assessmentReportsDestination |
[required] The assessment report storage destination for the assessment that's being created. |
scope |
[required] |
roles |
[required] The list of roles for the assessment. |
frameworkId |
[required] The identifier for the framework that the assessment will be created from. |
tags |
The tags that are associated with the assessment. |
Creates a custom framework in Audit Manager
Description
Creates a custom framework in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_create_assessment_framework/ for full documentation.
Usage
auditmanager_create_assessment_framework(
name,
description = NULL,
complianceType = NULL,
controlSets,
tags = NULL
)
Arguments
name |
[required] The name of the new custom framework. |
description |
An optional description for the new custom framework. |
complianceType |
The compliance type that the new custom framework supports, such as CIS or HIPAA. |
controlSets |
[required] The control sets that are associated with the framework. |
tags |
The tags that are associated with the framework. |
Creates an assessment report for the specified assessment
Description
Creates an assessment report for the specified assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_create_assessment_report/ for full documentation.
Usage
auditmanager_create_assessment_report(
name,
description = NULL,
assessmentId,
queryStatement = NULL
)
Arguments
name |
[required] The name of the new assessment report. |
description |
The description of the assessment report. |
assessmentId |
[required] The identifier for the assessment. |
queryStatement |
A SQL statement that represents an evidence finder query. Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API. To use this parameter, the
enablementStatus
of evidence finder must be For examples and help resolving |
Creates a new custom control in Audit Manager
Description
Creates a new custom control in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_create_control/ for full documentation.
Usage
auditmanager_create_control(
name,
description = NULL,
testingInformation = NULL,
actionPlanTitle = NULL,
actionPlanInstructions = NULL,
controlMappingSources,
tags = NULL
)
Arguments
name |
[required] The name of the control. |
description |
The description of the control. |
testingInformation |
The steps to follow to determine if the control is satisfied. |
actionPlanTitle |
The title of the action plan for remediating the control. |
actionPlanInstructions |
The recommended actions to carry out if the control isn't fulfilled. |
controlMappingSources |
[required] The data mapping sources for the control. |
tags |
The tags that are associated with the control. |
Deletes an assessment in Audit Manager
Description
Deletes an assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_delete_assessment/ for full documentation.
Usage
auditmanager_delete_assessment(assessmentId)
Arguments
assessmentId |
[required] The identifier for the assessment. |
Deletes a custom framework in Audit Manager
Description
Deletes a custom framework in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_delete_assessment_framework/ for full documentation.
Usage
auditmanager_delete_assessment_framework(frameworkId)
Arguments
frameworkId |
[required] The identifier for the custom framework. |
Deletes a share request for a custom framework in Audit Manager
Description
Deletes a share request for a custom framework in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_delete_assessment_framework_share/ for full documentation.
Usage
auditmanager_delete_assessment_framework_share(requestId, requestType)
Arguments
requestId |
[required] The unique identifier for the share request to be deleted. |
requestType |
[required] Specifies whether the share request is a sent request or a received request. |
Deletes an assessment report in Audit Manager
Description
Deletes an assessment report in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_delete_assessment_report/ for full documentation.
Usage
auditmanager_delete_assessment_report(assessmentId, assessmentReportId)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
assessmentReportId |
[required] The unique identifier for the assessment report. |
Deletes a custom control in Audit Manager
Description
Deletes a custom control in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_delete_control/ for full documentation.
Usage
auditmanager_delete_control(controlId)
Arguments
controlId |
[required] The unique identifier for the control. |
Deregisters an account in Audit Manager
Description
Deregisters an account in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_deregister_account/ for full documentation.
Usage
auditmanager_deregister_account()
Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager
Description
Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_deregister_organization_admin_account/ for full documentation.
Usage
auditmanager_deregister_organization_admin_account(adminAccountId = NULL)
Arguments
adminAccountId |
The identifier for the administrator account. |
Disassociates an evidence folder from the specified assessment report in Audit Manager
Description
Disassociates an evidence folder from the specified assessment report in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_disassociate_assessment_report_evidence_folder/ for full documentation.
Usage
auditmanager_disassociate_assessment_report_evidence_folder(
assessmentId,
evidenceFolderId
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
evidenceFolderId |
[required] The unique identifier for the folder that the evidence is stored in. |
Gets the registration status of an account in Audit Manager
Description
Gets the registration status of an account in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_get_account_status/ for full documentation.
Usage
auditmanager_get_account_status()
Gets information about a specified assessment
Description
Gets information about a specified assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_get_assessment/ for full documentation.
Usage
auditmanager_get_assessment(assessmentId)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
Gets information about a specified framework
Description
Gets information about a specified framework.
See https://www.paws-r-sdk.com/docs/auditmanager_get_assessment_framework/ for full documentation.
Usage
auditmanager_get_assessment_framework(frameworkId)
Arguments
frameworkId |
[required] The identifier for the framework. |
Gets the URL of an assessment report in Audit Manager
Description
Gets the URL of an assessment report in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_get_assessment_report_url/ for full documentation.
Usage
auditmanager_get_assessment_report_url(assessmentReportId, assessmentId)
Arguments
assessmentReportId |
[required] The unique identifier for the assessment report. |
assessmentId |
[required] The unique identifier for the assessment. |
Gets a list of changelogs from Audit Manager
Description
Gets a list of changelogs from Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_get_change_logs/ for full documentation.
Usage
auditmanager_get_change_logs(
assessmentId,
controlSetId = NULL,
controlId = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
controlSetId |
The unique identifier for the control set. |
controlId |
The unique identifier for the control. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Gets information about a specified control
Description
Gets information about a specified control.
See https://www.paws-r-sdk.com/docs/auditmanager_get_control/ for full documentation.
Usage
auditmanager_get_control(controlId)
Arguments
controlId |
[required] The identifier for the control. |
Gets a list of delegations from an audit owner to a delegate
Description
Gets a list of delegations from an audit owner to a delegate.
See https://www.paws-r-sdk.com/docs/auditmanager_get_delegations/ for full documentation.
Usage
auditmanager_get_delegations(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Gets information about a specified evidence item
Description
Gets information about a specified evidence item.
See https://www.paws-r-sdk.com/docs/auditmanager_get_evidence/ for full documentation.
Usage
auditmanager_get_evidence(
assessmentId,
controlSetId,
evidenceFolderId,
evidenceId
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
controlSetId |
[required] The unique identifier for the control set. |
evidenceFolderId |
[required] The unique identifier for the folder that the evidence is stored in. |
evidenceId |
[required] The unique identifier for the evidence. |
Gets all evidence from a specified evidence folder in Audit Manager
Description
Gets all evidence from a specified evidence folder in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_get_evidence_by_evidence_folder/ for full documentation.
Usage
auditmanager_get_evidence_by_evidence_folder(
assessmentId,
controlSetId,
evidenceFolderId,
nextToken = NULL,
maxResults = NULL
)
Arguments
assessmentId |
[required] The identifier for the assessment. |
controlSetId |
[required] The identifier for the control set. |
evidenceFolderId |
[required] The unique identifier for the folder that the evidence is stored in. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence
Description
Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide.
See https://www.paws-r-sdk.com/docs/auditmanager_get_evidence_file_upload_url/ for full documentation.
Usage
auditmanager_get_evidence_file_upload_url(fileName)
Arguments
fileName |
[required] The file that you want to upload. For a list of supported file formats, see Supported file types for manual evidence in the Audit Manager User Guide. |
Gets an evidence folder from a specified assessment in Audit Manager
Description
Gets an evidence folder from a specified assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_get_evidence_folder/ for full documentation.
Usage
auditmanager_get_evidence_folder(assessmentId, controlSetId, evidenceFolderId)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
controlSetId |
[required] The unique identifier for the control set. |
evidenceFolderId |
[required] The unique identifier for the folder that the evidence is stored in. |
Gets the evidence folders from a specified assessment in Audit Manager
Description
Gets the evidence folders from a specified assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_get_evidence_folders_by_assessment/ for full documentation.
Usage
auditmanager_get_evidence_folders_by_assessment(
assessmentId,
nextToken = NULL,
maxResults = NULL
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment
Description
Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_get_evidence_folders_by_assessment_control/ for full documentation.
Usage
auditmanager_get_evidence_folders_by_assessment_control(
assessmentId,
controlSetId,
controlId,
nextToken = NULL,
maxResults = NULL
)
Arguments
assessmentId |
[required] The identifier for the assessment. |
controlSetId |
[required] The identifier for the control set. |
controlId |
[required] The identifier for the control. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Gets the latest analytics data for all your current active assessments
Description
Gets the latest analytics data for all your current active assessments.
See https://www.paws-r-sdk.com/docs/auditmanager_get_insights/ for full documentation.
Usage
auditmanager_get_insights()
Gets the latest analytics data for a specific active assessment
Description
Gets the latest analytics data for a specific active assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_get_insights_by_assessment/ for full documentation.
Usage
auditmanager_get_insights_by_assessment(assessmentId)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
Gets the name of the delegated Amazon Web Services administrator account for a specified organization
Description
Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
See https://www.paws-r-sdk.com/docs/auditmanager_get_organization_admin_account/ for full documentation.
Usage
auditmanager_get_organization_admin_account()
Gets a list of the Amazon Web Services from which Audit Manager can collect evidence
Description
Gets a list of the Amazon Web Services from which Audit Manager can collect evidence.
See https://www.paws-r-sdk.com/docs/auditmanager_get_services_in_scope/ for full documentation.
Usage
auditmanager_get_services_in_scope()
Gets the settings for a specified Amazon Web Services account
Description
Gets the settings for a specified Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/auditmanager_get_settings/ for full documentation.
Usage
auditmanager_get_settings(attribute)
Arguments
attribute |
[required] The list of setting attribute enum values. |
Lists the latest analytics data for controls within a specific control domain and a specific active assessment
Description
Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_list_assessment_control_insights_by_control_domain/ for full documentation.
Usage
auditmanager_list_assessment_control_insights_by_control_domain(
controlDomainId,
assessmentId,
nextToken = NULL,
maxResults = NULL
)
Arguments
controlDomainId |
[required] The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon
Web Services Control Catalog. For information about how to find a list
of available control domains, see
|
assessmentId |
[required] The unique identifier for the active assessment. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of sent or received share requests for custom frameworks in Audit Manager
Description
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_list_assessment_framework_share_requests/ for full documentation.
Usage
auditmanager_list_assessment_framework_share_requests(
requestType,
nextToken = NULL,
maxResults = NULL
)
Arguments
requestType |
[required] Specifies whether the share request is a sent request or a received request. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of the frameworks that are available in the Audit Manager framework library
Description
Returns a list of the frameworks that are available in the Audit Manager framework library.
See https://www.paws-r-sdk.com/docs/auditmanager_list_assessment_frameworks/ for full documentation.
Usage
auditmanager_list_assessment_frameworks(
frameworkType,
nextToken = NULL,
maxResults = NULL
)
Arguments
frameworkType |
[required] The type of framework, such as a standard framework or a custom framework. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of assessment reports created in Audit Manager
Description
Returns a list of assessment reports created in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_list_assessment_reports/ for full documentation.
Usage
auditmanager_list_assessment_reports(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of current and past assessments from Audit Manager
Description
Returns a list of current and past assessments from Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_list_assessments/ for full documentation.
Usage
auditmanager_list_assessments(
status = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
status |
The current status of the assessment. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Lists the latest analytics data for control domains across all of your active assessments
Description
Lists the latest analytics data for control domains across all of your active assessments.
See https://www.paws-r-sdk.com/docs/auditmanager_list_control_domain_insights/ for full documentation.
Usage
auditmanager_list_control_domain_insights(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Lists analytics data for control domains within a specified active assessment
Description
Lists analytics data for control domains within a specified active assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_list_control_domain_insights_by_assessment/ for full documentation.
Usage
auditmanager_list_control_domain_insights_by_assessment(
assessmentId,
nextToken = NULL,
maxResults = NULL
)
Arguments
assessmentId |
[required] The unique identifier for the active assessment. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Lists the latest analytics data for controls within a specific control domain across all active assessments
Description
Lists the latest analytics data for controls within a specific control domain across all active assessments.
See https://www.paws-r-sdk.com/docs/auditmanager_list_control_insights_by_control_domain/ for full documentation.
Usage
auditmanager_list_control_insights_by_control_domain(
controlDomainId,
nextToken = NULL,
maxResults = NULL
)
Arguments
controlDomainId |
[required] The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon
Web Services Control Catalog. For information about how to find a list
of available control domains, see
|
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of controls from Audit Manager
Description
Returns a list of controls from Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_list_controls/ for full documentation.
Usage
auditmanager_list_controls(
controlType,
nextToken = NULL,
maxResults = NULL,
controlCatalogId = NULL
)
Arguments
controlType |
[required] A filter that narrows the list of controls to a specific type. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
The maximum number of results on a page or for an API request call. |
controlCatalogId |
A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog. To use this parameter, specify the ARN of the Control Catalog resource.
You can specify either a control domain, a control objective, or a
common control. For information about how to find the ARNs for these
resources, see
You can only filter by one Control Catalog resource at a time.
Specifying multiple resource ARNs isn’t currently supported. If you want
to filter by more than one ARN, we recommend that you run the
Alternatively, specify |
Returns a list of keywords that are pre-mapped to the specified control data source
Description
Returns a list of keywords that are pre-mapped to the specified control data source.
See https://www.paws-r-sdk.com/docs/auditmanager_list_keywords_for_data_source/ for full documentation.
Usage
auditmanager_list_keywords_for_data_source(
source,
nextToken = NULL,
maxResults = NULL
)
Arguments
source |
[required] The control mapping data source that the keywords apply to. |
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of all Audit Manager notifications
Description
Returns a list of all Audit Manager notifications.
See https://www.paws-r-sdk.com/docs/auditmanager_list_notifications/ for full documentation.
Usage
auditmanager_list_notifications(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
The pagination token that's used to fetch the next set of results. |
maxResults |
Represents the maximum number of results on a page or for an API request call. |
Returns a list of tags for the specified resource in Audit Manager
Description
Returns a list of tags for the specified resource in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_list_tags_for_resource/ for full documentation.
Usage
auditmanager_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Enables Audit Manager for the specified Amazon Web Services account
Description
Enables Audit Manager for the specified Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/auditmanager_register_account/ for full documentation.
Usage
auditmanager_register_account(kmsKey = NULL, delegatedAdminAccount = NULL)
Arguments
kmsKey |
The KMS key details. |
delegatedAdminAccount |
The delegated administrator account for Audit Manager. |
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager
Description
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_register_organization_admin_account/ for full documentation.
Usage
auditmanager_register_organization_admin_account(adminAccountId)
Arguments
adminAccountId |
[required] The identifier for the delegated administrator account. |
Creates a share request for a custom framework in Audit Manager
Description
Creates a share request for a custom framework in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_start_assessment_framework_share/ for full documentation.
Usage
auditmanager_start_assessment_framework_share(
frameworkId,
destinationAccount,
destinationRegion,
comment = NULL
)
Arguments
frameworkId |
[required] The unique identifier for the custom framework to be shared. |
destinationAccount |
[required] The Amazon Web Services account of the recipient. |
destinationRegion |
[required] The Amazon Web Services Region of the recipient. |
comment |
An optional comment from the sender about the share request. |
Tags the specified resource in Audit Manager
Description
Tags the specified resource in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_tag_resource/ for full documentation.
Usage
auditmanager_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tags |
[required] The tags that are associated with the resource. |
Removes a tag from a resource in Audit Manager
Description
Removes a tag from a resource in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_untag_resource/ for full documentation.
Usage
auditmanager_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the specified resource. |
tagKeys |
[required] The name or key of the tag. |
Edits an Audit Manager assessment
Description
Edits an Audit Manager assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_update_assessment/ for full documentation.
Usage
auditmanager_update_assessment(
assessmentId,
assessmentName = NULL,
assessmentDescription = NULL,
scope,
assessmentReportsDestination = NULL,
roles = NULL
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
assessmentName |
The name of the assessment to be updated. |
assessmentDescription |
The description of the assessment. |
scope |
[required] The scope of the assessment. |
assessmentReportsDestination |
The assessment report storage destination for the assessment that's being updated. |
roles |
The list of roles for the assessment. |
Updates a control within an assessment in Audit Manager
Description
Updates a control within an assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_update_assessment_control/ for full documentation.
Usage
auditmanager_update_assessment_control(
assessmentId,
controlSetId,
controlId,
controlStatus = NULL,
commentBody = NULL
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
controlSetId |
[required] The unique identifier for the control set. |
controlId |
[required] The unique identifier for the control. |
controlStatus |
The status of the control. |
commentBody |
The comment body text for the control. |
Updates the status of a control set in an Audit Manager assessment
Description
Updates the status of a control set in an Audit Manager assessment.
See https://www.paws-r-sdk.com/docs/auditmanager_update_assessment_control_set_status/ for full documentation.
Usage
auditmanager_update_assessment_control_set_status(
assessmentId,
controlSetId,
status,
comment
)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
controlSetId |
[required] The unique identifier for the control set. |
status |
[required] The status of the control set that's being updated. |
comment |
[required] The comment that's related to the status update. |
Updates a custom framework in Audit Manager
Description
Updates a custom framework in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_update_assessment_framework/ for full documentation.
Usage
auditmanager_update_assessment_framework(
frameworkId,
name,
description = NULL,
complianceType = NULL,
controlSets
)
Arguments
frameworkId |
[required] The unique identifier for the framework. |
name |
[required] The name of the framework to be updated. |
description |
The description of the updated framework. |
complianceType |
The compliance type that the new custom framework supports, such as CIS or HIPAA. |
controlSets |
[required] The control sets that are associated with the framework. |
Updates a share request for a custom framework in Audit Manager
Description
Updates a share request for a custom framework in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_update_assessment_framework_share/ for full documentation.
Usage
auditmanager_update_assessment_framework_share(requestId, requestType, action)
Arguments
requestId |
[required] The unique identifier for the share request. |
requestType |
[required] Specifies whether the share request is a sent request or a received request. |
action |
[required] Specifies the update action for the share request. |
Updates the status of an assessment in Audit Manager
Description
Updates the status of an assessment in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_update_assessment_status/ for full documentation.
Usage
auditmanager_update_assessment_status(assessmentId, status)
Arguments
assessmentId |
[required] The unique identifier for the assessment. |
status |
[required] The current status of the assessment. |
Updates a custom control in Audit Manager
Description
Updates a custom control in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_update_control/ for full documentation.
Usage
auditmanager_update_control(
controlId,
name,
description = NULL,
testingInformation = NULL,
actionPlanTitle = NULL,
actionPlanInstructions = NULL,
controlMappingSources
)
Arguments
controlId |
[required] The identifier for the control. |
name |
[required] The name of the updated control. |
description |
The optional description of the control. |
testingInformation |
The steps that you should follow to determine if the control is met. |
actionPlanTitle |
The title of the action plan for remediating the control. |
actionPlanInstructions |
The recommended actions to carry out if the control isn't fulfilled. |
controlMappingSources |
[required] The data mapping sources for the control. |
Updates Audit Manager settings for the current account
Description
Updates Audit Manager settings for the current account.
See https://www.paws-r-sdk.com/docs/auditmanager_update_settings/ for full documentation.
Usage
auditmanager_update_settings(
snsTopic = NULL,
defaultAssessmentReportsDestination = NULL,
defaultProcessOwners = NULL,
kmsKey = NULL,
evidenceFinderEnabled = NULL,
deregistrationPolicy = NULL,
defaultExportDestination = NULL
)
Arguments
snsTopic |
The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to. |
defaultAssessmentReportsDestination |
The default S3 destination bucket for storing assessment reports. |
defaultProcessOwners |
A list of the default audit owners. |
kmsKey |
The KMS key details. |
evidenceFinderEnabled |
Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder. When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager. |
deregistrationPolicy |
The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager. |
defaultExportDestination |
The default S3 destination bucket for storing evidence finder exports. |
Validates the integrity of an assessment report in Audit Manager
Description
Validates the integrity of an assessment report in Audit Manager.
See https://www.paws-r-sdk.com/docs/auditmanager_validate_assessment_report_integrity/ for full documentation.
Usage
auditmanager_validate_assessment_report_integrity(s3RelativePath)
Arguments
s3RelativePath |
[required] The relative path of the Amazon S3 bucket that the assessment report is stored in. |
Auto Scaling
Description
Amazon EC2 Auto Scaling
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
Usage
autoscaling(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- autoscaling(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| attach_instances | Attaches one or more EC2 instances to the specified Auto Scaling group |
| attach_load_balancers | This API operation is superseded by https://docs |
| attach_load_balancer_target_groups | This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types |
| attach_traffic_sources | Attaches one or more traffic sources to the specified Auto Scaling group |
| batch_delete_scheduled_action | Deletes one or more scheduled actions for the specified Auto Scaling group |
| batch_put_scheduled_update_group_action | Creates or updates one or more scheduled scaling actions for an Auto Scaling group |
| cancel_instance_refresh | Cancels an instance refresh or rollback that is in progress |
| complete_lifecycle_action | Completes the lifecycle action for the specified token or instance with the specified result |
| create_auto_scaling_group | We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2 |
| create_launch_configuration | Creates a launch configuration |
| create_or_update_tags | Creates or updates tags for the specified Auto Scaling group |
| delete_auto_scaling_group | Deletes the specified Auto Scaling group |
| delete_launch_configuration | Deletes the specified launch configuration |
| delete_lifecycle_hook | Deletes the specified lifecycle hook |
| delete_notification_configuration | Deletes the specified notification |
| delete_policy | Deletes the specified scaling policy |
| delete_scheduled_action | Deletes the specified scheduled action |
| delete_tags | Deletes the specified tags |
| delete_warm_pool | Deletes the warm pool for the specified Auto Scaling group |
| describe_account_limits | Describes the current Amazon EC2 Auto Scaling resource quotas for your account |
| describe_adjustment_types | Describes the available adjustment types for step scaling and simple scaling policies |
| describe_auto_scaling_groups | Gets information about the Auto Scaling groups in the account and Region |
| describe_auto_scaling_instances | Gets information about the Auto Scaling instances in the account and Region |
| describe_auto_scaling_notification_types | Describes the notification types that are supported by Amazon EC2 Auto Scaling |
| describe_instance_refreshes | Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks |
| describe_launch_configurations | Gets information about the launch configurations in the account and Region |
| describe_lifecycle_hooks | Gets information about the lifecycle hooks for the specified Auto Scaling group |
| describe_lifecycle_hook_types | Describes the available types of lifecycle hooks |
| describe_load_balancers | This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types |
| describe_load_balancer_target_groups | This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types |
| describe_metric_collection_types | Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling |
| describe_notification_configurations | Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups |
| describe_policies | Gets information about the scaling policies in the account and Region |
| describe_scaling_activities | Gets information about the scaling activities in the account and Region |
| describe_scaling_process_types | Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs |
| describe_scheduled_actions | Gets information about the scheduled actions that haven't run or that have not reached their end time |
| describe_tags | Describes the specified tags |
| describe_termination_policy_types | Describes the termination policies supported by Amazon EC2 Auto Scaling |
| describe_traffic_sources | Gets information about the traffic sources for the specified Auto Scaling group |
| describe_warm_pool | Gets information about a warm pool and its instances |
| detach_instances | Removes one or more instances from the specified Auto Scaling group |
| detach_load_balancers | This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types |
| detach_load_balancer_target_groups | This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types |
| detach_traffic_sources | Detaches one or more traffic sources from the specified Auto Scaling group |
| disable_metrics_collection | Disables group metrics collection for the specified Auto Scaling group |
| enable_metrics_collection | Enables group metrics collection for the specified Auto Scaling group |
| enter_standby | Moves the specified instances into the standby state |
| execute_policy | Executes the specified policy |
| exit_standby | Moves the specified instances out of the standby state |
| get_predictive_scaling_forecast | Retrieves the forecast data for a predictive scaling policy |
| put_lifecycle_hook | Creates or updates a lifecycle hook for the specified Auto Scaling group |
| put_notification_configuration | Configures an Auto Scaling group to send notifications when specified events take place |
| put_scaling_policy | Creates or updates a scaling policy for an Auto Scaling group |
| put_scheduled_update_group_action | Creates or updates a scheduled scaling action for an Auto Scaling group |
| put_warm_pool | Creates or updates a warm pool for the specified Auto Scaling group |
| record_lifecycle_action_heartbeat | Records a heartbeat for the lifecycle action associated with the specified token or instance |
| resume_processes | Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group |
| rollback_instance_refresh | Cancels an instance refresh that is in progress and rolls back any changes that it made |
| set_desired_capacity | Sets the size of the specified Auto Scaling group |
| set_instance_health | Sets the health status of the specified instance |
| set_instance_protection | Updates the instance protection settings of the specified instances |
| start_instance_refresh | Starts an instance refresh |
| suspend_processes | Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group |
| terminate_instance_in_auto_scaling_group | Terminates the specified instance and optionally adjusts the desired group size |
| update_auto_scaling_group | We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2 |
Examples
## Not run:
svc <- autoscaling()
# This example attaches the specified instance to the specified Auto
# Scaling group.
svc$attach_instances(
AutoScalingGroupName = "my-auto-scaling-group",
InstanceIds = list(
"i-93633f9b"
)
)
## End(Not run)
Attaches one or more EC2 instances to the specified Auto Scaling group
Description
Attaches one or more EC2 instances to the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_attach_instances/ for full documentation.
Usage
autoscaling_attach_instances(InstanceIds = NULL, AutoScalingGroupName)
Arguments
InstanceIds |
The IDs of the instances. You can specify up to 20 instances. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types
Description
This API operation is superseded by attach_traffic_sources, which can attach multiple traffic sources types. We recommend using attach_traffic_sources to simplify how you manage traffic sources. However, we continue to support attach_load_balancer_target_groups. You can use both the original attach_load_balancer_target_groups API operation and attach_traffic_sources on the same Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_attach_load_balancer_target_groups/ for full documentation.
Usage
autoscaling_attach_load_balancer_target_groups(
AutoScalingGroupName,
TargetGroupARNs
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TargetGroupARNs |
[required] The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation. |
This API operation is superseded by https://docs
Description
This API operation is superseded by https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_AttachTrafficSources.html, which can attach multiple traffic sources types. We recommend using attach_traffic_sources to simplify how you manage traffic sources. However, we continue to support attach_load_balancers. You can use both the original attach_load_balancers API operation and attach_traffic_sources on the same Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_attach_load_balancers/ for full documentation.
Usage
autoscaling_attach_load_balancers(AutoScalingGroupName, LoadBalancerNames)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LoadBalancerNames |
[required] The names of the load balancers. You can specify up to 10 load balancers. |
Attaches one or more traffic sources to the specified Auto Scaling group
Description
Attaches one or more traffic sources to the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_attach_traffic_sources/ for full documentation.
Usage
autoscaling_attach_traffic_sources(
AutoScalingGroupName,
TrafficSources,
SkipZonalShiftValidation = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TrafficSources |
[required] The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources. |
SkipZonalShiftValidation |
If you enable zonal shift with cross-zone disabled load balancers,
capacity could become imbalanced across Availability Zones. To skip the
validation, specify |
Deletes one or more scheduled actions for the specified Auto Scaling group
Description
Deletes one or more scheduled actions for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_batch_delete_scheduled_action/ for full documentation.
Usage
autoscaling_batch_delete_scheduled_action(
AutoScalingGroupName,
ScheduledActionNames
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ScheduledActionNames |
[required] The names of the scheduled actions to delete. The maximum number allowed is 50. |
Creates or updates one or more scheduled scaling actions for an Auto Scaling group
Description
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_batch_put_scheduled_update_group_action/ for full documentation.
Usage
autoscaling_batch_put_scheduled_update_group_action(
AutoScalingGroupName,
ScheduledUpdateGroupActions
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ScheduledUpdateGroupActions |
[required] One or more scheduled actions. The maximum number allowed is 50. |
Cancels an instance refresh or rollback that is in progress
Description
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.
See https://www.paws-r-sdk.com/docs/autoscaling_cancel_instance_refresh/ for full documentation.
Usage
autoscaling_cancel_instance_refresh(AutoScalingGroupName)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Completes the lifecycle action for the specified token or instance with the specified result
Description
Completes the lifecycle action for the specified token or instance with the specified result.
See https://www.paws-r-sdk.com/docs/autoscaling_complete_lifecycle_action/ for full documentation.
Usage
autoscaling_complete_lifecycle_action(
LifecycleHookName,
AutoScalingGroupName,
LifecycleActionToken = NULL,
LifecycleActionResult,
InstanceId = NULL
)
Arguments
LifecycleHookName |
[required] The name of the lifecycle hook. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LifecycleActionToken |
A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook. |
LifecycleActionResult |
[required] The action for the group to take. You can specify either |
InstanceId |
The ID of the instance. |
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2
Description
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
See https://www.paws-r-sdk.com/docs/autoscaling_create_auto_scaling_group/ for full documentation.
Usage
autoscaling_create_auto_scaling_group(
AutoScalingGroupName,
LaunchConfigurationName = NULL,
LaunchTemplate = NULL,
MixedInstancesPolicy = NULL,
InstanceId = NULL,
MinSize,
MaxSize,
DesiredCapacity = NULL,
DefaultCooldown = NULL,
AvailabilityZones = NULL,
LoadBalancerNames = NULL,
TargetGroupARNs = NULL,
HealthCheckType = NULL,
HealthCheckGracePeriod = NULL,
PlacementGroup = NULL,
VPCZoneIdentifier = NULL,
TerminationPolicies = NULL,
NewInstancesProtectedFromScaleIn = NULL,
CapacityRebalance = NULL,
LifecycleHookSpecificationList = NULL,
Tags = NULL,
ServiceLinkedRoleARN = NULL,
MaxInstanceLifetime = NULL,
Context = NULL,
DesiredCapacityType = NULL,
DefaultInstanceWarmup = NULL,
TrafficSources = NULL,
InstanceMaintenancePolicy = NULL,
AvailabilityZoneDistribution = NULL,
AvailabilityZoneImpairmentPolicy = NULL,
SkipZonalShiftValidation = NULL,
CapacityReservationSpecification = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name. |
LaunchConfigurationName |
The name of the launch configuration to use to launch instances. Conditional: You must specify either a launch template ( |
LaunchTemplate |
Information used to specify the launch template and version to use to launch instances. Conditional: You must specify either a launch template ( The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. |
MixedInstancesPolicy |
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide. |
InstanceId |
The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the Amazon EC2 Auto Scaling User Guide. |
MinSize |
[required] The minimum size of the group. |
MaxSize |
[required] The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2
Auto Scaling may need to go above |
DesiredCapacity |
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group. |
DefaultCooldown |
Only needed if you use simple scaling policies. The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Default: |
AvailabilityZones |
A list of Availability Zones where instances in the Auto Scaling group
can be created. Used for launching into the default VPC subnet in each
Availability Zone when not using the |
LoadBalancerNames |
A list of Classic Load Balancers associated with this Auto Scaling
group. For Application Load Balancers, Network Load Balancers, and
Gateway Load Balancers, specify the |
TargetGroupARNs |
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. |
HealthCheckType |
A comma-separated value string of one or more health check types. The valid values are Only specify |
HealthCheckGracePeriod |
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
before checking the health status of an EC2 instance that has come into
service and marking it unhealthy due to a failed health check. This is
useful if your instances do not immediately pass their health checks
after they enter the Default: |
PlacementGroup |
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances. A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group. |
VPCZoneIdentifier |
A comma-separated list of subnet IDs for a virtual private cloud (VPC)
where instances in the Auto Scaling group can be created. If you specify
|
TerminationPolicies |
A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Valid values: |
NewInstancesProtectedFromScaleIn |
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide. |
CapacityRebalance |
Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide. |
LifecycleHookSpecificationList |
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. |
Tags |
One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide. |
ServiceLinkedRoleARN |
The Amazon Resource Name (ARN) of the service-linked role that the Auto
Scaling group uses to call other Amazon Web Services service on your
behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role
named |
MaxInstanceLifetime |
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide. |
Context |
Reserved. |
DesiredCapacityType |
The unit of measurement for the value specified for desired capacity.
Amazon EC2 Auto Scaling supports By default, Amazon EC2 Auto Scaling specifies Valid values: |
DefaultInstanceWarmup |
The amount of time, in seconds, until a new instance is considered to
have finished initializing and resource consumption to become stable
after it enters the During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. To manage various warm-up settings at the group level, we recommend that
you set the default instance warmup, even if it is set to 0 seconds.
To remove a value that you previously set, include the property but
specify Default: None |
TrafficSources |
The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice. |
InstanceMaintenancePolicy |
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide. |
AvailabilityZoneDistribution |
The instance capacity distribution across Availability Zones. |
AvailabilityZoneImpairmentPolicy |
The policy for Availability Zone impairment. |
SkipZonalShiftValidation |
If you enable zonal shift with cross-zone disabled load balancers,
capacity could become imbalanced across Availability Zones. To skip the
validation, specify |
CapacityReservationSpecification |
The capacity reservation specification for the Auto Scaling group. |
Creates a launch configuration
Description
Creates a launch configuration.
See https://www.paws-r-sdk.com/docs/autoscaling_create_launch_configuration/ for full documentation.
Usage
autoscaling_create_launch_configuration(
LaunchConfigurationName,
ImageId = NULL,
KeyName = NULL,
SecurityGroups = NULL,
ClassicLinkVPCId = NULL,
ClassicLinkVPCSecurityGroups = NULL,
UserData = NULL,
InstanceId = NULL,
InstanceType = NULL,
KernelId = NULL,
RamdiskId = NULL,
BlockDeviceMappings = NULL,
InstanceMonitoring = NULL,
SpotPrice = NULL,
IamInstanceProfile = NULL,
EbsOptimized = NULL,
AssociatePublicIpAddress = NULL,
PlacementTenancy = NULL,
MetadataOptions = NULL
)
Arguments
LaunchConfigurationName |
[required] The name of the launch configuration. This name must be unique per Region per account. |
ImageId |
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances. If you specify |
KeyName |
The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide for Linux Instances. |
SecurityGroups |
A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide. |
ClassicLinkVPCId |
Available for backward compatibility. |
ClassicLinkVPCSecurityGroups |
Available for backward compatibility. |
UserData |
The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB. |
InstanceId |
The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping. To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request. For more information, see Create a launch configuration in the Amazon EC2 Auto Scaling User Guide. |
InstanceType |
Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances. If you specify |
KernelId |
The ID of the kernel associated with the AMI. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances. |
RamdiskId |
The ID of the RAM disk to select. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances. |
BlockDeviceMappings |
The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances. |
InstanceMonitoring |
Controls whether instances in this group are launched with detailed
( The default value is When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure monitoring for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. |
SpotPrice |
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 0.001 When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price. |
IamInstanceProfile |
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide. |
EbsOptimized |
Specifies whether the launch configuration is optimized for EBS I/O
( The default value is |
AssociatePublicIpAddress |
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. If you specify If you specify this property, you must specify at least one subnet for
|
PlacementTenancy |
The tenancy of the instance, either If you specify Valid values: |
MetadataOptions |
The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide. |
Creates or updates tags for the specified Auto Scaling group
Description
Creates or updates tags for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_create_or_update_tags/ for full documentation.
Usage
autoscaling_create_or_update_tags(Tags)
Arguments
Tags |
[required] One or more tags. |
Deletes the specified Auto Scaling group
Description
Deletes the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_auto_scaling_group/ for full documentation.
Usage
autoscaling_delete_auto_scaling_group(AutoScalingGroupName, ForceDelete = NULL)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ForceDelete |
Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This action also deletes any outstanding lifecycle actions associated with the group. |
Deletes the specified launch configuration
Description
Deletes the specified launch configuration.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_launch_configuration/ for full documentation.
Usage
autoscaling_delete_launch_configuration(LaunchConfigurationName)
Arguments
LaunchConfigurationName |
[required] The name of the launch configuration. |
Deletes the specified lifecycle hook
Description
Deletes the specified lifecycle hook.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_lifecycle_hook/ for full documentation.
Usage
autoscaling_delete_lifecycle_hook(LifecycleHookName, AutoScalingGroupName)
Arguments
LifecycleHookName |
[required] The name of the lifecycle hook. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Deletes the specified notification
Description
Deletes the specified notification.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_notification_configuration/ for full documentation.
Usage
autoscaling_delete_notification_configuration(AutoScalingGroupName, TopicARN)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TopicARN |
[required] The Amazon Resource Name (ARN) of the Amazon SNS topic. |
Deletes the specified scaling policy
Description
Deletes the specified scaling policy.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_policy/ for full documentation.
Usage
autoscaling_delete_policy(AutoScalingGroupName = NULL, PolicyName)
Arguments
AutoScalingGroupName |
The name of the Auto Scaling group. |
PolicyName |
[required] The name or Amazon Resource Name (ARN) of the policy. |
Deletes the specified scheduled action
Description
Deletes the specified scheduled action.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_scheduled_action/ for full documentation.
Usage
autoscaling_delete_scheduled_action(AutoScalingGroupName, ScheduledActionName)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ScheduledActionName |
[required] The name of the action to delete. |
Deletes the specified tags
Description
Deletes the specified tags.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_tags/ for full documentation.
Usage
autoscaling_delete_tags(Tags)
Arguments
Tags |
[required] One or more tags. |
Deletes the warm pool for the specified Auto Scaling group
Description
Deletes the warm pool for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_delete_warm_pool/ for full documentation.
Usage
autoscaling_delete_warm_pool(AutoScalingGroupName, ForceDelete = NULL)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ForceDelete |
Specifies that the warm pool is to be deleted along with all of its associated instances, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the warm pool instances. |
Describes the current Amazon EC2 Auto Scaling resource quotas for your account
Description
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_account_limits/ for full documentation.
Usage
autoscaling_describe_account_limits()
Describes the available adjustment types for step scaling and simple scaling policies
Description
Describes the available adjustment types for step scaling and simple scaling policies.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_adjustment_types/ for full documentation.
Usage
autoscaling_describe_adjustment_types()
Gets information about the Auto Scaling groups in the account and Region
Description
Gets information about the Auto Scaling groups in the account and Region.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_auto_scaling_groups/ for full documentation.
Usage
autoscaling_describe_auto_scaling_groups(
AutoScalingGroupNames = NULL,
NextToken = NULL,
MaxRecords = NULL,
Filters = NULL
)
Arguments
AutoScalingGroupNames |
The names of the Auto Scaling groups. By default, you can only specify
up to 50 names. You can optionally increase this limit using the
If you omit this property, all Auto Scaling groups are described. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Filters |
One or more filters to limit the results based on specific tags. |
Gets information about the Auto Scaling instances in the account and Region
Description
Gets information about the Auto Scaling instances in the account and Region.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_auto_scaling_instances/ for full documentation.
Usage
autoscaling_describe_auto_scaling_instances(
InstanceIds = NULL,
MaxRecords = NULL,
NextToken = NULL
)
Arguments
InstanceIds |
The IDs of the instances. If you omit this property, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error. Array Members: Maximum number of 50 items. |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Describes the notification types that are supported by Amazon EC2 Auto Scaling
Description
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_auto_scaling_notification_types/ for full documentation.
Usage
autoscaling_describe_auto_scaling_notification_types()
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks
Description
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_instance_refreshes/ for full documentation.
Usage
autoscaling_describe_instance_refreshes(
AutoScalingGroupName,
InstanceRefreshIds = NULL,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
InstanceRefreshIds |
One or more instance refresh IDs. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Gets information about the launch configurations in the account and Region
Description
Gets information about the launch configurations in the account and Region.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_launch_configurations/ for full documentation.
Usage
autoscaling_describe_launch_configurations(
LaunchConfigurationNames = NULL,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
LaunchConfigurationNames |
The launch configuration names. If you omit this property, all launch configurations are described. Array Members: Maximum number of 50 items. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Describes the available types of lifecycle hooks
Description
Describes the available types of lifecycle hooks.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_lifecycle_hook_types/ for full documentation.
Usage
autoscaling_describe_lifecycle_hook_types()
Gets information about the lifecycle hooks for the specified Auto Scaling group
Description
Gets information about the lifecycle hooks for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_lifecycle_hooks/ for full documentation.
Usage
autoscaling_describe_lifecycle_hooks(
AutoScalingGroupName,
LifecycleHookNames = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LifecycleHookNames |
The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described. |
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types
Description
This API operation is superseded by describe_traffic_sources, which can describe multiple traffic sources types. We recommend using detach_traffic_sources to simplify how you manage traffic sources. However, we continue to support describe_load_balancer_target_groups. You can use both the original describe_load_balancer_target_groups API operation and describe_traffic_sources on the same Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_load_balancer_target_groups/ for full documentation.
Usage
autoscaling_describe_load_balancer_target_groups(
AutoScalingGroupName,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types
Description
This API operation is superseded by describe_traffic_sources, which can describe multiple traffic sources types. We recommend using describe_traffic_sources to simplify how you manage traffic sources. However, we continue to support describe_load_balancers. You can use both the original describe_load_balancers API operation and describe_traffic_sources on the same Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_load_balancers/ for full documentation.
Usage
autoscaling_describe_load_balancers(
AutoScalingGroupName,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling
Description
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_metric_collection_types/ for full documentation.
Usage
autoscaling_describe_metric_collection_types()
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups
Description
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_notification_configurations/ for full documentation.
Usage
autoscaling_describe_notification_configurations(
AutoScalingGroupNames = NULL,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupNames |
The name of the Auto Scaling group. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Gets information about the scaling policies in the account and Region
Description
Gets information about the scaling policies in the account and Region.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_policies/ for full documentation.
Usage
autoscaling_describe_policies(
AutoScalingGroupName = NULL,
PolicyNames = NULL,
PolicyTypes = NULL,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupName |
The name of the Auto Scaling group. |
PolicyNames |
The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error. Array Members: Maximum number of 50 items. |
PolicyTypes |
One or more policy types. The valid values are |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to be returned with each call. The default
value is |
Gets information about the scaling activities in the account and Region
Description
Gets information about the scaling activities in the account and Region.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_scaling_activities/ for full documentation.
Usage
autoscaling_describe_scaling_activities(
ActivityIds = NULL,
AutoScalingGroupName = NULL,
IncludeDeletedGroups = NULL,
MaxRecords = NULL,
NextToken = NULL
)
Arguments
ActivityIds |
The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group. Array Members: Maximum number of 50 IDs. |
AutoScalingGroupName |
The name of the Auto Scaling group. |
IncludeDeletedGroups |
Indicates whether to include scaling activity from deleted Auto Scaling groups. |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs
Description
Describes the scaling process types for use with the resume_processes and suspend_processes APIs.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_scaling_process_types/ for full documentation.
Usage
autoscaling_describe_scaling_process_types()
Gets information about the scheduled actions that haven't run or that have not reached their end time
Description
Gets information about the scheduled actions that haven't run or that have not reached their end time.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_scheduled_actions/ for full documentation.
Usage
autoscaling_describe_scheduled_actions(
AutoScalingGroupName = NULL,
ScheduledActionNames = NULL,
StartTime = NULL,
EndTime = NULL,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupName |
The name of the Auto Scaling group. |
ScheduledActionNames |
The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error. Array Members: Maximum number of 50 actions. |
StartTime |
The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored. |
EndTime |
The latest scheduled start time to return. If scheduled action names are provided, this property is ignored. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Describes the specified tags
Description
Describes the specified tags.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_tags/ for full documentation.
Usage
autoscaling_describe_tags(Filters = NULL, NextToken = NULL, MaxRecords = NULL)
Arguments
Filters |
One or more filters to scope the tags to return. The maximum number of
filters per filter type (for example, |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The default value
is |
Describes the termination policies supported by Amazon EC2 Auto Scaling
Description
Describes the termination policies supported by Amazon EC2 Auto Scaling.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_termination_policy_types/ for full documentation.
Usage
autoscaling_describe_termination_policy_types()
Gets information about the traffic sources for the specified Auto Scaling group
Description
Gets information about the traffic sources for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_traffic_sources/ for full documentation.
Usage
autoscaling_describe_traffic_sources(
AutoScalingGroupName,
TrafficSourceType = NULL,
NextToken = NULL,
MaxRecords = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TrafficSourceType |
The traffic source type that you want to describe. The following lists the valid values:
|
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxRecords |
The maximum number of items to return with this call. The maximum value
is |
Gets information about a warm pool and its instances
Description
Gets information about a warm pool and its instances.
See https://www.paws-r-sdk.com/docs/autoscaling_describe_warm_pool/ for full documentation.
Usage
autoscaling_describe_warm_pool(
AutoScalingGroupName,
MaxRecords = NULL,
NextToken = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
MaxRecords |
The maximum number of instances to return with this call. The maximum
value is |
NextToken |
The token for the next set of instances to return. (You received this token from a previous call.) |
Removes one or more instances from the specified Auto Scaling group
Description
Removes one or more instances from the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_detach_instances/ for full documentation.
Usage
autoscaling_detach_instances(
InstanceIds = NULL,
AutoScalingGroupName,
ShouldDecrementDesiredCapacity
)
Arguments
InstanceIds |
The IDs of the instances. You can specify up to 20 instances. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ShouldDecrementDesiredCapacity |
[required] Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached. |
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types
Description
This API operation is superseded by detach_traffic_sources, which can detach multiple traffic sources types. We recommend using detach_traffic_sources to simplify how you manage traffic sources. However, we continue to support detach_load_balancer_target_groups. You can use both the original detach_load_balancer_target_groups API operation and detach_traffic_sources on the same Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_detach_load_balancer_target_groups/ for full documentation.
Usage
autoscaling_detach_load_balancer_target_groups(
AutoScalingGroupName,
TargetGroupARNs
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TargetGroupARNs |
[required] The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups. |
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types
Description
This API operation is superseded by detach_traffic_sources, which can detach multiple traffic sources types. We recommend using detach_traffic_sources to simplify how you manage traffic sources. However, we continue to support detach_load_balancers. You can use both the original detach_load_balancers API operation and detach_traffic_sources on the same Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_detach_load_balancers/ for full documentation.
Usage
autoscaling_detach_load_balancers(AutoScalingGroupName, LoadBalancerNames)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LoadBalancerNames |
[required] The names of the load balancers. You can specify up to 10 load balancers. |
Detaches one or more traffic sources from the specified Auto Scaling group
Description
Detaches one or more traffic sources from the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_detach_traffic_sources/ for full documentation.
Usage
autoscaling_detach_traffic_sources(AutoScalingGroupName, TrafficSources)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TrafficSources |
[required] The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources. |
Disables group metrics collection for the specified Auto Scaling group
Description
Disables group metrics collection for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_disable_metrics_collection/ for full documentation.
Usage
autoscaling_disable_metrics_collection(AutoScalingGroupName, Metrics = NULL)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Metrics |
Identifies the metrics to disable. You can specify one or more of the following metrics:
If you omit this property, all metrics are disabled. For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. |
Enables group metrics collection for the specified Auto Scaling group
Description
Enables group metrics collection for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_enable_metrics_collection/ for full documentation.
Usage
autoscaling_enable_metrics_collection(
AutoScalingGroupName,
Metrics = NULL,
Granularity
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Metrics |
Identifies the metrics to enable. You can specify one or more of the following metrics:
If you specify For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. |
Granularity |
[required] The frequency at which Amazon EC2 Auto Scaling sends aggregated data to
CloudWatch. The only valid value is |
Moves the specified instances into the standby state
Description
Moves the specified instances into the standby state.
See https://www.paws-r-sdk.com/docs/autoscaling_enter_standby/ for full documentation.
Usage
autoscaling_enter_standby(
InstanceIds = NULL,
AutoScalingGroupName,
ShouldDecrementDesiredCapacity
)
Arguments
InstanceIds |
The IDs of the instances. You can specify up to 20 instances. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ShouldDecrementDesiredCapacity |
[required] Indicates whether to decrement the desired capacity of the Auto Scaling
group by the number of instances moved to |
Executes the specified policy
Description
Executes the specified policy. This can be useful for testing the design of your scaling policy.
See https://www.paws-r-sdk.com/docs/autoscaling_execute_policy/ for full documentation.
Usage
autoscaling_execute_policy(
AutoScalingGroupName = NULL,
PolicyName,
HonorCooldown = NULL,
MetricValue = NULL,
BreachThreshold = NULL
)
Arguments
AutoScalingGroupName |
The name of the Auto Scaling group. |
PolicyName |
[required] The name or ARN of the policy. |
HonorCooldown |
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy. Valid only if the policy type is |
MetricValue |
The metric value to compare to If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. Required if the policy type is |
BreachThreshold |
The breach threshold for the alarm. Required if the policy type is |
Moves the specified instances out of the standby state
Description
Moves the specified instances out of the standby state.
See https://www.paws-r-sdk.com/docs/autoscaling_exit_standby/ for full documentation.
Usage
autoscaling_exit_standby(InstanceIds = NULL, AutoScalingGroupName)
Arguments
InstanceIds |
The IDs of the instances. You can specify up to 20 instances. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Retrieves the forecast data for a predictive scaling policy
Description
Retrieves the forecast data for a predictive scaling policy.
See https://www.paws-r-sdk.com/docs/autoscaling_get_predictive_scaling_forecast/ for full documentation.
Usage
autoscaling_get_predictive_scaling_forecast(
AutoScalingGroupName,
PolicyName,
StartTime,
EndTime
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
PolicyName |
[required] The name of the policy. |
StartTime |
[required] The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time. |
EndTime |
[required] The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days. Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance. |
Creates or updates a lifecycle hook for the specified Auto Scaling group
Description
Creates or updates a lifecycle hook for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_put_lifecycle_hook/ for full documentation.
Usage
autoscaling_put_lifecycle_hook(
LifecycleHookName,
AutoScalingGroupName,
LifecycleTransition = NULL,
RoleARN = NULL,
NotificationTargetARN = NULL,
NotificationMetadata = NULL,
HeartbeatTimeout = NULL,
DefaultResult = NULL
)
Arguments
LifecycleHookName |
[required] The name of the lifecycle hook. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LifecycleTransition |
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
Required for new lifecycle hooks, but optional when updating existing hooks. |
RoleARN |
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks. |
NotificationTargetARN |
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue. If you specify an empty string, this overrides the current ARN. This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic. When you specify a notification target, Amazon EC2 Auto Scaling sends it
a test message. Test messages contain the following additional key-value
pair: |
NotificationMetadata |
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. |
HeartbeatTimeout |
The maximum time, in seconds, that can elapse before the lifecycle hook
times out. The range is from |
DefaultResult |
The action the Auto Scaling group takes when the lifecycle hook timeout
elapses or if an unexpected failure occurs. The default value is
Valid values: |
Configures an Auto Scaling group to send notifications when specified events take place
Description
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
See https://www.paws-r-sdk.com/docs/autoscaling_put_notification_configuration/ for full documentation.
Usage
autoscaling_put_notification_configuration(
AutoScalingGroupName,
TopicARN,
NotificationTypes
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
TopicARN |
[required] The Amazon Resource Name (ARN) of the Amazon SNS topic. |
NotificationTypes |
[required] The type of event that causes the notification to be sent. To query the
notification types supported by Amazon EC2 Auto Scaling, call the
|
Creates or updates a scaling policy for an Auto Scaling group
Description
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
See https://www.paws-r-sdk.com/docs/autoscaling_put_scaling_policy/ for full documentation.
Usage
autoscaling_put_scaling_policy(
AutoScalingGroupName,
PolicyName,
PolicyType = NULL,
AdjustmentType = NULL,
MinAdjustmentStep = NULL,
MinAdjustmentMagnitude = NULL,
ScalingAdjustment = NULL,
Cooldown = NULL,
MetricAggregationType = NULL,
StepAdjustments = NULL,
EstimatedInstanceWarmup = NULL,
TargetTrackingConfiguration = NULL,
Enabled = NULL,
PredictiveScalingConfiguration = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
PolicyName |
[required] The name of the policy. |
PolicyType |
One of the following policy types:
|
AdjustmentType |
Specifies how the scaling adjustment is interpreted (for example, an
absolute number or a percentage). The valid values are
Required if the policy type is |
MinAdjustmentStep |
Available for backward compatibility. Use |
MinAdjustmentMagnitude |
The minimum value to scale by when the adjustment type is
Valid only if the policy type is Some Auto Scaling groups use instance weights. In this case, set the
|
ScalingAdjustment |
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value. Required if the policy type is |
Cooldown |
A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown. Valid only if the policy type is Default: None |
MetricAggregationType |
The aggregation type for the CloudWatch metrics. The valid values are
Valid only if the policy type is |
StepAdjustments |
A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is |
EstimatedInstanceWarmup |
Not needed if the default instance warmup is defined for the group. The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup. Valid only if the policy type is The default is to use the value for the default instance warmup defined
for the group. If default instance warmup is null, then
|
TargetTrackingConfiguration |
A target tracking scaling policy. Provides support for predefined or custom metrics. The following predefined metrics are available:
If you specify For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is |
Enabled |
Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disable a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. |
PredictiveScalingConfiguration |
A predictive scaling policy. Provides support for predefined and custom metrics. Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count. For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is |
Creates or updates a scheduled scaling action for an Auto Scaling group
Description
Creates or updates a scheduled scaling action for an Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_put_scheduled_update_group_action/ for full documentation.
Usage
autoscaling_put_scheduled_update_group_action(
AutoScalingGroupName,
ScheduledActionName,
Time = NULL,
StartTime = NULL,
EndTime = NULL,
Recurrence = NULL,
MinSize = NULL,
MaxSize = NULL,
DesiredCapacity = NULL,
TimeZone = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ScheduledActionName |
[required] The name of this scaling action. |
Time |
This property is no longer used. |
StartTime |
The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ
format in UTC/GMT only and in quotes (for example,
If you specify |
EndTime |
The date and time for the recurring schedule to end, in UTC. For
example, |
Recurrence |
The recurring schedule for this action. This format consists of five
fields separated by white spaces: [Minute] [Hour] [Day_of_Month]
[Month_of_Year] [Day_of_Week]. The value must be in quotes (for
example, When Cron expressions use Universal Coordinated Time (UTC) by default. |
MinSize |
The minimum size of the Auto Scaling group. |
MaxSize |
The maximum size of the Auto Scaling group. |
DesiredCapacity |
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions. You must specify at least one of the following properties: |
TimeZone |
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default. Valid values are the canonical names of the IANA time zones, derived
from the IANA Time Zone Database (such as |
Creates or updates a warm pool for the specified Auto Scaling group
Description
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.
See https://www.paws-r-sdk.com/docs/autoscaling_put_warm_pool/ for full documentation.
Usage
autoscaling_put_warm_pool(
AutoScalingGroupName,
MaxGroupPreparedCapacity = NULL,
MinSize = NULL,
PoolState = NULL,
InstanceReusePolicy = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
MaxGroupPreparedCapacity |
Specifies the maximum number of instances that are allowed to be in the
warm pool or in any state except If a value for The size of the warm pool is dynamic. Only when
If the desired capacity of the Auto Scaling group is higher than the
|
MinSize |
Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified. |
PoolState |
Sets the instance state to transition to after the lifecycle actions are
complete. Default is |
InstanceReusePolicy |
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in. |
Records a heartbeat for the lifecycle action associated with the specified token or instance
Description
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the put_lifecycle_hook API call.
See https://www.paws-r-sdk.com/docs/autoscaling_record_lifecycle_action_heartbeat/ for full documentation.
Usage
autoscaling_record_lifecycle_action_heartbeat(
LifecycleHookName,
AutoScalingGroupName,
LifecycleActionToken = NULL,
InstanceId = NULL
)
Arguments
LifecycleHookName |
[required] The name of the lifecycle hook. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LifecycleActionToken |
A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook. |
InstanceId |
The ID of the instance. |
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group
Description
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_resume_processes/ for full documentation.
Usage
autoscaling_resume_processes(AutoScalingGroupName, ScalingProcesses = NULL)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ScalingProcesses |
One or more of the following processes:
If you omit this property, all processes are specified. |
Cancels an instance refresh that is in progress and rolls back any changes that it made
Description
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
See https://www.paws-r-sdk.com/docs/autoscaling_rollback_instance_refresh/ for full documentation.
Usage
autoscaling_rollback_instance_refresh(AutoScalingGroupName)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Sets the size of the specified Auto Scaling group
Description
Sets the size of the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_set_desired_capacity/ for full documentation.
Usage
autoscaling_set_desired_capacity(
AutoScalingGroupName,
DesiredCapacity,
HonorCooldown = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
DesiredCapacity |
[required] The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. |
HonorCooldown |
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities. |
Sets the health status of the specified instance
Description
Sets the health status of the specified instance.
See https://www.paws-r-sdk.com/docs/autoscaling_set_instance_health/ for full documentation.
Usage
autoscaling_set_instance_health(
InstanceId,
HealthStatus,
ShouldRespectGracePeriod = NULL
)
Arguments
InstanceId |
[required] The ID of the instance. |
HealthStatus |
[required] The health status of the instance. Set to |
ShouldRespectGracePeriod |
If the Auto Scaling group of the specified instance has a
For more information about the health check grace period, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. |
Updates the instance protection settings of the specified instances
Description
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
See https://www.paws-r-sdk.com/docs/autoscaling_set_instance_protection/ for full documentation.
Usage
autoscaling_set_instance_protection(
InstanceIds,
AutoScalingGroupName,
ProtectedFromScaleIn
)
Arguments
InstanceIds |
[required] One or more instance IDs. You can specify up to 50 instances. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ProtectedFromScaleIn |
[required] Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. |
Starts an instance refresh
Description
Starts an instance refresh.
See https://www.paws-r-sdk.com/docs/autoscaling_start_instance_refresh/ for full documentation.
Usage
autoscaling_start_instance_refresh(
AutoScalingGroupName,
Strategy = NULL,
DesiredConfiguration = NULL,
Preferences = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
Strategy |
The strategy to use for the instance refresh. The only valid value is
|
DesiredConfiguration |
The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template. Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration. When you specify a new launch template or a new version of the current
launch template for your desired configuration, consider enabling the
|
Preferences |
Sets your preferences for the instance refresh so that it performs as
expected when you start it. Includes the instance warmup time, the
minimum and maximum healthy percentages, and the behaviors that you want
Amazon EC2 Auto Scaling to use if instances that are in
|
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group
Description
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
See https://www.paws-r-sdk.com/docs/autoscaling_suspend_processes/ for full documentation.
Usage
autoscaling_suspend_processes(AutoScalingGroupName, ScalingProcesses = NULL)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ScalingProcesses |
One or more of the following processes:
If you omit this property, all processes are specified. |
Terminates the specified instance and optionally adjusts the desired group size
Description
Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
See https://www.paws-r-sdk.com/docs/autoscaling_terminate_instance_in_auto_scaling_group/ for full documentation.
Usage
autoscaling_terminate_instance_in_auto_scaling_group(
InstanceId,
ShouldDecrementDesiredCapacity
)
Arguments
InstanceId |
[required] The ID of the instance. |
ShouldDecrementDesiredCapacity |
[required] Indicates whether terminating the instance also decrements the size of the Auto Scaling group. |
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2
Description
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
See https://www.paws-r-sdk.com/docs/autoscaling_update_auto_scaling_group/ for full documentation.
Usage
autoscaling_update_auto_scaling_group(
AutoScalingGroupName,
LaunchConfigurationName = NULL,
LaunchTemplate = NULL,
MixedInstancesPolicy = NULL,
MinSize = NULL,
MaxSize = NULL,
DesiredCapacity = NULL,
DefaultCooldown = NULL,
AvailabilityZones = NULL,
HealthCheckType = NULL,
HealthCheckGracePeriod = NULL,
PlacementGroup = NULL,
VPCZoneIdentifier = NULL,
TerminationPolicies = NULL,
NewInstancesProtectedFromScaleIn = NULL,
ServiceLinkedRoleARN = NULL,
MaxInstanceLifetime = NULL,
CapacityRebalance = NULL,
Context = NULL,
DesiredCapacityType = NULL,
DefaultInstanceWarmup = NULL,
InstanceMaintenancePolicy = NULL,
AvailabilityZoneDistribution = NULL,
AvailabilityZoneImpairmentPolicy = NULL,
SkipZonalShiftValidation = NULL,
CapacityReservationSpecification = NULL
)
Arguments
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
LaunchConfigurationName |
The name of the launch configuration. If you specify
|
LaunchTemplate |
The launch template and version to use to specify the updates. If you
specify |
MixedInstancesPolicy |
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide. |
MinSize |
The minimum size of the Auto Scaling group. |
MaxSize |
The maximum size of the Auto Scaling group. With a mixed instances policy that uses instance weighting, Amazon EC2
Auto Scaling may need to go above |
DesiredCapacity |
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. |
DefaultCooldown |
Only needed if you use simple scaling policies. The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. |
AvailabilityZones |
One or more Availability Zones for the group. |
HealthCheckType |
A comma-separated value string of one or more health check types. The valid values are Only specify |
HealthCheckGracePeriod |
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
before checking the health status of an EC2 instance that has come into
service and marking it unhealthy due to a failed health check. This is
useful if your instances do not immediately pass their health checks
after they enter the |
PlacementGroup |
The name of an existing placement group into which to launch your
instances. To remove the placement group setting, pass an empty string
for A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group. |
VPCZoneIdentifier |
A comma-separated list of subnet IDs for a virtual private cloud (VPC).
If you specify |
TerminationPolicies |
A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Valid values: |
NewInstancesProtectedFromScaleIn |
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide. |
ServiceLinkedRoleARN |
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide. |
MaxInstanceLifetime |
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide. |
CapacityRebalance |
Enables or disables Capacity Rebalancing. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide. |
Context |
Reserved. |
DesiredCapacityType |
The unit of measurement for the value specified for desired capacity.
Amazon EC2 Auto Scaling supports By default, Amazon EC2 Auto Scaling specifies Valid values: |
DefaultInstanceWarmup |
The amount of time, in seconds, until a new instance is considered to
have finished initializing and resource consumption to become stable
after it enters the During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. To manage various warm-up settings at the group level, we recommend that
you set the default instance warmup, even if it is set to 0 seconds.
To remove a value that you previously set, include the property but
specify |
InstanceMaintenancePolicy |
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide. |
AvailabilityZoneDistribution |
The instance capacity distribution across Availability Zones. |
AvailabilityZoneImpairmentPolicy |
The policy for Availability Zone impairment. |
SkipZonalShiftValidation |
If you enable zonal shift with cross-zone disabled load balancers,
capacity could become imbalanced across Availability Zones. To skip the
validation, specify |
CapacityReservationSpecification |
The capacity reservation specification for the Auto Scaling group. |
AWS Auto Scaling Plans
Description
AWS Auto Scaling
Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.
API Summary
You can use the AWS Auto Scaling service API to accomplish the following tasks:
Create and manage scaling plans
Define target tracking scaling policies to dynamically scale your resources based on utilization
Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster
Set minimum and maximum capacity limits
Retrieve information on existing scaling plans
Access current forecast data and historical forecast data for up to 56 days previous
To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
Usage
autoscalingplans(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- autoscalingplans(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_scaling_plan | Creates a scaling plan |
| delete_scaling_plan | Deletes the specified scaling plan |
| describe_scaling_plan_resources | Describes the scalable resources in the specified scaling plan |
| describe_scaling_plans | Describes one or more of your scaling plans |
| get_scaling_plan_resource_forecast_data | Retrieves the forecast data for a scalable resource |
| update_scaling_plan | Updates the specified scaling plan |
Examples
## Not run:
svc <- autoscalingplans()
svc$create_scaling_plan(
Foo = 123
)
## End(Not run)
Creates a scaling plan
Description
Creates a scaling plan.
See https://www.paws-r-sdk.com/docs/autoscalingplans_create_scaling_plan/ for full documentation.
Usage
autoscalingplans_create_scaling_plan(
ScalingPlanName,
ApplicationSource,
ScalingInstructions
)
Arguments
ScalingPlanName |
[required] The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes. |
ApplicationSource |
[required] A CloudFormation stack or set of tags. You can create one scaling plan per application source. For more information, see ApplicationSource in the AWS Auto Scaling API Reference. |
ScalingInstructions |
[required] The scaling instructions. For more information, see ScalingInstruction in the AWS Auto Scaling API Reference. |
Deletes the specified scaling plan
Description
Deletes the specified scaling plan.
See https://www.paws-r-sdk.com/docs/autoscalingplans_delete_scaling_plan/ for full documentation.
Usage
autoscalingplans_delete_scaling_plan(ScalingPlanName, ScalingPlanVersion)
Arguments
ScalingPlanName |
[required] The name of the scaling plan. |
ScalingPlanVersion |
[required] The version number of the scaling plan. Currently, the only valid value
is |
Describes the scalable resources in the specified scaling plan
Description
Describes the scalable resources in the specified scaling plan.
See https://www.paws-r-sdk.com/docs/autoscalingplans_describe_scaling_plan_resources/ for full documentation.
Usage
autoscalingplans_describe_scaling_plan_resources(
ScalingPlanName,
ScalingPlanVersion,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ScalingPlanName |
[required] The name of the scaling plan. |
ScalingPlanVersion |
[required] The version number of the scaling plan. Currently, the only valid value
is |
MaxResults |
The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50. |
NextToken |
The token for the next set of results. |
Describes one or more of your scaling plans
Description
Describes one or more of your scaling plans.
See https://www.paws-r-sdk.com/docs/autoscalingplans_describe_scaling_plans/ for full documentation.
Usage
autoscalingplans_describe_scaling_plans(
ScalingPlanNames = NULL,
ScalingPlanVersion = NULL,
ApplicationSources = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ScalingPlanNames |
The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names. |
ScalingPlanVersion |
The version number of the scaling plan. Currently, the only valid value
is If you specify a scaling plan version, you must also specify a scaling plan name. |
ApplicationSources |
The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources. |
MaxResults |
The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50. |
NextToken |
The token for the next set of results. |
Retrieves the forecast data for a scalable resource
Description
Retrieves the forecast data for a scalable resource.
See https://www.paws-r-sdk.com/docs/autoscalingplans_get_scaling_plan_resource_forecast_data/ for full documentation.
Usage
autoscalingplans_get_scaling_plan_resource_forecast_data(
ScalingPlanName,
ScalingPlanVersion,
ServiceNamespace,
ResourceId,
ScalableDimension,
ForecastDataType,
StartTime,
EndTime
)
Arguments
ScalingPlanName |
[required] The name of the scaling plan. |
ScalingPlanVersion |
[required] The version number of the scaling plan. Currently, the only valid value
is |
ServiceNamespace |
[required] The namespace of the AWS service. The only valid value is |
ResourceId |
[required] The ID of the resource. This string consists of a prefix
( |
ScalableDimension |
[required] The scalable dimension for the resource. The only valid value is
|
ForecastDataType |
[required] The type of forecast data to get.
|
StartTime |
[required] The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time. |
EndTime |
[required] The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days. Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance. |
Updates the specified scaling plan
Description
Updates the specified scaling plan.
See https://www.paws-r-sdk.com/docs/autoscalingplans_update_scaling_plan/ for full documentation.
Usage
autoscalingplans_update_scaling_plan(
ScalingPlanName,
ScalingPlanVersion,
ApplicationSource = NULL,
ScalingInstructions = NULL
)
Arguments
ScalingPlanName |
[required] The name of the scaling plan. |
ScalingPlanVersion |
[required] The version number of the scaling plan. The only valid value is |
ApplicationSource |
A CloudFormation stack or set of tags. For more information, see ApplicationSource in the AWS Auto Scaling API Reference. |
ScalingInstructions |
The scaling instructions. For more information, see ScalingInstruction in the AWS Auto Scaling API Reference. |
AWS CloudFormation
Description
CloudFormation
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
Usage
cloudformation(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudformation(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| activate_organizations_access | Activate trusted access with Organizations |
| activate_type | Activates a public third-party extension, making it available for use in stack templates |
| batch_describe_type_configurations | Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region |
| cancel_update_stack | Cancels an update on the specified stack |
| continue_update_rollback | For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state |
| create_change_set | Creates a list of changes that will be applied to a stack so that you can review the changes before executing them |
| create_generated_template | Creates a template from existing resources that are not already managed with CloudFormation |
| create_stack | Creates a stack as specified in the template |
| create_stack_instances | Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions |
| create_stack_refactor | Creates a refactor across multiple stacks, with the list of stacks and resources that are affected |
| create_stack_set | Creates a stack set |
| deactivate_organizations_access | Deactivates trusted access with Organizations |
| deactivate_type | Deactivates a public extension that was previously activated in this account and Region |
| delete_change_set | Deletes the specified change set |
| delete_generated_template | Deleted a generated template |
| delete_stack | Deletes a specified stack |
| delete_stack_instances | Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions |
| delete_stack_set | Deletes a stack set |
| deregister_type | Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use |
| describe_account_limits | Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account |
| describe_change_set | Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set |
| describe_change_set_hooks | Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set |
| describe_generated_template | Describes a generated template |
| describe_organizations_access | Retrieves information about the account's OrganizationAccess status |
| describe_publisher | Returns information about a CloudFormation extension publisher |
| describe_resource_scan | Describes details of a resource scan |
| describe_stack_drift_detection_status | Returns information about a stack drift detection operation |
| describe_stack_events | Returns all stack related events for a specified stack in reverse chronological order |
| describe_stack_instance | Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region |
| describe_stack_refactor | Describes the stack refactor status |
| describe_stack_resource | Returns a description of the specified resource in the specified stack |
| describe_stack_resource_drifts | Returns drift information for the resources that have been checked for drift in the specified stack |
| describe_stack_resources | Returns Amazon Web Services resource descriptions for running and deleted stacks |
| describe_stacks | Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created |
| describe_stack_set | Returns the description of the specified StackSet |
| describe_stack_set_operation | Returns the description of the specified StackSet operation |
| describe_type | Returns detailed information about an extension that has been registered |
| describe_type_registration | Returns information about an extension's registration, including its current status and type and version identifiers |
| detect_stack_drift | Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters |
| detect_stack_resource_drift | Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters |
| detect_stack_set_drift | Detect drift on a stack set |
| estimate_template_cost | Returns the estimated monthly cost of a template |
| execute_change_set | Updates a stack using the input information that was provided when the specified change set was created |
| execute_stack_refactor | Executes the stack refactor operation |
| get_generated_template | Retrieves a generated template |
| get_stack_policy | Returns the stack policy for a specified stack |
| get_template | Returns the template body for a specified stack |
| get_template_summary | Returns information about a new or existing template |
| import_stacks_to_stack_set | Import existing stacks into a new stack sets |
| list_change_sets | Returns the ID and status of each active change set for a stack |
| list_exports | Lists all exported output values in the account and Region in which you call this action |
| list_generated_templates | Lists your generated templates in this Region |
| list_hook_results | Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided |
| list_imports | Lists all stacks that are importing an exported output value |
| list_resource_scan_related_resources | Lists the related resources for a list of resources from a resource scan |
| list_resource_scan_resources | Lists the resources from a resource scan |
| list_resource_scans | List the resource scans from newest to oldest |
| list_stack_instance_resource_drifts | Returns drift information for resources in a stack instance |
| list_stack_instances | Returns summary information about stack instances that are associated with the specified stack set |
| list_stack_refactor_actions | Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action |
| list_stack_refactors | Lists all account stack refactor operations and their statuses |
| list_stack_resources | Returns descriptions of all resources of the specified stack |
| list_stacks | Returns the summary information for stacks whose status matches the specified StackStatusFilter |
| list_stack_set_auto_deployment_targets | Returns summary information about deployment targets for a stack set |
| list_stack_set_operation_results | Returns summary information about the results of a stack set operation |
| list_stack_set_operations | Returns summary information about operations performed on a stack set |
| list_stack_sets | Returns summary information about stack sets that are associated with the user |
| list_type_registrations | Returns a list of registration tokens for the specified extension(s) |
| list_types | Returns summary information about extension that have been registered with CloudFormation |
| list_type_versions | Returns summary information about the versions of an extension |
| publish_type | Publishes the specified extension to the CloudFormation registry as a public extension in this Region |
| record_handler_progress | Reports progress of a resource handler to CloudFormation |
| register_publisher | Registers your account as a publisher of public extensions in the CloudFormation registry |
| register_type | Registers an extension with the CloudFormation service |
| rollback_stack | When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails |
| set_stack_policy | Sets a stack policy for a specified stack |
| set_type_configuration | Specifies the configuration data for a registered CloudFormation extension, in the given account and Region |
| set_type_default_version | Specify the default version of an extension |
| signal_resource | Sends a signal to the specified resource with a success or failure status |
| start_resource_scan | Starts a scan of the resources in this account in this Region |
| stop_stack_set_operation | Stops an in-progress operation on a stack set and its associated stack instances |
| test_type | Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry |
| update_generated_template | Updates a generated template |
| update_stack | Updates a stack as specified in the template |
| update_stack_instances | Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions |
| update_stack_set | Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions |
| update_termination_protection | Updates termination protection for the specified stack |
| validate_template | Validates a specified template |
Examples
## Not run:
svc <- cloudformation()
svc$activate_organizations_access(
Foo = 123
)
## End(Not run)
Activate trusted access with Organizations
Description
Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
See https://www.paws-r-sdk.com/docs/cloudformation_activate_organizations_access/ for full documentation.
Usage
cloudformation_activate_organizations_access()
Activates a public third-party extension, making it available for use in stack templates
Description
Activates a public third-party extension, making it available for use in stack templates. Once you have activated a public third-party extension in your account and Region, use set_type_configuration to specify configuration properties for the extension. For more information, see Using public extensions in the CloudFormation User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_activate_type/ for full documentation.
Usage
cloudformation_activate_type(
Type = NULL,
PublicTypeArn = NULL,
PublisherId = NULL,
TypeName = NULL,
TypeNameAlias = NULL,
AutoUpdate = NULL,
LoggingConfig = NULL,
ExecutionRoleArn = NULL,
VersionBump = NULL,
MajorVersion = NULL
)
Arguments
Type |
The extension type. Conditional: You must specify |
PublicTypeArn |
The Amazon Resource Name (ARN) of the public extension. Conditional: You must specify |
PublisherId |
The ID of the extension publisher. Conditional: You must specify |
TypeName |
The name of the extension. Conditional: You must specify |
TypeNameAlias |
An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console. An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases. |
AutoUpdate |
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. The default is |
LoggingConfig |
Contains logging configuration information for an extension. |
ExecutionRoleArn |
The name of the IAM execution role to use to activate the extension. |
VersionBump |
Manually updates a previously-activated type to a new major or minor
version, if available. You can also use this parameter to update the
value of
|
MajorVersion |
The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected. You can specify |
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region
Description
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
See https://www.paws-r-sdk.com/docs/cloudformation_batch_describe_type_configurations/ for full documentation.
Usage
cloudformation_batch_describe_type_configurations(TypeConfigurationIdentifiers)
Arguments
TypeConfigurationIdentifiers |
[required] The list of identifiers for the desired extension configurations. |
Cancels an update on the specified stack
Description
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
See https://www.paws-r-sdk.com/docs/cloudformation_cancel_update_stack/ for full documentation.
Usage
cloudformation_cancel_update_stack(StackName, ClientRequestToken = NULL)
Arguments
StackName |
[required] If you don't pass a parameter to The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:
The name or the unique stack ID that's associated with the stack. |
ClientRequestToken |
A unique identifier for this
|
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state
Description
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
See https://www.paws-r-sdk.com/docs/cloudformation_continue_update_rollback/ for full documentation.
Usage
cloudformation_continue_update_rollback(
StackName,
RoleARN = NULL,
ResourcesToSkip = NULL,
ClientRequestToken = NULL
)
Arguments
StackName |
[required] The name or the unique ID of the stack that you want to continue rolling back. Don't specify the name of a nested stack (a stack that was created by
using the |
RoleARN |
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials. |
ResourcesToSkip |
A list of the logical IDs of the resources that CloudFormation skips
during the continue update rollback operation. You can specify only
resources that are in the Specify this property to skip rolling back resources that CloudFormation
can't successfully roll back. We recommend that you
troubleshoot
resources before skipping them. CloudFormation sets the status of the
specified resources to Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following
format: Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Continue rolling back from failed nested stack updates. |
ClientRequestToken |
A unique identifier for this
|
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them
Description
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
See https://www.paws-r-sdk.com/docs/cloudformation_create_change_set/ for full documentation.
Usage
cloudformation_create_change_set(
StackName,
TemplateBody = NULL,
TemplateURL = NULL,
UsePreviousTemplate = NULL,
Parameters = NULL,
Capabilities = NULL,
ResourceTypes = NULL,
RoleARN = NULL,
RollbackConfiguration = NULL,
NotificationARNs = NULL,
Tags = NULL,
ChangeSetName,
ClientToken = NULL,
Description = NULL,
ChangeSetType = NULL,
ResourcesToImport = NULL,
IncludeNestedStacks = NULL,
OnStackFailure = NULL,
ImportExistingResources = NULL
)
Arguments
StackName |
[required] The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values. |
TemplateBody |
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only |
TemplateURL |
The URL of the file that contains the revised template. The URL must
point to a template (max size: 1 MB) that's located in an Amazon S3
bucket or a Systems Manager document. CloudFormation generates the
change set by comparing this template with the stack that you specified.
The location for an Amazon S3 bucket must start with Conditional: You must specify only |
UsePreviousTemplate |
Whether to reuse the template that's associated with the stack to create the change set. |
Parameters |
A list of |
Capabilities |
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
Only one of the |
ResourceTypes |
The template resource types that you have permissions to work with if
you execute this change set, such as If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Control access with Identity and Access Management in the CloudFormation User Guide. Only one of the |
RoleARN |
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials. |
RollbackConfiguration |
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. |
NotificationARNs |
The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list. |
Tags |
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags. |
ChangeSetName |
[required] The name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters. |
ClientToken |
A unique identifier for this
|
Description |
A description to help you identify this change set. |
ChangeSetType |
The type of change set operation. To create a change set for a new
stack, specify If you create a change set for a new stack, CloudFormation creates a
stack with a unique stack ID, but no template or resources. The stack
will be in the By default, CloudFormation specifies |
ResourcesToImport |
The resources to import into your stack. |
IncludeNestedStacks |
Creates a change set for the all nested stacks specified in the
template. The default behavior of this action is set to |
OnStackFailure |
Determines what action will be taken if stack creation fails. If this
parameter is specified, the
For nested stacks, when the |
ImportExistingResources |
Indicates if the change set imports resources that already exist. This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Import Amazon Web Services resources into a CloudFormation stack with a resource import in the CloudFormation User Guide. |
Creates a template from existing resources that are not already managed with CloudFormation
Description
Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the describe_generated_template API action.
See https://www.paws-r-sdk.com/docs/cloudformation_create_generated_template/ for full documentation.
Usage
cloudformation_create_generated_template(
Resources = NULL,
GeneratedTemplateName,
StackName = NULL,
TemplateConfiguration = NULL
)
Arguments
Resources |
An optional list of resources to be included in the generated template. If no resources are specified,the template will be created without any
resources. Resources can be added to the template using the
|
GeneratedTemplateName |
[required] The name assigned to the generated template. |
StackName |
An optional name or ARN of a stack to use as the base stack for the generated template. |
TemplateConfiguration |
The configuration details of the generated template, including the
|
Creates a stack as specified in the template
Description
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the describe_stacks operation.
See https://www.paws-r-sdk.com/docs/cloudformation_create_stack/ for full documentation.
Usage
cloudformation_create_stack(
StackName,
TemplateBody = NULL,
TemplateURL = NULL,
Parameters = NULL,
DisableRollback = NULL,
RollbackConfiguration = NULL,
TimeoutInMinutes = NULL,
NotificationARNs = NULL,
Capabilities = NULL,
ResourceTypes = NULL,
RoleARN = NULL,
OnFailure = NULL,
StackPolicyBody = NULL,
StackPolicyURL = NULL,
Tags = NULL,
ClientRequestToken = NULL,
EnableTerminationProtection = NULL,
RetainExceptOnCreate = NULL
)
Arguments
StackName |
[required] The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters. |
TemplateBody |
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify either the |
TemplateURL |
The URL of a file containing the template body. The URL must point to a
template (max size: 1 MB) that's located in an Amazon S3 bucket or a
Systems Manager document. The location for an Amazon S3 bucket must
start with Conditional: You must specify either the |
Parameters |
A list of |
DisableRollback |
Set to Default: |
RollbackConfiguration |
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. |
TimeoutInMinutes |
The amount of time that can pass before the stack status becomes
|
NotificationARNs |
The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI). |
Capabilities |
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
Only one of the |
ResourceTypes |
The template resource types that you have permissions to work with for
this create stack action, such as If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management. Only one of the |
RoleARN |
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials. |
OnFailure |
Determines what action will be taken if stack creation fails. This must
be one of: Default: |
StackPolicyBody |
Structure containing the stack policy body. For more information, see
Prevent updates to stack resources
in the CloudFormation User Guide. You can specify either the
|
StackPolicyURL |
Location of a file containing the stack policy. The URL must point to a
policy (maximum size: 16 KB) located in an S3 bucket in the same Region
as the stack. The location for an Amazon S3 bucket must start with
|
Tags |
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified. |
ClientRequestToken |
A unique identifier for this
All events initiated by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
|
EnableTerminationProtection |
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect CloudFormation stacks from being deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default. For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. |
RetainExceptOnCreate |
When set to Default: |
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions
Description
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
See https://www.paws-r-sdk.com/docs/cloudformation_create_stack_instances/ for full documentation.
Usage
cloudformation_create_stack_instances(
StackSetName,
Accounts = NULL,
DeploymentTargets = NULL,
Regions,
ParameterOverrides = NULL,
OperationPreferences = NULL,
OperationId = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to create stack instances from. |
Accounts |
[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for. You can specify |
DeploymentTargets |
[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions. You can specify |
Regions |
[required] The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts. |
ParameterOverrides |
A list of stack set parameters whose values you want to override in the selected stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value. You can only override the parameter values that are specified in the
stack set; to add or delete a parameter itself, use
|
OperationPreferences |
Preferences for how CloudFormation performs this stack set operation. |
OperationId |
The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. Repeating this stack set operation with a new operation ID retries all
stack instances whose status is |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Creates a refactor across multiple stacks, with the list of stacks and resources that are affected
Description
Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.
See https://www.paws-r-sdk.com/docs/cloudformation_create_stack_refactor/ for full documentation.
Usage
cloudformation_create_stack_refactor(
Description = NULL,
EnableStackCreation = NULL,
ResourceMappings = NULL,
StackDefinitions
)
Arguments
Description |
A description to help you identify the stack refactor. |
EnableStackCreation |
Determines if a new stack is created with the refactor. |
ResourceMappings |
The mappings for the stack resource |
StackDefinitions |
[required] The stacks being refactored. |
Creates a stack set
Description
Creates a stack set.
See https://www.paws-r-sdk.com/docs/cloudformation_create_stack_set/ for full documentation.
Usage
cloudformation_create_stack_set(
StackSetName,
Description = NULL,
TemplateBody = NULL,
TemplateURL = NULL,
StackId = NULL,
Parameters = NULL,
Capabilities = NULL,
Tags = NULL,
AdministrationRoleARN = NULL,
ExecutionRoleName = NULL,
PermissionModel = NULL,
AutoDeployment = NULL,
CallAs = NULL,
ClientRequestToken = NULL,
ManagedExecution = NULL
)
Arguments
StackSetName |
[required] The name to associate with the stack set. The name must be unique in the Region where you create your stack set. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. |
Description |
A description of the stack set. You can use the description to identify the stack set's purpose or other important information. |
TemplateBody |
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. |
TemplateURL |
The URL of a file that contains the template body. The URL must point to
a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or
a Systems Manager document. The location for an Amazon S3 bucket must
start with Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. |
StackId |
The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack. |
Parameters |
The input parameters for the stack set template. |
Capabilities |
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
|
Tags |
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. If you specify tags as part of a
|
AdministrationRoleARN |
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites for using StackSets in the CloudFormation User Guide. |
ExecutionRoleName |
The name of the IAM execution role to use to create the stack set. If
you do not specify an execution role, CloudFormation uses the
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. |
PermissionModel |
Describes how the IAM roles required for stack set operations are
created. By default,
|
AutoDeployment |
Describes whether StackSets automatically deploys to Organizations
accounts that are added to the target organization or organizational
unit (OU). Specify only if |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators. |
ClientRequestToken |
A unique identifier for this
If you don't specify an operation ID, the SDK generates one automatically. |
ManagedExecution |
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. |
Deactivates trusted access with Organizations
Description
Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
See https://www.paws-r-sdk.com/docs/cloudformation_deactivate_organizations_access/ for full documentation.
Usage
cloudformation_deactivate_organizations_access()
Deactivates a public extension that was previously activated in this account and Region
Description
Deactivates a public extension that was previously activated in this account and Region.
See https://www.paws-r-sdk.com/docs/cloudformation_deactivate_type/ for full documentation.
Usage
cloudformation_deactivate_type(TypeName = NULL, Type = NULL, Arn = NULL)
Arguments
TypeName |
The type name of the extension, in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias. Conditional: You must specify either |
Type |
The extension type. Conditional: You must specify either |
Arn |
The Amazon Resource Name (ARN) for the extension, in this account and Region. Conditional: You must specify either |
Deletes the specified change set
Description
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
See https://www.paws-r-sdk.com/docs/cloudformation_delete_change_set/ for full documentation.
Usage
cloudformation_delete_change_set(ChangeSetName, StackName = NULL)
Arguments
ChangeSetName |
[required] The name or Amazon Resource Name (ARN) of the change set that you want to delete. |
StackName |
If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's associated with it. |
Deleted a generated template
Description
Deleted a generated template.
See https://www.paws-r-sdk.com/docs/cloudformation_delete_generated_template/ for full documentation.
Usage
cloudformation_delete_generated_template(GeneratedTemplateName)
Arguments
GeneratedTemplateName |
[required] The name or Amazon Resource Name (ARN) of a generated template. |
Deletes a specified stack
Description
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the describe_stacks operation if the deletion has been completed successfully.
See https://www.paws-r-sdk.com/docs/cloudformation_delete_stack/ for full documentation.
Usage
cloudformation_delete_stack(
StackName,
RetainResources = NULL,
RoleARN = NULL,
ClientRequestToken = NULL,
DeletionMode = NULL
)
Arguments
StackName |
[required] The name or the unique stack ID that's associated with the stack. |
RetainResources |
For stacks in the Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack. |
RoleARN |
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials. |
ClientRequestToken |
A unique identifier for this
All events initiated by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
|
DeletionMode |
Specifies the deletion mode for the stack. Possible values are:
|
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions
Description
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
See https://www.paws-r-sdk.com/docs/cloudformation_delete_stack_instances/ for full documentation.
Usage
cloudformation_delete_stack_instances(
StackSetName,
Accounts = NULL,
DeploymentTargets = NULL,
Regions,
OperationPreferences = NULL,
RetainStacks,
OperationId = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to delete stack instances for. |
Accounts |
[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for. You can specify |
DeploymentTargets |
[Service-managed permissions] The Organizations accounts from which to delete stack instances. You can specify |
Regions |
[required] The Amazon Web Services Regions where you want to delete stack set instances. |
OperationPreferences |
Preferences for how CloudFormation performs this stack set operation. |
RetainStacks |
[required] Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. For more information, see Stack set operation options. |
OperationId |
The unique identifier for this stack set operation. If you don't specify an operation ID, the SDK generates one automatically. The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them. Repeating this stack set operation with a new operation ID retries all
stack instances whose status is |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Deletes a stack set
Description
Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see delete_stack_instances.
See https://www.paws-r-sdk.com/docs/cloudformation_delete_stack_set/ for full documentation.
Usage
cloudformation_delete_stack_set(StackSetName, CallAs = NULL)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you're deleting. You can
obtain this value by running
|
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use
Description
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
See https://www.paws-r-sdk.com/docs/cloudformation_deregister_type/ for full documentation.
Usage
cloudformation_deregister_type(
Arn = NULL,
Type = NULL,
TypeName = NULL,
VersionId = NULL
)
Arguments
Arn |
The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either |
Type |
The kind of extension. Conditional: You must specify either |
TypeName |
The name of the extension. Conditional: You must specify either |
VersionId |
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered. |
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account
Description
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_account_limits/ for full documentation.
Usage
cloudformation_describe_account_limits(NextToken = NULL)
Arguments
NextToken |
A string that identifies the next page of limits that you want to retrieve. |
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set
Description
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_change_set/ for full documentation.
Usage
cloudformation_describe_change_set(
ChangeSetName,
StackName = NULL,
NextToken = NULL,
IncludePropertyValues = NULL
)
Arguments
ChangeSetName |
[required] The name or Amazon Resource Name (ARN) of the change set that you want to describe. |
StackName |
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe. |
NextToken |
A string (provided by the
|
IncludePropertyValues |
If |
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set
Description
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_change_set_hooks/ for full documentation.
Usage
cloudformation_describe_change_set_hooks(
ChangeSetName,
StackName = NULL,
NextToken = NULL,
LogicalResourceId = NULL
)
Arguments
ChangeSetName |
[required] The name or Amazon Resource Name (ARN) of the change set that you want to describe. |
StackName |
If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe. |
NextToken |
A string, provided by the
|
LogicalResourceId |
If specified, lists only the Hooks related to the specified
|
Describes a generated template
Description
Describes a generated template. The output includes details about the progress of the creation of a generated template started by a create_generated_template API action or the update of a generated template started with an update_generated_template API action.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_generated_template/ for full documentation.
Usage
cloudformation_describe_generated_template(GeneratedTemplateName)
Arguments
GeneratedTemplateName |
[required] The name or Amazon Resource Name (ARN) of a generated template. |
Retrieves information about the account's OrganizationAccess status
Description
Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_organizations_access/ for full documentation.
Usage
cloudformation_describe_organizations_access(CallAs = NULL)
Arguments
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns information about a CloudFormation extension publisher
Description
Returns information about a CloudFormation extension publisher.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_publisher/ for full documentation.
Usage
cloudformation_describe_publisher(PublisherId = NULL)
Arguments
PublisherId |
The ID of the extension publisher. If you don't supply a |
Describes details of a resource scan
Description
Describes details of a resource scan.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_resource_scan/ for full documentation.
Usage
cloudformation_describe_resource_scan(ResourceScanId)
Arguments
ResourceScanId |
[required] The Amazon Resource Name (ARN) of the resource scan. |
Returns information about a stack drift detection operation
Description
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_drift_detection_status/ for full documentation.
Usage
cloudformation_describe_stack_drift_detection_status(StackDriftDetectionId)
Arguments
StackDriftDetectionId |
[required] The ID of the drift detection results of this operation. CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary. |
Returns all stack related events for a specified stack in reverse chronological order
Description
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_events/ for full documentation.
Usage
cloudformation_describe_stack_events(StackName = NULL, NextToken = NULL)
Arguments
StackName |
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value. |
NextToken |
A string that identifies the next page of events that you want to retrieve. |
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region
Description
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_instance/ for full documentation.
Usage
cloudformation_describe_stack_instance(
StackSetName,
StackInstanceAccount,
StackInstanceRegion,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or the unique stack ID of the stack set that you want to get stack instance information for. |
StackInstanceAccount |
[required] The ID of an Amazon Web Services account that's associated with this stack instance. |
StackInstanceRegion |
[required] The name of a Region that's associated with this stack instance. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Describes the stack refactor status
Description
Describes the stack refactor status.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_refactor/ for full documentation.
Usage
cloudformation_describe_stack_refactor(StackRefactorId)
Arguments
StackRefactorId |
[required] The ID associated with the stack refactor created from the
|
Returns a description of the specified resource in the specified stack
Description
Returns a description of the specified resource in the specified stack.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_resource/ for full documentation.
Usage
cloudformation_describe_stack_resource(StackName, LogicalResourceId)
Arguments
StackName |
[required] The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value. |
LogicalResourceId |
[required] The logical name of the resource as specified in the template. Default: There is no default value. |
Returns drift information for the resources that have been checked for drift in the specified stack
Description
Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_resource_drifts/ for full documentation.
Usage
cloudformation_describe_stack_resource_drifts(
StackName,
StackResourceDriftStatusFilters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
StackName |
[required] The name of the stack for which you want drift information. |
StackResourceDriftStatusFilters |
The resource drift status values to use as filters for the resource drift results returned.
|
NextToken |
A string that identifies the next page of stack resource drift results. |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Returns Amazon Web Services resource descriptions for running and deleted stacks
Description
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_resources/ for full documentation.
Usage
cloudformation_describe_stack_resources(
StackName = NULL,
LogicalResourceId = NULL,
PhysicalResourceId = NULL
)
Arguments
StackName |
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
Default: There is no default value. Required: Conditional. If you don't specify |
LogicalResourceId |
The logical name of the resource as specified in the template. Default: There is no default value. |
PhysicalResourceId |
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance,
Required: Conditional. If you don't specify Default: There is no default value. |
Returns the description of the specified StackSet
Description
Returns the description of the specified StackSet.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_set/ for full documentation.
Usage
cloudformation_describe_stack_set(StackSetName, CallAs = NULL)
Arguments
StackSetName |
[required] The name or unique ID of the stack set whose description you want. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns the description of the specified StackSet operation
Description
Returns the description of the specified StackSet operation.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_set_operation/ for full documentation.
Usage
cloudformation_describe_stack_set_operation(
StackSetName,
OperationId,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or the unique stack ID of the stack set for the stack operation. |
OperationId |
[required] The unique ID of the stack set operation. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created
Description
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_stacks/ for full documentation.
Usage
cloudformation_describe_stacks(StackName = NULL, NextToken = NULL)
Arguments
StackName |
If you don't pass a parameter to Consider using the The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request: { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:::stack//" }] } The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value. |
NextToken |
A string that identifies the next page of stacks that you want to retrieve. |
Returns detailed information about an extension that has been registered
Description
Returns detailed information about an extension that has been registered.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_type/ for full documentation.
Usage
cloudformation_describe_type(
Type = NULL,
TypeName = NULL,
Arn = NULL,
VersionId = NULL,
PublisherId = NULL,
PublicVersionNumber = NULL
)
Arguments
Type |
The kind of extension. Conditional: You must specify either |
TypeName |
The name of the extension. Conditional: You must specify either |
Arn |
The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either |
VersionId |
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered. If you specify a |
PublisherId |
The publisher ID of the extension publisher. Extensions provided by Amazon Web Services are not assigned a publisher ID. |
PublicVersionNumber |
The version number of a public third-party extension. |
Returns information about an extension's registration, including its current status and type and version identifiers
Description
Returns information about an extension's registration, including its current status and type and version identifiers.
See https://www.paws-r-sdk.com/docs/cloudformation_describe_type_registration/ for full documentation.
Usage
cloudformation_describe_type_registration(RegistrationToken)
Arguments
RegistrationToken |
[required] The identifier for this registration request. This registration token is generated by CloudFormation when you initiate
a registration request using
|
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters
Description
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
See https://www.paws-r-sdk.com/docs/cloudformation_detect_stack_drift/ for full documentation.
Usage
cloudformation_detect_stack_drift(StackName, LogicalResourceIds = NULL)
Arguments
StackName |
[required] The name of the stack for which you want to detect drift. |
LogicalResourceIds |
The logical names of any resources you want to use as filters. |
Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters
Description
Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.
See https://www.paws-r-sdk.com/docs/cloudformation_detect_stack_resource_drift/ for full documentation.
Usage
cloudformation_detect_stack_resource_drift(StackName, LogicalResourceId)
Arguments
StackName |
[required] The name of the stack to which the resource belongs. |
LogicalResourceId |
[required] The logical name of the resource for which to return drift information. |
Detect drift on a stack set
Description
Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see Performing drift detection on CloudFormation StackSets.
See https://www.paws-r-sdk.com/docs/cloudformation_detect_stack_set_drift/ for full documentation.
Usage
cloudformation_detect_stack_set_drift(
StackSetName,
OperationPreferences = NULL,
OperationId = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name of the stack set on which to perform the drift detection operation. |
OperationPreferences |
The user-specified preferences for how CloudFormation performs a stack set operation. For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options. |
OperationId |
The ID of the stack set operation. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns the estimated monthly cost of a template
Description
Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
See https://www.paws-r-sdk.com/docs/cloudformation_estimate_template_cost/ for full documentation.
Usage
cloudformation_estimate_template_cost(
TemplateBody = NULL,
TemplateURL = NULL,
Parameters = NULL
)
Arguments
TemplateBody |
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must pass |
TemplateURL |
The URL of a file containing the template body. The URL must point to a
template that's located in an Amazon S3 bucket or a Systems Manager
document. The location for an Amazon S3 bucket must start with
Conditional: You must pass |
Parameters |
A list of |
Updates a stack using the input information that was provided when the specified change set was created
Description
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the describe_stacks action to view the status of the update.
See https://www.paws-r-sdk.com/docs/cloudformation_execute_change_set/ for full documentation.
Usage
cloudformation_execute_change_set(
ChangeSetName,
StackName = NULL,
ClientRequestToken = NULL,
DisableRollback = NULL,
RetainExceptOnCreate = NULL
)
Arguments
ChangeSetName |
[required] The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack. |
StackName |
If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute. |
ClientRequestToken |
A unique identifier for this
|
DisableRollback |
Preserves the state of previously provisioned resources when an
operation fails. This parameter can't be specified when the
Default: |
RetainExceptOnCreate |
When set to Default: |
Executes the stack refactor operation
Description
Executes the stack refactor operation.
See https://www.paws-r-sdk.com/docs/cloudformation_execute_stack_refactor/ for full documentation.
Usage
cloudformation_execute_stack_refactor(StackRefactorId)
Arguments
StackRefactorId |
[required] The ID associated with the stack refactor created from the
|
Retrieves a generated template
Description
Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.
See https://www.paws-r-sdk.com/docs/cloudformation_get_generated_template/ for full documentation.
Usage
cloudformation_get_generated_template(Format = NULL, GeneratedTemplateName)
Arguments
Format |
The language to use to retrieve for the generated template. Supported values are:
|
GeneratedTemplateName |
[required] The name or Amazon Resource Name (ARN) of the generated template. The
format is
|
Returns the stack policy for a specified stack
Description
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
See https://www.paws-r-sdk.com/docs/cloudformation_get_stack_policy/ for full documentation.
Usage
cloudformation_get_stack_policy(StackName)
Arguments
StackName |
[required] The name or unique stack ID that's associated with the stack whose policy you want to get. |
Returns the template body for a specified stack
Description
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
See https://www.paws-r-sdk.com/docs/cloudformation_get_template/ for full documentation.
Usage
cloudformation_get_template(
StackName = NULL,
ChangeSetName = NULL,
TemplateStage = NULL
)
Arguments
StackName |
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value. |
ChangeSetName |
The name or Amazon Resource Name (ARN) of a change set for which
CloudFormation returns the associated template. If you specify a name,
you must also specify the |
TemplateStage |
For templates that include transforms, the stage of the template that
CloudFormation returns. To get the user-submitted template, specify
If the template doesn't include transforms, |
Returns information about a new or existing template
Description
Returns information about a new or existing template. The get_template_summary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.
See https://www.paws-r-sdk.com/docs/cloudformation_get_template_summary/ for full documentation.
Usage
cloudformation_get_template_summary(
TemplateBody = NULL,
TemplateURL = NULL,
StackName = NULL,
StackSetName = NULL,
CallAs = NULL,
TemplateSummaryConfig = NULL
)
Arguments
TemplateBody |
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify only one of the following parameters:
|
TemplateURL |
The URL of a file containing the template body. The URL must point to a
template (max size: 1 MB) that's located in an Amazon S3 bucket or a
Systems Manager document. The location for an Amazon S3 bucket must
start with Conditional: You must specify only one of the following parameters:
|
StackName |
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters:
|
StackSetName |
The name or unique ID of the stack set from which the stack was created. Conditional: You must specify only one of the following parameters:
|
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
TemplateSummaryConfig |
Specifies options for the
|
Import existing stacks into a new stack sets
Description
Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
See https://www.paws-r-sdk.com/docs/cloudformation_import_stacks_to_stack_set/ for full documentation.
Usage
cloudformation_import_stacks_to_stack_set(
StackSetName,
StackIds = NULL,
StackIdsUrl = NULL,
OrganizationalUnitIds = NULL,
OperationPreferences = NULL,
OperationId = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name of the stack set. The name must be unique in the Region where you create your stack set. |
StackIds |
The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time. Specify either |
StackIdsUrl |
The Amazon S3 URL which contains list of stack ids to be inputted. Specify either |
OrganizationalUnitIds |
The list of OU ID's to which the stacks being imported has to be mapped as deployment target. |
OperationPreferences |
The user-specified preferences for how CloudFormation performs a stack set operation. For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options. |
OperationId |
A unique, user defined, identifier for the stack set operation. |
CallAs |
By default,
|
Returns the ID and status of each active change set for a stack
Description
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
See https://www.paws-r-sdk.com/docs/cloudformation_list_change_sets/ for full documentation.
Usage
cloudformation_list_change_sets(StackName, NextToken = NULL)
Arguments
StackName |
[required] The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets. |
NextToken |
A string (provided by the
|
Lists all exported output values in the account and Region in which you call this action
Description
Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
See https://www.paws-r-sdk.com/docs/cloudformation_list_exports/ for full documentation.
Usage
cloudformation_list_exports(NextToken = NULL)
Arguments
NextToken |
A string (provided by the |
Lists your generated templates in this Region
Description
Lists your generated templates in this Region.
See https://www.paws-r-sdk.com/docs/cloudformation_list_generated_templates/ for full documentation.
Usage
cloudformation_list_generated_templates(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
A string that identifies the next page of resource scan results. |
MaxResults |
If the number of available results exceeds this maximum, the response
includes a |
Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided
Description
Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.
See https://www.paws-r-sdk.com/docs/cloudformation_list_hook_results/ for full documentation.
Usage
cloudformation_list_hook_results(TargetType, TargetId, NextToken = NULL)
Arguments
TargetType |
[required] The type of operation being targeted by the Hook. |
TargetId |
[required] The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set. If the target is a Cloud Control API operation, this will be the
|
NextToken |
A string that identifies the next page of events that you want to retrieve. |
Lists all stacks that are importing an exported output value
Description
Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see list_exports.
See https://www.paws-r-sdk.com/docs/cloudformation_list_imports/ for full documentation.
Usage
cloudformation_list_imports(ExportName, NextToken = NULL)
Arguments
ExportName |
[required] The name of the exported output value. CloudFormation returns the stack names that are importing this value. |
NextToken |
A string (provided by the |
Lists the related resources for a list of resources from a resource scan
Description
Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
See https://www.paws-r-sdk.com/docs/cloudformation_list_resource_scan_related_resources/ for full documentation.
Usage
cloudformation_list_resource_scan_related_resources(
ResourceScanId,
Resources,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ResourceScanId |
[required] The Amazon Resource Name (ARN) of the resource scan. |
Resources |
[required] The list of resources for which you want to get the related resources. Up to 100 resources can be provided. |
NextToken |
A string that identifies the next page of resource scan results. |
MaxResults |
If the number of available results exceeds this maximum, the response
includes a |
Lists the resources from a resource scan
Description
Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
See https://www.paws-r-sdk.com/docs/cloudformation_list_resource_scan_resources/ for full documentation.
Usage
cloudformation_list_resource_scan_resources(
ResourceScanId,
ResourceIdentifier = NULL,
ResourceTypePrefix = NULL,
TagKey = NULL,
TagValue = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ResourceScanId |
[required] The Amazon Resource Name (ARN) of the resource scan. |
ResourceIdentifier |
If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers). |
ResourceTypePrefix |
If specified, the returned resources will be of any of the resource types with the specified prefix. |
TagKey |
If specified, the returned resources will have a matching tag key. |
TagValue |
If specified, the returned resources will have a matching tag value. |
NextToken |
A string that identifies the next page of resource scan results. |
MaxResults |
If the number of available results exceeds this maximum, the response
includes a |
List the resource scans from newest to oldest
Description
List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
See https://www.paws-r-sdk.com/docs/cloudformation_list_resource_scans/ for full documentation.
Usage
cloudformation_list_resource_scans(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
A string that identifies the next page of resource scan results. |
MaxResults |
If the number of available results exceeds this maximum, the response
includes a |
Returns drift information for resources in a stack instance
Description
Returns drift information for resources in a stack instance.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_instance_resource_drifts/ for full documentation.
Usage
cloudformation_list_stack_instance_resource_drifts(
StackSetName,
NextToken = NULL,
MaxResults = NULL,
StackInstanceResourceDriftStatuses = NULL,
StackInstanceAccount,
StackInstanceRegion,
OperationId,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to list drifted resources for. |
NextToken |
If the previous paginated request didn't return all of the remaining
results, the response object's |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
StackInstanceResourceDriftStatuses |
The resource drift status of the stack instance.
|
StackInstanceAccount |
[required] The name of the Amazon Web Services account that you want to list resource drifts for. |
StackInstanceRegion |
[required] The name of the Region where you want to list resource drifts. |
OperationId |
[required] The unique ID of the drift operation. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns summary information about stack instances that are associated with the specified stack set
Description
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_instances/ for full documentation.
Usage
cloudformation_list_stack_instances(
StackSetName,
NextToken = NULL,
MaxResults = NULL,
Filters = NULL,
StackInstanceAccount = NULL,
StackInstanceRegion = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to list stack instances for. |
NextToken |
If the previous request didn't return all the remaining results, the
response's |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Filters |
The filter to apply to stack instances |
StackInstanceAccount |
The name of the Amazon Web Services account that you want to list stack instances for. |
StackInstanceRegion |
The name of the Region where you want to list stack instances. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action
Description
Lists the stack refactor actions that will be taken after calling the execute_stack_refactor action.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_refactor_actions/ for full documentation.
Usage
cloudformation_list_stack_refactor_actions(
StackRefactorId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
StackRefactorId |
[required] The ID associated with the stack refactor created from the
|
NextToken |
If the request doesn't return all the remaining results, |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Lists all account stack refactor operations and their statuses
Description
Lists all account stack refactor operations and their statuses.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_refactors/ for full documentation.
Usage
cloudformation_list_stack_refactors(
ExecutionStatusFilter = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ExecutionStatusFilter |
Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes. |
NextToken |
If the request doesn't return all the remaining results, |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Returns descriptions of all resources of the specified stack
Description
Returns descriptions of all resources of the specified stack.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_resources/ for full documentation.
Usage
cloudformation_list_stack_resources(StackName, NextToken = NULL)
Arguments
StackName |
[required] The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
Default: There is no default value. |
NextToken |
A string that identifies the next page of stack resources that you want to retrieve. |
Returns summary information about deployment targets for a stack set
Description
Returns summary information about deployment targets for a stack set.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_set_auto_deployment_targets/ for full documentation.
Usage
cloudformation_list_stack_set_auto_deployment_targets(
StackSetName,
NextToken = NULL,
MaxResults = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to get automatic deployment targets for. |
NextToken |
A string that identifies the next page of stack set deployment targets that you want to retrieve. |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
CallAs |
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns summary information about the results of a stack set operation
Description
Returns summary information about the results of a stack set operation.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_set_operation_results/ for full documentation.
Usage
cloudformation_list_stack_set_operation_results(
StackSetName,
OperationId,
NextToken = NULL,
MaxResults = NULL,
CallAs = NULL,
Filters = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to get operation results for. |
OperationId |
[required] The ID of the stack set operation. |
NextToken |
If the previous request didn't return all the remaining results, the
response object's |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Filters |
The filter to apply to operation results. |
Returns summary information about operations performed on a stack set
Description
Returns summary information about operations performed on a stack set.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_set_operations/ for full documentation.
Usage
cloudformation_list_stack_set_operations(
StackSetName,
NextToken = NULL,
MaxResults = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to get operation summaries for. |
NextToken |
If the previous paginated request didn't return all of the remaining
results, the response object's |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Returns summary information about stack sets that are associated with the user
Description
Returns summary information about stack sets that are associated with the user.
See https://www.paws-r-sdk.com/docs/cloudformation_list_stack_sets/ for full documentation.
Usage
cloudformation_list_stack_sets(
NextToken = NULL,
MaxResults = NULL,
Status = NULL,
CallAs = NULL
)
Arguments
NextToken |
If the previous paginated request didn't return all the remaining
results, the response object's |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Status |
The status of the stack sets that you want to get summary information about. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account. By default,
|
Returns the summary information for stacks whose status matches the specified StackStatusFilter
Description
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
See https://www.paws-r-sdk.com/docs/cloudformation_list_stacks/ for full documentation.
Usage
cloudformation_list_stacks(NextToken = NULL, StackStatusFilter = NULL)
Arguments
NextToken |
A string that identifies the next page of stacks that you want to retrieve. |
StackStatusFilter |
Stack status to use as a filter. Specify one or more stack status codes
to list only stacks with the specified status codes. For a complete list
of stack status codes, see the |
Returns a list of registration tokens for the specified extension(s)
Description
Returns a list of registration tokens for the specified extension(s).
See https://www.paws-r-sdk.com/docs/cloudformation_list_type_registrations/ for full documentation.
Usage
cloudformation_list_type_registrations(
Type = NULL,
TypeName = NULL,
TypeArn = NULL,
RegistrationStatusFilter = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Type |
The kind of extension. Conditional: You must specify either |
TypeName |
The name of the extension. Conditional: You must specify either |
TypeArn |
The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either |
RegistrationStatusFilter |
The current status of the extension registration request. The default is |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
NextToken |
If the previous paginated request didn't return all the remaining
results, the response object's |
Returns summary information about the versions of an extension
Description
Returns summary information about the versions of an extension.
See https://www.paws-r-sdk.com/docs/cloudformation_list_type_versions/ for full documentation.
Usage
cloudformation_list_type_versions(
Type = NULL,
TypeName = NULL,
Arn = NULL,
MaxResults = NULL,
NextToken = NULL,
DeprecatedStatus = NULL,
PublisherId = NULL
)
Arguments
Type |
The kind of the extension. Conditional: You must specify either |
TypeName |
The name of the extension for which you want version summary information. Conditional: You must specify either |
Arn |
The Amazon Resource Name (ARN) of the extension for which you want version summary information. Conditional: You must specify either |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
NextToken |
If the previous paginated request didn't return all of the remaining
results, the response object's |
DeprecatedStatus |
The deprecation status of the extension versions that you want to get summary information about. Valid values include:
The default is |
PublisherId |
The publisher ID of the extension publisher. Extensions published by Amazon aren't assigned a publisher ID. |
Returns summary information about extension that have been registered with CloudFormation
Description
Returns summary information about extension that have been registered with CloudFormation.
See https://www.paws-r-sdk.com/docs/cloudformation_list_types/ for full documentation.
Usage
cloudformation_list_types(
Visibility = NULL,
ProvisioningType = NULL,
DeprecatedStatus = NULL,
Type = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Visibility |
The scope at which the extensions are visible and usable in CloudFormation operations. Valid values include:
The default is |
ProvisioningType |
For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include:
The default is |
DeprecatedStatus |
The deprecation status of the extension that you want to get summary information about. Valid values include:
|
Type |
The type of extension. |
Filters |
Filter criteria to use in determining which extensions to return. Filters must be compatible with |
MaxResults |
The maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
NextToken |
If the previous paginated request didn't return all the remaining
results, the response object's |
Publishes the specified extension to the CloudFormation registry as a public extension in this Region
Description
Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_publish_type/ for full documentation.
Usage
cloudformation_publish_type(
Type = NULL,
Arn = NULL,
TypeName = NULL,
PublicVersionNumber = NULL
)
Arguments
Type |
The type of the extension. Conditional: You must specify |
Arn |
The Amazon Resource Name (ARN) of the extension. Conditional: You must specify |
TypeName |
The name of the extension. Conditional: You must specify |
PublicVersionNumber |
The version number to assign to this version of the extension. Use the following format, and adhere to semantic versioning when assigning a version number to your extension:
For more information, see Semantic Versioning 2.0.0. If you don't specify a version number, CloudFormation increments the version number by one minor version release. You cannot specify a version number the first time you publish a type.
CloudFormation automatically sets the first version number to be
|
Reports progress of a resource handler to CloudFormation
Description
Reports progress of a resource handler to CloudFormation.
See https://www.paws-r-sdk.com/docs/cloudformation_record_handler_progress/ for full documentation.
Usage
cloudformation_record_handler_progress(
BearerToken,
OperationStatus,
CurrentOperationStatus = NULL,
StatusMessage = NULL,
ErrorCode = NULL,
ResourceModel = NULL,
ClientRequestToken = NULL
)
Arguments
BearerToken |
[required] Reserved for use by the CloudFormation CLI. |
OperationStatus |
[required] Reserved for use by the CloudFormation CLI. |
CurrentOperationStatus |
Reserved for use by the CloudFormation CLI. |
StatusMessage |
Reserved for use by the CloudFormation CLI. |
ErrorCode |
Reserved for use by the CloudFormation CLI. |
ResourceModel |
Reserved for use by the CloudFormation CLI. |
ClientRequestToken |
Reserved for use by the CloudFormation CLI. |
Registers your account as a publisher of public extensions in the CloudFormation registry
Description
Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
See https://www.paws-r-sdk.com/docs/cloudformation_register_publisher/ for full documentation.
Usage
cloudformation_register_publisher(
AcceptTermsAndConditions = NULL,
ConnectionArn = NULL
)
Arguments
AcceptTermsAndConditions |
Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry. The default is |
ConnectionArn |
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide. |
Registers an extension with the CloudFormation service
Description
Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
See https://www.paws-r-sdk.com/docs/cloudformation_register_type/ for full documentation.
Usage
cloudformation_register_type(
Type = NULL,
TypeName,
SchemaHandlerPackage,
LoggingConfig = NULL,
ExecutionRoleArn = NULL,
ClientRequestToken = NULL
)
Arguments
Type |
The kind of extension. |
TypeName |
[required] The name of the extension being registered. We suggest that extension names adhere to the following patterns:
The following organization namespaces are reserved and can't be used in your extension names:
|
SchemaHandlerPackage |
[required] A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation Command Line Interface (CLI) User Guide. The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide. |
LoggingConfig |
Specifies logging configuration information for an extension. |
ExecutionRoleArn |
The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension. For CloudFormation to assume the specified execution role, the role must
contain a trust relationship with the CloudFormation service principal
( If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials. |
ClientRequestToken |
A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times. |
When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails
Description
When specifying rollback_stack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the describe_stacks operation.
See https://www.paws-r-sdk.com/docs/cloudformation_rollback_stack/ for full documentation.
Usage
cloudformation_rollback_stack(
StackName,
RoleARN = NULL,
ClientRequestToken = NULL,
RetainExceptOnCreate = NULL
)
Arguments
StackName |
[required] The name that's associated with the stack. |
RoleARN |
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack. |
ClientRequestToken |
A unique identifier for this
|
RetainExceptOnCreate |
When set to Default: |
Sets a stack policy for a specified stack
Description
Sets a stack policy for a specified stack.
See https://www.paws-r-sdk.com/docs/cloudformation_set_stack_policy/ for full documentation.
Usage
cloudformation_set_stack_policy(
StackName,
StackPolicyBody = NULL,
StackPolicyURL = NULL
)
Arguments
StackName |
[required] The name or unique stack ID that you want to associate a policy with. |
StackPolicyBody |
Structure containing the stack policy body. For more information, see
Prevent updates to stack resources
in the CloudFormation User Guide. You can specify either the
|
StackPolicyURL |
Location of a file containing the stack policy. The URL must point to a
policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same
Amazon Web Services Region as the stack. The location for an Amazon S3
bucket must start with |
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region
Description
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
See https://www.paws-r-sdk.com/docs/cloudformation_set_type_configuration/ for full documentation.
Usage
cloudformation_set_type_configuration(
TypeArn = NULL,
Configuration,
ConfigurationAlias = NULL,
TypeName = NULL,
Type = NULL
)
Arguments
TypeArn |
The Amazon Resource Name (ARN) for the extension, in this account and Region. For public extensions, this will be the ARN assigned when you call the
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version. |
Configuration |
[required] The configuration data for the extension, in this account and Region. The configuration data must be formatted as JSON, and validate against
the schema returned in the |
ConfigurationAlias |
An alias by which to refer to this extension configuration data. Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension. |
TypeName |
The name of the extension. Conditional: You must specify |
Type |
The type of extension. Conditional: You must specify |
Specify the default version of an extension
Description
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
See https://www.paws-r-sdk.com/docs/cloudformation_set_type_default_version/ for full documentation.
Usage
cloudformation_set_type_default_version(
Arn = NULL,
Type = NULL,
TypeName = NULL,
VersionId = NULL
)
Arguments
Arn |
The Amazon Resource Name (ARN) of the extension for which you want version summary information. Conditional: You must specify either |
Type |
The kind of extension. Conditional: You must specify either |
TypeName |
The name of the extension. Conditional: You must specify either |
VersionId |
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered. |
Sends a signal to the specified resource with a success or failure status
Description
Sends a signal to the specified resource with a success or failure status. You can use the signal_resource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The signal_resource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
See https://www.paws-r-sdk.com/docs/cloudformation_signal_resource/ for full documentation.
Usage
cloudformation_signal_resource(StackName, LogicalResourceId, UniqueId, Status)
Arguments
StackName |
[required] The stack name or unique stack ID that includes the resource that you want to signal. |
LogicalResourceId |
[required] The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template. |
UniqueId |
[required] A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. |
Status |
[required] The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update. |
Starts a scan of the resources in this account in this Region
Description
Starts a scan of the resources in this account in this Region. You can the status of a scan using the list_resource_scans API action.
See https://www.paws-r-sdk.com/docs/cloudformation_start_resource_scan/ for full documentation.
Usage
cloudformation_start_resource_scan(ClientRequestToken = NULL)
Arguments
ClientRequestToken |
A unique identifier for this
|
Stops an in-progress operation on a stack set and its associated stack instances
Description
Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
See https://www.paws-r-sdk.com/docs/cloudformation_stop_stack_set_operation/ for full documentation.
Usage
cloudformation_stop_stack_set_operation(
StackSetName,
OperationId,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to stop the operation for. |
OperationId |
[required] The ID of the stack operation. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry
Description
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
See https://www.paws-r-sdk.com/docs/cloudformation_test_type/ for full documentation.
Usage
cloudformation_test_type(
Arn = NULL,
Type = NULL,
TypeName = NULL,
VersionId = NULL,
LogDeliveryBucket = NULL
)
Arguments
Arn |
The Amazon Resource Name (ARN) of the extension. Conditional: You must specify |
Type |
The type of the extension to test. Conditional: You must specify |
TypeName |
The name of the extension to test. Conditional: You must specify |
VersionId |
The version of the extension to test. You can specify the version id with either If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing. |
LogDeliveryBucket |
The S3 bucket to which CloudFormation delivers the contract test execution logs. CloudFormation delivers the logs by the time contract testing has
completed and the extension has been assigned a test type status of
The user calling
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide. |
Updates a generated template
Description
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the describe_generated_template API action.
See https://www.paws-r-sdk.com/docs/cloudformation_update_generated_template/ for full documentation.
Usage
cloudformation_update_generated_template(
GeneratedTemplateName,
NewGeneratedTemplateName = NULL,
AddResources = NULL,
RemoveResources = NULL,
RefreshAllResources = NULL,
TemplateConfiguration = NULL
)
Arguments
GeneratedTemplateName |
[required] The name or Amazon Resource Name (ARN) of a generated template. |
NewGeneratedTemplateName |
An optional new name to assign to the generated template. |
AddResources |
An optional list of resources to be added to the generated template. |
RemoveResources |
A list of logical ids for resources to remove from the generated template. |
RefreshAllResources |
If |
TemplateConfiguration |
The configuration details of the generated template, including the
|
Updates a stack as specified in the template
Description
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the describe_stacks action.
See https://www.paws-r-sdk.com/docs/cloudformation_update_stack/ for full documentation.
Usage
cloudformation_update_stack(
StackName,
TemplateBody = NULL,
TemplateURL = NULL,
UsePreviousTemplate = NULL,
StackPolicyDuringUpdateBody = NULL,
StackPolicyDuringUpdateURL = NULL,
Parameters = NULL,
Capabilities = NULL,
ResourceTypes = NULL,
RoleARN = NULL,
RollbackConfiguration = NULL,
StackPolicyBody = NULL,
StackPolicyURL = NULL,
NotificationARNs = NULL,
Tags = NULL,
DisableRollback = NULL,
ClientRequestToken = NULL,
RetainExceptOnCreate = NULL
)
Arguments
StackName |
[required] The name or unique stack ID of the stack to update. |
TemplateBody |
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify only one of the following parameters:
|
TemplateURL |
The URL of a file containing the template body. The URL must point to a
template that's located in an Amazon S3 bucket or a Systems Manager
document. The location for an Amazon S3 bucket must start with
Conditional: You must specify only one of the following parameters:
|
UsePreviousTemplate |
Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters:
|
StackPolicyDuringUpdateBody |
Structure containing the temporary overriding stack policy body. You can
specify either the If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used. |
StackPolicyDuringUpdateURL |
Location of a file containing the temporary overriding stack policy. The
URL must point to a policy (max size: 16KB) located in an S3 bucket in
the same Region as the stack. The location for an Amazon S3 bucket must
start with If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used. |
Parameters |
A list of |
Capabilities |
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
Only one of the |
ResourceTypes |
The template resource types that you have permissions to work with for
this update stack action, such as If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management. Only one of the |
RoleARN |
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials. |
RollbackConfiguration |
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. |
StackPolicyBody |
Structure containing a new stack policy body. You can specify either the
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged. |
StackPolicyURL |
Location of a file containing the updated stack policy. The URL must
point to a policy (max size: 16KB) located in an S3 bucket in the same
Region as the stack. The location for an Amazon S3 bucket must start
with You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged. |
NotificationARNs |
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics. |
Tags |
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags. |
DisableRollback |
Preserve the state of previously provisioned resources when an operation fails. Default: |
ClientRequestToken |
A unique identifier for this
All events triggered by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
|
RetainExceptOnCreate |
When set to Default: |
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions
Description
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
See https://www.paws-r-sdk.com/docs/cloudformation_update_stack_instances/ for full documentation.
Usage
cloudformation_update_stack_instances(
StackSetName,
Accounts = NULL,
DeploymentTargets = NULL,
Regions,
ParameterOverrides = NULL,
OperationPreferences = NULL,
OperationId = NULL,
CallAs = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set associated with the stack instances. |
Accounts |
[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. You can specify |
DeploymentTargets |
[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values. You can specify |
Regions |
[required] The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. |
ParameterOverrides |
A list of input parameters whose values you want to update for the specified stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value. You can only override the parameter values that are specified in the
stack set; to add or delete a parameter itself, use
|
OperationPreferences |
Preferences for how CloudFormation performs this stack set operation. |
OperationId |
The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions
Description
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
See https://www.paws-r-sdk.com/docs/cloudformation_update_stack_set/ for full documentation.
Usage
cloudformation_update_stack_set(
StackSetName,
Description = NULL,
TemplateBody = NULL,
TemplateURL = NULL,
UsePreviousTemplate = NULL,
Parameters = NULL,
Capabilities = NULL,
Tags = NULL,
OperationPreferences = NULL,
AdministrationRoleARN = NULL,
ExecutionRoleName = NULL,
DeploymentTargets = NULL,
PermissionModel = NULL,
AutoDeployment = NULL,
OperationId = NULL,
Accounts = NULL,
Regions = NULL,
CallAs = NULL,
ManagedExecution = NULL
)
Arguments
StackSetName |
[required] The name or unique ID of the stack set that you want to update. |
Description |
A brief description of updates that you are making. |
TemplateBody |
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify only one of the following parameters:
|
TemplateURL |
The URL of a file that contains the template body. The URL must point to
a template (maximum size: 1 MB) that is located in an Amazon S3 bucket
or a Systems Manager document. The location for an Amazon S3 bucket must
start with Conditional: You must specify only one of the following parameters:
|
UsePreviousTemplate |
Use the existing template that's associated with the stack set that you're updating. Conditional: You must specify only one of the following parameters:
|
Parameters |
A list of input parameters for the stack set template. |
Capabilities |
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
|
Tags |
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you specify new tags as part of an
|
OperationPreferences |
Preferences for how CloudFormation performs this stack set operation. |
AdministrationRoleARN |
The Amazon Resource Name (ARN) of the IAM role to use to update this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the CloudFormation User Guide. If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously. |
ExecutionRoleName |
The name of the IAM execution role to use to update the stack set. If
you do not specify an execution role, CloudFormation uses the
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set. |
DeploymentTargets |
[Service-managed permissions] The Organizations accounts in which to update associated stack instances. To update all the stack instances associated with this stack set, do not
specify If the stack set update includes changes to the template (that is, if
|
PermissionModel |
Describes how the IAM roles required for stack set operations are
created. You cannot modify
|
AutoDeployment |
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). If you specify |
OperationId |
The unique ID for this stack set operation. The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them. If you don't specify an operation ID, CloudFormation generates one automatically. Repeating this stack set operation with a new operation ID retries all
stack instances whose status is |
Accounts |
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set instances. To update all the stack instances associated with this stack set,
don't specify the If the stack set update includes changes to the template (that is, if
the |
Regions |
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances. To update all the stack instances associated with this stack set, do
not specify the If the stack set update includes changes to the template (that is, if
the |
CallAs |
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default,
|
ManagedExecution |
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. |
Updates termination protection for the specified stack
Description
Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
See https://www.paws-r-sdk.com/docs/cloudformation_update_termination_protection/ for full documentation.
Usage
cloudformation_update_termination_protection(
EnableTerminationProtection,
StackName
)
Arguments
EnableTerminationProtection |
[required] Whether to enable termination protection on the specified stack. |
StackName |
[required] The name or unique ID of the stack for which you want to set termination protection. |
Validates a specified template
Description
Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
See https://www.paws-r-sdk.com/docs/cloudformation_validate_template/ for full documentation.
Usage
cloudformation_validate_template(TemplateBody = NULL, TemplateURL = NULL)
Arguments
TemplateBody |
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must pass |
TemplateURL |
The URL of a file containing the template body. The URL must point to a
template (max size: 1 MB) that is located in an Amazon S3 bucket or a
Systems Manager document. The location for an Amazon S3 bucket must
start with Conditional: You must pass |
AWS CloudTrail
Description
CloudTrail
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
Usage
cloudtrail(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudtrail(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| add_tags | Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50 |
| cancel_query | Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED |
| create_channel | Creates a channel for CloudTrail to ingest events from a partner or external source |
| create_dashboard | Creates a custom dashboard or the Highlights dashboard |
| create_event_data_store | Creates a new event data store |
| create_trail | Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket |
| delete_channel | Deletes a channel |
| delete_dashboard | Deletes the specified dashboard |
| delete_event_data_store | Disables the event data store specified by EventDataStore, which accepts an event data store ARN |
| delete_resource_policy | Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel |
| delete_trail | Deletes a trail |
| deregister_organization_delegated_admin | Removes CloudTrail delegated administrator permissions from a member account in an organization |
| describe_query | Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status |
| describe_trails | Retrieves settings for one or more trails associated with the current Region for your account |
| disable_federation | Disables Lake query federation on the specified event data store |
| enable_federation | Enables Lake query federation on the specified event data store |
| generate_query | Generates a query from a natural language prompt |
| get_channel | Returns information about a specific channel |
| get_dashboard | Returns the specified dashboard |
| get_event_data_store | Returns information about an event data store specified as either an ARN or the ID portion of the ARN |
| get_event_selectors | Describes the settings for the event selectors that you configured for your trail |
| get_import | Returns information about a specific import |
| get_insight_selectors | Describes the settings for the Insights event selectors that you configured for your trail or event data store |
| get_query_results | Gets event data results of a query |
| get_resource_policy | Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel |
| get_trail | Returns settings information for a specified trail |
| get_trail_status | Returns a JSON-formatted list of information about the specified trail |
| list_channels | Lists the channels in the current account, and their source names |
| list_dashboards | Returns information about all dashboards in the account, in the current Region |
| list_event_data_stores | Returns information about all event data stores in the account, in the current Region |
| list_import_failures | Returns a list of failures for the specified import |
| list_imports | Returns information on all imports, or a select set of imports by ImportStatus or Destination |
| list_insights_metric_data | Returns Insights metrics data for trails that have enabled Insights |
| list_public_keys | Returns all public keys whose private keys were used to sign the digest files within the specified time range |
| list_queries | Returns a list of queries and query statuses for the past seven days |
| list_tags | Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region |
| list_trails | Lists trails that are in the current account |
| lookup_events | Looks up management events or CloudTrail Insights events that are captured by CloudTrail |
| put_event_selectors | Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail |
| put_insight_selectors | Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store |
| put_resource_policy | Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel |
| register_organization_delegated_admin | Registers an organization’s member account as the CloudTrail delegated administrator |
| remove_tags | Removes the specified tags from a trail, event data store, dashboard, or channel |
| restore_event_data_store | Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN |
| search_sample_queries | Searches sample queries and returns a list of sample queries that are sorted by relevance |
| start_dashboard_refresh | Starts a refresh of the specified dashboard |
| start_event_data_store_ingestion | Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN |
| start_import | Starts an import of logged trail events from a source S3 bucket to a destination event data store |
| start_logging | Starts the recording of Amazon Web Services API calls and log file delivery for a trail |
| start_query | Starts a CloudTrail Lake query |
| stop_event_data_store_ingestion | Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN |
| stop_import | Stops a specified import |
| stop_logging | Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail |
| update_channel | Updates a channel specified by a required channel ARN or UUID |
| update_dashboard | Updates the specified dashboard |
| update_event_data_store | Updates an event data store |
| update_trail | Updates trail settings that control what events you are logging, and how to handle log files |
Examples
## Not run:
svc <- cloudtrail()
svc$add_tags(
Foo = 123
)
## End(Not run)
Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50
Description
Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).
See https://www.paws-r-sdk.com/docs/cloudtrail_add_tags/ for full documentation.
Usage
cloudtrail_add_tags(ResourceId, TagsList)
Arguments
ResourceId |
[required] Specifies the ARN of the trail, event data store, dashboard, or channel to which one or more tags will be added. The format of a trail ARN is:
The format of an event data store ARN is:
The format of a dashboard ARN is:
The format of a channel ARN is:
|
TagsList |
[required] Contains a list of tags, up to a limit of 50 |
Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED
Description
Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run cancel_query, the query status might show as CANCELLED even if the operation is not yet finished.
See https://www.paws-r-sdk.com/docs/cloudtrail_cancel_query/ for full documentation.
Usage
cloudtrail_cancel_query(
EventDataStore = NULL,
QueryId,
EventDataStoreOwnerAccountId = NULL
)
Arguments
EventDataStore |
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running. |
QueryId |
[required] The ID of the query that you want to cancel. The |
EventDataStoreOwnerAccountId |
The account ID of the event data store owner. |
Creates a channel for CloudTrail to ingest events from a partner or external source
Description
Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.
See https://www.paws-r-sdk.com/docs/cloudtrail_create_channel/ for full documentation.
Usage
cloudtrail_create_channel(Name, Source, Destinations, Tags = NULL)
Arguments
Name |
[required] The name of the channel. |
Source |
[required] The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source. A source can be either |
Destinations |
[required] One or more event data stores to which events arriving through a channel will be logged. |
Tags |
Creates a custom dashboard or the Highlights dashboard
Description
Creates a custom dashboard or the Highlights dashboard.
See https://www.paws-r-sdk.com/docs/cloudtrail_create_dashboard/ for full documentation.
Usage
cloudtrail_create_dashboard(
Name,
RefreshSchedule = NULL,
TagsList = NULL,
TerminationProtectionEnabled = NULL,
Widgets = NULL
)
Arguments
Name |
[required] The name of the dashboard. The name must be unique to your account. To create the Highlights dashboard, the name must be
|
RefreshSchedule |
The refresh schedule configuration for the dashboard. To create the Highlights dashboard, you must set a refresh schedule and
set the |
TagsList |
|
TerminationProtectionEnabled |
Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled. |
Widgets |
An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets. You do not need to specify widgets for the Highlights dashboard. |
Creates a new event data store
Description
Creates a new event data store.
See https://www.paws-r-sdk.com/docs/cloudtrail_create_event_data_store/ for full documentation.
Usage
cloudtrail_create_event_data_store(
Name,
AdvancedEventSelectors = NULL,
MultiRegionEnabled = NULL,
OrganizationEnabled = NULL,
RetentionPeriod = NULL,
TerminationProtectionEnabled = NULL,
TagsList = NULL,
KmsKeyId = NULL,
StartIngestion = NULL,
BillingMode = NULL
)
Arguments
Name |
[required] The name of the event data store. |
AdvancedEventSelectors |
The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store. For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide. For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide. For more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide. |
MultiRegionEnabled |
Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created. |
OrganizationEnabled |
Specifies whether an event data store collects events logged for an organization in Organizations. |
RetentionPeriod |
The retention period of the event data store, in days. If CloudTrail Lake determines whether to retain an event by checking if the
If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years. |
TerminationProtectionEnabled |
Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled. |
TagsList |
|
KmsKeyId |
Specifies the KMS key ID to use to encrypt the events delivered by
CloudTrail. The value can be an alias name prefixed by Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store. CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide. Examples:
|
StartIngestion |
Specifies whether the event data store should start ingesting live events. The default is true. |
BillingMode |
The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store. The following are the possible values:
The default value is For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs. |
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket
Description
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
See https://www.paws-r-sdk.com/docs/cloudtrail_create_trail/ for full documentation.
Usage
cloudtrail_create_trail(
Name,
S3BucketName,
S3KeyPrefix = NULL,
SnsTopicName = NULL,
IncludeGlobalServiceEvents = NULL,
IsMultiRegionTrail = NULL,
EnableLogFileValidation = NULL,
CloudWatchLogsLogGroupArn = NULL,
CloudWatchLogsRoleArn = NULL,
KmsKeyId = NULL,
IsOrganizationTrail = NULL,
TagsList = NULL
)
Arguments
Name |
[required] Specifies the name of the trail. The name must meet the following requirements:
|
S3BucketName |
[required] Specifies the name of the Amazon S3 bucket designated for publishing log files. For information about bucket naming rules, see Bucket naming rules in the Amazon Simple Storage Service User Guide. |
S3KeyPrefix |
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. |
SnsTopicName |
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. |
IncludeGlobalServiceEvents |
Specifies whether the trail is publishing events from global services such as IAM to the log files. |
IsMultiRegionTrail |
Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions. |
EnableLogFileValidation |
Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail. |
CloudWatchLogsLogGroupArn |
Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account. Not required unless you specify |
CloudWatchLogsRoleArn |
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account. |
KmsKeyId |
Specifies the KMS key ID to use to encrypt the logs delivered by
CloudTrail. The value can be an alias name prefixed by CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide. Examples:
|
IsOrganizationTrail |
Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations. |
TagsList |
Deletes a channel
Description
Deletes a channel.
See https://www.paws-r-sdk.com/docs/cloudtrail_delete_channel/ for full documentation.
Usage
cloudtrail_delete_channel(Channel)
Arguments
Channel |
[required] The ARN or the |
Deletes the specified dashboard
Description
Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.
See https://www.paws-r-sdk.com/docs/cloudtrail_delete_dashboard/ for full documentation.
Usage
cloudtrail_delete_dashboard(DashboardId)
Arguments
DashboardId |
[required] The name or ARN for the dashboard. |
Disables the event data store specified by EventDataStore, which accepts an event data store ARN
Description
Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run delete_event_data_store, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store and the FederationStatus must be DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is True or the FederationStatus is ENABLED.
See https://www.paws-r-sdk.com/docs/cloudtrail_delete_event_data_store/ for full documentation.
Usage
cloudtrail_delete_event_data_store(EventDataStore)
Arguments
EventDataStore |
[required] The ARN (or the ID suffix of the ARN) of the event data store to delete. |
Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel
Description
Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.
See https://www.paws-r-sdk.com/docs/cloudtrail_delete_resource_policy/ for full documentation.
Usage
cloudtrail_delete_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel you're deleting the resource-based policy from. Example event data store ARN format:
Example dashboard ARN format:
Example channel ARN format:
|
Deletes a trail
Description
Deletes a trail. This operation must be called from the Region in which the trail was created. delete_trail cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.
See https://www.paws-r-sdk.com/docs/cloudtrail_delete_trail/ for full documentation.
Usage
cloudtrail_delete_trail(Name)
Arguments
Name |
[required] Specifies the name or the CloudTrail ARN of the trail to be deleted. The
following is the format of a trail ARN.
|
Removes CloudTrail delegated administrator permissions from a member account in an organization
Description
Removes CloudTrail delegated administrator permissions from a member account in an organization.
See https://www.paws-r-sdk.com/docs/cloudtrail_deregister_organization_delegated_admin/ for full documentation.
Usage
cloudtrail_deregister_organization_delegated_admin(DelegatedAdminAccountId)
Arguments
DelegatedAdminAccountId |
[required] A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator. |
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status
Description
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.
See https://www.paws-r-sdk.com/docs/cloudtrail_describe_query/ for full documentation.
Usage
cloudtrail_describe_query(
EventDataStore = NULL,
QueryId = NULL,
QueryAlias = NULL,
RefreshId = NULL,
EventDataStoreOwnerAccountId = NULL
)
Arguments
EventDataStore |
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run. |
QueryId |
The query ID. |
QueryAlias |
The alias that identifies a query template. |
RefreshId |
The ID of the dashboard refresh. |
EventDataStoreOwnerAccountId |
The account ID of the event data store owner. |
Retrieves settings for one or more trails associated with the current Region for your account
Description
Retrieves settings for one or more trails associated with the current Region for your account.
See https://www.paws-r-sdk.com/docs/cloudtrail_describe_trails/ for full documentation.
Usage
cloudtrail_describe_trails(trailNameList = NULL, includeShadowTrails = NULL)
Arguments
trailNameList |
Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:
If an empty list is specified, information for the trail in the current Region is returned.
If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN. |
includeShadowTrails |
Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true. |
Disables Lake query federation on the specified event data store
Description
Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
See https://www.paws-r-sdk.com/docs/cloudtrail_disable_federation/ for full documentation.
Usage
cloudtrail_disable_federation(EventDataStore)
Arguments
EventDataStore |
[required] The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation. |
Enables Lake query federation on the specified event data store
Description
Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.
See https://www.paws-r-sdk.com/docs/cloudtrail_enable_federation/ for full documentation.
Usage
cloudtrail_enable_federation(EventDataStore, FederationRoleArn)
Arguments
EventDataStore |
[required] The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation. |
FederationRoleArn |
[required] The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event data store. The federation role must exist in your account and provide the required minimum permissions. |
Generates a query from a natural language prompt
Description
Generates a query from a natural language prompt. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt.
See https://www.paws-r-sdk.com/docs/cloudtrail_generate_query/ for full documentation.
Usage
cloudtrail_generate_query(EventDataStores, Prompt)
Arguments
EventDataStores |
[required] The ARN (or ID suffix of the ARN) of the event data store that you want to query. You can only specify one event data store. |
Prompt |
[required] The prompt that you want to use to generate the query. The prompt must be in English. For example prompts, see Example prompts in the CloudTrail user guide. |
Returns information about a specific channel
Description
Returns information about a specific channel.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_channel/ for full documentation.
Usage
cloudtrail_get_channel(Channel)
Arguments
Channel |
[required] The ARN or |
Returns the specified dashboard
Description
Returns the specified dashboard.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_dashboard/ for full documentation.
Usage
cloudtrail_get_dashboard(DashboardId)
Arguments
DashboardId |
[required] The name or ARN for the dashboard. |
Returns information about an event data store specified as either an ARN or the ID portion of the ARN
Description
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_event_data_store/ for full documentation.
Usage
cloudtrail_get_event_data_store(EventDataStore)
Arguments
EventDataStore |
[required] The ARN (or ID suffix of the ARN) of the event data store about which you want information. |
Describes the settings for the event selectors that you configured for your trail
Description
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
See https://www.paws-r-sdk.com/docs/cloudtrail_get_event_selectors/ for full documentation.
Usage
cloudtrail_get_event_selectors(TrailName)
Arguments
TrailName |
[required] Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:
If you specify a trail ARN, it must be in the format:
|
Returns information about a specific import
Description
Returns information about a specific import.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_import/ for full documentation.
Usage
cloudtrail_get_import(ImportId)
Arguments
ImportId |
[required] The ID for the import. |
Describes the settings for the Insights event selectors that you configured for your trail or event data store
Description
Describes the settings for the Insights event selectors that you configured for your trail or event data store. get_insight_selectors shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run get_insight_selectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException
See https://www.paws-r-sdk.com/docs/cloudtrail_get_insight_selectors/ for full documentation.
Usage
cloudtrail_get_insight_selectors(TrailName = NULL, EventDataStore = NULL)
Arguments
TrailName |
Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:
If you specify a trail ARN, it must be in the format:
You cannot use this parameter with the |
EventDataStore |
Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights selectors. You cannot use this parameter with the |
Gets event data results of a query
Description
Gets event data results of a query. You must specify the QueryID value returned by the start_query operation.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_query_results/ for full documentation.
Usage
cloudtrail_get_query_results(
EventDataStore = NULL,
QueryId,
NextToken = NULL,
MaxQueryResults = NULL,
EventDataStoreOwnerAccountId = NULL
)
Arguments
EventDataStore |
The ARN (or ID suffix of the ARN) of the event data store against which the query was run. |
QueryId |
[required] The ID of the query for which you want to get results. |
NextToken |
A token you can use to get the next page of query results. |
MaxQueryResults |
The maximum number of query results to display on a single page. |
EventDataStoreOwnerAccountId |
The account ID of the event data store owner. |
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel
Description
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_resource_policy/ for full documentation.
Usage
cloudtrail_get_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy. Example event data store ARN format:
Example dashboard ARN format:
Example channel ARN format:
|
Returns settings information for a specified trail
Description
Returns settings information for a specified trail.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_trail/ for full documentation.
Usage
cloudtrail_get_trail(Name)
Arguments
Name |
[required] The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information. |
Returns a JSON-formatted list of information about the specified trail
Description
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
See https://www.paws-r-sdk.com/docs/cloudtrail_get_trail_status/ for full documentation.
Usage
cloudtrail_get_trail_status(Name)
Arguments
Name |
[required] Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another Region), you must specify its ARN. The following is the format of a trail ARN:
If the trail is an organization trail and you are a member account in the organization in Organizations, you must provide the full ARN of that trail, and not just the name. |
Lists the channels in the current account, and their source names
Description
Lists the channels in the current account, and their source names.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_channels/ for full documentation.
Usage
cloudtrail_list_channels(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of CloudTrail channels to display on a single page. |
NextToken |
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. |
Returns information about all dashboards in the account, in the current Region
Description
Returns information about all dashboards in the account, in the current Region.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_dashboards/ for full documentation.
Usage
cloudtrail_list_dashboards(
NamePrefix = NULL,
Type = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
NamePrefix |
Specify a name prefix to filter on. |
Type |
Specify a dashboard type to filter on: |
NextToken |
A token you can use to get the next page of dashboard results. |
MaxResults |
The maximum number of dashboards to display on a single page. |
Returns information about all event data stores in the account, in the current Region
Description
Returns information about all event data stores in the account, in the current Region.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_event_data_stores/ for full documentation.
Usage
cloudtrail_list_event_data_stores(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
A token you can use to get the next page of event data store results. |
MaxResults |
The maximum number of event data stores to display on a single page. |
Returns a list of failures for the specified import
Description
Returns a list of failures for the specified import.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_import_failures/ for full documentation.
Usage
cloudtrail_list_import_failures(ImportId, MaxResults = NULL, NextToken = NULL)
Arguments
ImportId |
[required] The ID of the import. |
MaxResults |
The maximum number of failures to display on a single page. |
NextToken |
A token you can use to get the next page of import failures. |
Returns information on all imports, or a select set of imports by ImportStatus or Destination
Description
Returns information on all imports, or a select set of imports by ImportStatus or Destination.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_imports/ for full documentation.
Usage
cloudtrail_list_imports(
MaxResults = NULL,
Destination = NULL,
ImportStatus = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The maximum number of imports to display on a single page. |
Destination |
The ARN of the destination event data store. |
ImportStatus |
The status of the import. |
NextToken |
A token you can use to get the next page of import results. |
Returns Insights metrics data for trails that have enabled Insights
Description
Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_insights_metric_data/ for full documentation.
Usage
cloudtrail_list_insights_metric_data(
EventSource,
EventName,
InsightType,
ErrorCode = NULL,
StartTime = NULL,
EndTime = NULL,
Period = NULL,
DataType = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
EventSource |
[required] The Amazon Web Services service to which the request was made, such as
|
EventName |
[required] The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded. |
InsightType |
[required] The type of CloudTrail Insights event, which is either
|
ErrorCode |
Conditionally required if the If returning metrics for the |
StartTime |
Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp. The default is 90 days before the time of request. |
EndTime |
Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp. The default is the time of request. |
Period |
Granularity of data to retrieve, in seconds. Valid values are |
DataType |
Type of data points to return. Valid values are |
MaxResults |
The maximum number of data points to return. Valid values are integers from 1 to 21600. The default value is 21600. |
NextToken |
Returned if all datapoints can't be returned in a single call. For
example, due to reaching Add this parameter to the request to continue retrieving results starting from the last evaluated point. |
Returns all public keys whose private keys were used to sign the digest files within the specified time range
Description
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_public_keys/ for full documentation.
Usage
cloudtrail_list_public_keys(StartTime = NULL, EndTime = NULL, NextToken = NULL)
Arguments
StartTime |
Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned. |
EndTime |
Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used. |
NextToken |
Reserved for future use. |
Returns a list of queries and query statuses for the past seven days
Description
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_queries/ for full documentation.
Usage
cloudtrail_list_queries(
EventDataStore,
NextToken = NULL,
MaxResults = NULL,
StartTime = NULL,
EndTime = NULL,
QueryStatus = NULL
)
Arguments
EventDataStore |
[required] The ARN (or the ID suffix of the ARN) of an event data store on which queries were run. |
NextToken |
A token you can use to get the next page of results. |
MaxResults |
The maximum number of queries to show on a page. |
StartTime |
Use with |
EndTime |
Use with |
QueryStatus |
The status of queries that you want to return in results. Valid values
for |
Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region
Description
Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_tags/ for full documentation.
Usage
cloudtrail_list_tags(ResourceIdList, NextToken = NULL)
Arguments
ResourceIdList |
[required] Specifies a list of trail, event data store, dashboard, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs. Example trail ARN format:
Example event data store ARN format:
Example dashboard ARN format:
Example channel ARN format:
|
NextToken |
Reserved for future use. |
Lists trails that are in the current account
Description
Lists trails that are in the current account.
See https://www.paws-r-sdk.com/docs/cloudtrail_list_trails/ for full documentation.
Usage
cloudtrail_list_trails(NextToken = NULL)
Arguments
NextToken |
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. |
Looks up management events or CloudTrail Insights events that are captured by CloudTrail
Description
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days.
See https://www.paws-r-sdk.com/docs/cloudtrail_lookup_events/ for full documentation.
Usage
cloudtrail_lookup_events(
LookupAttributes = NULL,
StartTime = NULL,
EndTime = NULL,
EventCategory = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
LookupAttributes |
Contains a list of lookup attributes. Currently the list can contain only one item. |
StartTime |
Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned. |
EndTime |
Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned. |
EventCategory |
Specifies the event category. If you do not specify an event category,
events of the category are not returned in the response. For example, if
you do not specify |
MaxResults |
The number of events to return. Possible values are 1 through 50. The default is 50. |
NextToken |
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. |
Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail
Description
Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.
See https://www.paws-r-sdk.com/docs/cloudtrail_put_event_selectors/ for full documentation.
Usage
cloudtrail_put_event_selectors(
TrailName,
EventSelectors = NULL,
AdvancedEventSelectors = NULL
)
Arguments
TrailName |
[required] Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:
If you specify a trail ARN, it must be in the following format.
|
EventSelectors |
Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:
You can't use event selectors to log network activity events. You can configure up to five event selectors for a trail. You can use
either |
AdvancedEventSelectors |
Specifies the settings for advanced event selectors. You can use advanced event selectors to log management events, data events for all resource types, and network activity events. You can add advanced event selectors, and conditions for your advanced
event selectors, up to a maximum of 500 values for all conditions and
selectors on a trail. You can use either |
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store
Description
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use put_insight_selectors to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are ApiErrorRateInsight and ApiCallRateInsight.
See https://www.paws-r-sdk.com/docs/cloudtrail_put_insight_selectors/ for full documentation.
Usage
cloudtrail_put_insight_selectors(
TrailName = NULL,
InsightSelectors,
EventDataStore = NULL,
InsightsDestination = NULL
)
Arguments
TrailName |
The name of the CloudTrail trail for which you want to change or add Insights selectors. You cannot use this parameter with the |
InsightSelectors |
[required] A JSON string that contains the Insights types you want to log on a
trail or event data store. The The |
EventDataStore |
The ARN (or ID suffix of the ARN) of the source event data store for
which you want to change or add Insights selectors. To enable Insights
on an event data store, you must provide both the You cannot use this parameter with the |
InsightsDestination |
The ARN (or ID suffix of the ARN) of the destination event data store
that logs Insights events. To enable Insights on an event data store,
you must provide both the You cannot use this parameter with the |
Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel
Description
Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
See https://www.paws-r-sdk.com/docs/cloudtrail_put_resource_policy/ for full documentation.
Usage
cloudtrail_put_resource_policy(ResourceArn, ResourcePolicy)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy. Example event data store ARN format:
Example dashboard ARN format:
Example channel ARN format:
|
ResourcePolicy |
[required] A JSON-formatted string for an Amazon Web Services resource-based policy. For example resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide. |
Registers an organization’s member account as the CloudTrail delegated administrator
Description
Registers an organization’s member account as the CloudTrail delegated administrator.
See https://www.paws-r-sdk.com/docs/cloudtrail_register_organization_delegated_admin/ for full documentation.
Usage
cloudtrail_register_organization_delegated_admin(MemberAccountId)
Arguments
MemberAccountId |
[required] An organization member account ID that you want to designate as a delegated administrator. |
Removes the specified tags from a trail, event data store, dashboard, or channel
Description
Removes the specified tags from a trail, event data store, dashboard, or channel.
See https://www.paws-r-sdk.com/docs/cloudtrail_remove_tags/ for full documentation.
Usage
cloudtrail_remove_tags(ResourceId, TagsList)
Arguments
ResourceId |
[required] Specifies the ARN of the trail, event data store, dashboard, or channel from which tags should be removed. Example trail ARN format:
Example event data store ARN format:
Example dashboard ARN format:
Example channel ARN format:
|
TagsList |
[required] Specifies a list of tags to be removed. |
Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN
Description
Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.
See https://www.paws-r-sdk.com/docs/cloudtrail_restore_event_data_store/ for full documentation.
Usage
cloudtrail_restore_event_data_store(EventDataStore)
Arguments
EventDataStore |
[required] The ARN (or the ID suffix of the ARN) of the event data store that you want to restore. |
Searches sample queries and returns a list of sample queries that are sorted by relevance
Description
Searches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language SearchPhrase in English.
See https://www.paws-r-sdk.com/docs/cloudtrail_search_sample_queries/ for full documentation.
Usage
cloudtrail_search_sample_queries(
SearchPhrase,
MaxResults = NULL,
NextToken = NULL
)
Arguments
SearchPhrase |
[required] The natural language phrase to use for the semantic search. The phrase must be in English. The length constraint is in characters, not words. |
MaxResults |
The maximum number of results to return on a single page. The default value is 10. |
NextToken |
A token you can use to get the next page of results. The length constraint is in characters, not words. |
Starts a refresh of the specified dashboard
Description
Starts a refresh of the specified dashboard.
See https://www.paws-r-sdk.com/docs/cloudtrail_start_dashboard_refresh/ for full documentation.
Usage
cloudtrail_start_dashboard_refresh(DashboardId, QueryParameterValues = NULL)
Arguments
DashboardId |
[required] The name or ARN of the dashboard. |
QueryParameterValues |
The query parameter values for the dashboard For custom dashboards, the following query parameters are valid:
For managed dashboards, the following query parameters are valid:
|
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN
Description
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
See https://www.paws-r-sdk.com/docs/cloudtrail_start_event_data_store_ingestion/ for full documentation.
Usage
cloudtrail_start_event_data_store_ingestion(EventDataStore)
Arguments
EventDataStore |
[required] The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion. |
Starts an import of logged trail events from a source S3 bucket to a destination event data store
Description
Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the S3LocationUri. For more considerations about importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
See https://www.paws-r-sdk.com/docs/cloudtrail_start_import/ for full documentation.
Usage
cloudtrail_start_import(
Destinations = NULL,
ImportSource = NULL,
StartEventTime = NULL,
EndEventTime = NULL,
ImportId = NULL
)
Arguments
Destinations |
The ARN of the destination event data store. Use this parameter for a new import. |
ImportSource |
The source S3 bucket for the import. Use this parameter for a new import. |
StartEventTime |
Use with |
EndEventTime |
Use with |
ImportId |
The ID of the import. Use this parameter when you are retrying an import. |
Starts the recording of Amazon Web Services API calls and log file delivery for a trail
Description
Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.
See https://www.paws-r-sdk.com/docs/cloudtrail_start_logging/ for full documentation.
Usage
cloudtrail_start_logging(Name)
Arguments
Name |
[required] Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.
|
Starts a CloudTrail Lake query
Description
Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.
See https://www.paws-r-sdk.com/docs/cloudtrail_start_query/ for full documentation.
Usage
cloudtrail_start_query(
QueryStatement = NULL,
DeliveryS3Uri = NULL,
QueryAlias = NULL,
QueryParameters = NULL,
EventDataStoreOwnerAccountId = NULL
)
Arguments
QueryStatement |
The SQL code of your query. |
DeliveryS3Uri |
The URI for the S3 bucket where CloudTrail delivers the query results. |
QueryAlias |
The alias that identifies a query template. |
QueryParameters |
The query parameters for the specified |
EventDataStoreOwnerAccountId |
The account ID of the event data store owner. |
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN
Description
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
See https://www.paws-r-sdk.com/docs/cloudtrail_stop_event_data_store_ingestion/ for full documentation.
Usage
cloudtrail_stop_event_data_store_ingestion(EventDataStore)
Arguments
EventDataStore |
[required] The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion. |
Stops a specified import
Description
Stops a specified import.
See https://www.paws-r-sdk.com/docs/cloudtrail_stop_import/ for full documentation.
Usage
cloudtrail_stop_import(ImportId)
Arguments
ImportId |
[required] The ID of the import. |
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail
Description
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.
See https://www.paws-r-sdk.com/docs/cloudtrail_stop_logging/ for full documentation.
Usage
cloudtrail_stop_logging(Name)
Arguments
Name |
[required] Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services API calls. The following is the format of a trail ARN.
|
Updates a channel specified by a required channel ARN or UUID
Description
Updates a channel specified by a required channel ARN or UUID.
See https://www.paws-r-sdk.com/docs/cloudtrail_update_channel/ for full documentation.
Usage
cloudtrail_update_channel(Channel, Destinations = NULL, Name = NULL)
Arguments
Channel |
[required] The ARN or ID (the ARN suffix) of the channel that you want to update. |
Destinations |
The ARNs of event data stores that you want to log events arriving through the channel. |
Name |
Changes the name of the channel. |
Updates the specified dashboard
Description
Updates the specified dashboard.
See https://www.paws-r-sdk.com/docs/cloudtrail_update_dashboard/ for full documentation.
Usage
cloudtrail_update_dashboard(
DashboardId,
Widgets = NULL,
RefreshSchedule = NULL,
TerminationProtectionEnabled = NULL
)
Arguments
DashboardId |
[required] The name or ARN of the dashboard. |
Widgets |
An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets. To add new widgets, pass in an array that includes the existing widgets
along with any new widgets. Run the
To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed. |
RefreshSchedule |
The refresh schedule configuration for the dashboard. |
TerminationProtectionEnabled |
Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled. |
Updates an event data store
Description
Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
See https://www.paws-r-sdk.com/docs/cloudtrail_update_event_data_store/ for full documentation.
Usage
cloudtrail_update_event_data_store(
EventDataStore,
Name = NULL,
AdvancedEventSelectors = NULL,
MultiRegionEnabled = NULL,
OrganizationEnabled = NULL,
RetentionPeriod = NULL,
TerminationProtectionEnabled = NULL,
KmsKeyId = NULL,
BillingMode = NULL
)
Arguments
EventDataStore |
[required] The ARN (or the ID suffix of the ARN) of the event data store that you want to update. |
Name |
The event data store name. |
AdvancedEventSelectors |
The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store. |
MultiRegionEnabled |
Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created. |
OrganizationEnabled |
Specifies whether an event data store collects events logged for an organization in Organizations. Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store. |
RetentionPeriod |
The retention period of the event data store, in days. If CloudTrail Lake determines whether to retain an event by checking if the
If you decrease the retention period of an event data store, CloudTrail
will remove any events with an |
TerminationProtectionEnabled |
Indicates that termination protection is enabled and the event data store cannot be automatically deleted. |
KmsKeyId |
Specifies the KMS key ID to use to encrypt the events delivered by
CloudTrail. The value can be an alias name prefixed by Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store. CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide. Examples:
|
BillingMode |
You can't change the billing mode from The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store. The following are the possible values:
For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs. |
Updates trail settings that control what events you are logging, and how to handle log files
Description
Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. update_trail must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.
See https://www.paws-r-sdk.com/docs/cloudtrail_update_trail/ for full documentation.
Usage
cloudtrail_update_trail(
Name,
S3BucketName = NULL,
S3KeyPrefix = NULL,
SnsTopicName = NULL,
IncludeGlobalServiceEvents = NULL,
IsMultiRegionTrail = NULL,
EnableLogFileValidation = NULL,
CloudWatchLogsLogGroupArn = NULL,
CloudWatchLogsRoleArn = NULL,
KmsKeyId = NULL,
IsOrganizationTrail = NULL
)
Arguments
Name |
[required] Specifies the name of the trail or trail ARN. If
If
|
S3BucketName |
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket naming rules. |
S3KeyPrefix |
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. |
SnsTopicName |
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. |
IncludeGlobalServiceEvents |
Specifies whether the trail is publishing events from global services such as IAM to the log files. |
IsMultiRegionTrail |
Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions. |
EnableLogFileValidation |
Specifies whether log file validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail. |
CloudWatchLogsLogGroupArn |
Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account. Not required unless you specify |
CloudWatchLogsRoleArn |
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account. |
KmsKeyId |
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide. Examples:
|
IsOrganizationTrail |
Specifies whether the trail is applied to all accounts in an
organization in Organizations, or only for the current Amazon Web
Services account. The default is false, and cannot be true unless the
call is made on behalf of an Amazon Web Services account that is the
management account for an organization in Organizations. If the trail is
not an organization trail and this is set to Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail. |
AWS CloudTrail Data Service
Description
The CloudTrail Data Service lets you ingest events into CloudTrail from
any source in your hybrid environments, such as in-house or SaaS
applications hosted on-premises or in the cloud, virtual machines, or
containers. You can store, access, analyze, troubleshoot and take action
on this data without maintaining multiple log aggregators and reporting
tools. After you run
put_audit_events to ingest
your application activity into CloudTrail, you can use CloudTrail Lake
to search, query, and analyze the data that is logged from your
applications.
Usage
cloudtraildataservice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudtraildataservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| put_audit_events | Ingests your application events into CloudTrail Lake |
Examples
## Not run:
svc <- cloudtraildataservice()
svc$put_audit_events(
Foo = 123
)
## End(Not run)
Ingests your application events into CloudTrail Lake
Description
Ingests your application events into CloudTrail Lake. A required parameter, auditEvents, accepts the JSON records (also called payload) of events that you want CloudTrail to ingest. You can add up to 100 of these events (or up to 1 MB) per put_audit_events request.
See https://www.paws-r-sdk.com/docs/cloudtraildataservice_put_audit_events/ for full documentation.
Usage
cloudtraildataservice_put_audit_events(
auditEvents,
channelArn,
externalId = NULL
)
Arguments
auditEvents |
[required] The JSON payload of events that you want to ingest. You can also point to the JSON event payload in a file. |
channelArn |
[required] The ARN or ID (the ARN suffix) of a channel. |
externalId |
A unique identifier that is conditionally required when the channel's resource policy includes an external ID. This value can be any string, such as a passphrase or account number. |
Amazon CloudWatch
Description
Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
Usage
cloudwatch(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatch(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| delete_alarms | Deletes the specified alarms |
| delete_anomaly_detector | Deletes the specified anomaly detection model from your account |
| delete_dashboards | Deletes all dashboards that you specify |
| delete_insight_rules | Permanently deletes the specified Contributor Insights rules |
| delete_metric_stream | Permanently deletes the metric stream that you specify |
| describe_alarm_history | Retrieves the history for the specified alarm |
| describe_alarms | Retrieves the specified alarms |
| describe_alarms_for_metric | Retrieves the alarms for the specified metric |
| describe_anomaly_detectors | Lists the anomaly detection models that you have created in your account |
| describe_insight_rules | Returns a list of all the Contributor Insights rules in your account |
| disable_alarm_actions | Disables the actions for the specified alarms |
| disable_insight_rules | Disables the specified Contributor Insights rules |
| enable_alarm_actions | Enables the actions for the specified alarms |
| enable_insight_rules | Enables the specified Contributor Insights rules |
| get_dashboard | Displays the details of the dashboard that you specify |
| get_insight_rule_report | This operation returns the time series data collected by a Contributor Insights rule |
| get_metric_data | You can use the GetMetricData API to retrieve CloudWatch metric values |
| get_metric_statistics | Gets statistics for the specified metric |
| get_metric_stream | Returns information about the metric stream that you specify |
| get_metric_widget_image | You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image |
| list_dashboards | Returns a list of the dashboards for your account |
| list_managed_insight_rules | Returns a list that contains the number of managed Contributor Insights rules in your account |
| list_metrics | List the specified metrics |
| list_metric_streams | Returns a list of metric streams in this account |
| list_tags_for_resource | Displays the tags associated with a CloudWatch resource |
| put_anomaly_detector | Creates an anomaly detection model for a CloudWatch metric |
| put_composite_alarm | Creates or updates a composite alarm |
| put_dashboard | Creates a dashboard if it does not already exist, or updates an existing dashboard |
| put_insight_rule | Creates a Contributor Insights rule |
| put_managed_insight_rules | Creates a managed Contributor Insights rule for a specified Amazon Web Services resource |
| put_metric_alarm | Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query |
| put_metric_data | Publishes metric data to Amazon CloudWatch |
| put_metric_stream | Creates or updates a metric stream |
| set_alarm_state | Temporarily sets the state of an alarm for testing purposes |
| start_metric_streams | Starts the streaming of metrics for one or more of your metric streams |
| stop_metric_streams | Stops the streaming of metrics for one or more of your metric streams |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified CloudWatch resource |
| untag_resource | Removes one or more tags from the specified resource |
Examples
## Not run:
svc <- cloudwatch()
svc$delete_alarms(
Foo = 123
)
## End(Not run)
Deletes the specified alarms
Description
Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
See https://www.paws-r-sdk.com/docs/cloudwatch_delete_alarms/ for full documentation.
Usage
cloudwatch_delete_alarms(AlarmNames)
Arguments
AlarmNames |
[required] The alarms to be deleted. Do not enclose the alarm names in quote marks. |
Deletes the specified anomaly detection model from your account
Description
Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
See https://www.paws-r-sdk.com/docs/cloudwatch_delete_anomaly_detector/ for full documentation.
Usage
cloudwatch_delete_anomaly_detector(
Namespace = NULL,
MetricName = NULL,
Dimensions = NULL,
Stat = NULL,
SingleMetricAnomalyDetector = NULL,
MetricMathAnomalyDetector = NULL
)
Arguments
Namespace |
The namespace associated with the anomaly detection model to delete. |
MetricName |
The metric name associated with the anomaly detection model to delete. |
Dimensions |
The metric dimensions associated with the anomaly detection model to delete. |
Stat |
The statistic associated with the anomaly detection model to delete. |
SingleMetricAnomalyDetector |
A single metric anomaly detector to be deleted. When using
Instead, specify the single metric anomaly detector attributes as part
of the |
MetricMathAnomalyDetector |
The metric math anomaly detector to be deleted. When using
Instead, specify the metric math anomaly detector attributes as part of
the |
Deletes all dashboards that you specify
Description
Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
See https://www.paws-r-sdk.com/docs/cloudwatch_delete_dashboards/ for full documentation.
Usage
cloudwatch_delete_dashboards(DashboardNames)
Arguments
DashboardNames |
[required] The dashboards to be deleted. This parameter is required. |
Permanently deletes the specified Contributor Insights rules
Description
Permanently deletes the specified Contributor Insights rules.
See https://www.paws-r-sdk.com/docs/cloudwatch_delete_insight_rules/ for full documentation.
Usage
cloudwatch_delete_insight_rules(RuleNames)
Arguments
RuleNames |
[required] An array of the rule names to delete. If you need to find out the names
of your rules, use
|
Permanently deletes the metric stream that you specify
Description
Permanently deletes the metric stream that you specify.
See https://www.paws-r-sdk.com/docs/cloudwatch_delete_metric_stream/ for full documentation.
Usage
cloudwatch_delete_metric_stream(Name)
Arguments
Name |
[required] The name of the metric stream to delete. |
Retrieves the history for the specified alarm
Description
Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
See https://www.paws-r-sdk.com/docs/cloudwatch_describe_alarm_history/ for full documentation.
Usage
cloudwatch_describe_alarm_history(
AlarmName = NULL,
AlarmTypes = NULL,
HistoryItemType = NULL,
StartDate = NULL,
EndDate = NULL,
MaxRecords = NULL,
NextToken = NULL,
ScanBy = NULL
)
Arguments
AlarmName |
The name of the alarm. |
AlarmTypes |
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned. |
HistoryItemType |
The type of alarm histories to retrieve. |
StartDate |
The starting date to retrieve alarm history. |
EndDate |
The ending date to retrieve alarm history. |
MaxRecords |
The maximum number of alarm history records to retrieve. |
NextToken |
The token returned by a previous call to indicate that there is more data available. |
ScanBy |
Specified whether to return the newest or oldest alarm history first.
Specify |
Retrieves the specified alarms
Description
Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.
See https://www.paws-r-sdk.com/docs/cloudwatch_describe_alarms/ for full documentation.
Usage
cloudwatch_describe_alarms(
AlarmNames = NULL,
AlarmNamePrefix = NULL,
AlarmTypes = NULL,
ChildrenOfAlarmName = NULL,
ParentsOfAlarmName = NULL,
StateValue = NULL,
ActionPrefix = NULL,
MaxRecords = NULL,
NextToken = NULL
)
Arguments
AlarmNames |
The names of the alarms to retrieve information about. |
AlarmNamePrefix |
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix. If this parameter is specified, you cannot specify |
AlarmTypes |
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account. For example, if you omit this parameter or specify If you specify |
ChildrenOfAlarmName |
If you use this parameter and specify the name of a composite alarm, the
operation returns information about the "children" alarms of the alarm
you specify. These are the metric alarms and composite alarms referenced
in the If you specify Only the |
ParentsOfAlarmName |
If you use this parameter and specify the name of a metric or composite
alarm, the operation returns information about the "parent" alarms of
the alarm you specify. These are the composite alarms that have
If you specify Only the Alarm Name and ARN are returned by this operation when you use
this parameter. To get complete information about these alarms, perform
another |
StateValue |
Specify this parameter to receive information only about alarms that are currently in the state that you specify. |
ActionPrefix |
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic. |
MaxRecords |
The maximum number of alarm descriptions to retrieve. |
NextToken |
The token returned by a previous call to indicate that there is more data available. |
Retrieves the alarms for the specified metric
Description
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
See https://www.paws-r-sdk.com/docs/cloudwatch_describe_alarms_for_metric/ for full documentation.
Usage
cloudwatch_describe_alarms_for_metric(
MetricName,
Namespace,
Statistic = NULL,
ExtendedStatistic = NULL,
Dimensions = NULL,
Period = NULL,
Unit = NULL
)
Arguments
MetricName |
[required] The name of the metric. |
Namespace |
[required] The namespace of the metric. |
Statistic |
The statistic for the metric, other than percentiles. For percentile
statistics, use |
ExtendedStatistic |
The percentile statistic for the metric. Specify a value between p0.0 and p100. |
Dimensions |
The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed. |
Period |
The period, in seconds, over which the statistic is applied. |
Unit |
The unit for the metric. |
Lists the anomaly detection models that you have created in your account
Description
Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.
See https://www.paws-r-sdk.com/docs/cloudwatch_describe_anomaly_detectors/ for full documentation.
Usage
cloudwatch_describe_anomaly_detectors(
NextToken = NULL,
MaxResults = NULL,
Namespace = NULL,
MetricName = NULL,
Dimensions = NULL,
AnomalyDetectorTypes = NULL
)
Arguments
NextToken |
Use the token returned by the previous operation to request the next page of results. |
MaxResults |
The maximum number of results to return in one operation. The maximum value that you can specify is 100. To retrieve the remaining results, make another call with the returned
|
Namespace |
Limits the results to only the anomaly detection models that are associated with the specified namespace. |
MetricName |
Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned. |
Dimensions |
Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned. |
AnomalyDetectorTypes |
The anomaly detector types to request when using
|
Returns a list of all the Contributor Insights rules in your account
Description
Returns a list of all the Contributor Insights rules in your account.
See https://www.paws-r-sdk.com/docs/cloudwatch_describe_insight_rules/ for full documentation.
Usage
cloudwatch_describe_insight_rules(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
Include this value, if it was returned by the previous operation, to get the next set of rules. |
MaxResults |
The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used. |
Disables the actions for the specified alarms
Description
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
See https://www.paws-r-sdk.com/docs/cloudwatch_disable_alarm_actions/ for full documentation.
Usage
cloudwatch_disable_alarm_actions(AlarmNames)
Arguments
AlarmNames |
[required] The names of the alarms. |
Disables the specified Contributor Insights rules
Description
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
See https://www.paws-r-sdk.com/docs/cloudwatch_disable_insight_rules/ for full documentation.
Usage
cloudwatch_disable_insight_rules(RuleNames)
Arguments
RuleNames |
[required] An array of the rule names to disable. If you need to find out the names
of your rules, use
|
Enables the actions for the specified alarms
Description
Enables the actions for the specified alarms.
See https://www.paws-r-sdk.com/docs/cloudwatch_enable_alarm_actions/ for full documentation.
Usage
cloudwatch_enable_alarm_actions(AlarmNames)
Arguments
AlarmNames |
[required] The names of the alarms. |
Enables the specified Contributor Insights rules
Description
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
See https://www.paws-r-sdk.com/docs/cloudwatch_enable_insight_rules/ for full documentation.
Usage
cloudwatch_enable_insight_rules(RuleNames)
Arguments
RuleNames |
[required] An array of the rule names to enable. If you need to find out the names
of your rules, use
|
Displays the details of the dashboard that you specify
Description
Displays the details of the dashboard that you specify.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_dashboard/ for full documentation.
Usage
cloudwatch_get_dashboard(DashboardName)
Arguments
DashboardName |
[required] The name of the dashboard to be described. |
This operation returns the time series data collected by a Contributor Insights rule
Description
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_insight_rule_report/ for full documentation.
Usage
cloudwatch_get_insight_rule_report(
RuleName,
StartTime,
EndTime,
Period,
MaxContributorCount = NULL,
Metrics = NULL,
OrderBy = NULL
)
Arguments
RuleName |
[required] The name of the rule that you want to see data from. |
StartTime |
[required] The start time of the data to use in the report. When used in a raw HTTP
Query API, it is formatted as |
EndTime |
[required] The end time of the data to use in the report. When used in a raw HTTP
Query API, it is formatted as |
Period |
[required] The period, in seconds, to use for the statistics in the
|
MaxContributorCount |
The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used. |
Metrics |
Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:
|
OrderBy |
Determines what statistic to use to rank the contributors. Valid values
are |
You can use the GetMetricData API to retrieve CloudWatch metric values
Description
You can use the get_metric_data API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more metric math functions.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_metric_data/ for full documentation.
Usage
cloudwatch_get_metric_data(
MetricDataQueries,
StartTime,
EndTime,
NextToken = NULL,
ScanBy = NULL,
MaxDatapoints = NULL,
LabelOptions = NULL
)
Arguments
MetricDataQueries |
[required] The metric queries to be returned. A single
|
StartTime |
[required] The time stamp indicating the earliest data to be returned. The value specified is inclusive; results include data points with the specified time stamp. CloudWatch rounds the specified time stamp as follows:
If you set For better performance, specify |
EndTime |
[required] The time stamp indicating the latest data to be returned. The value specified is exclusive; results include data points up to the specified time stamp. For better performance, specify |
NextToken |
Include this value, if it was returned by the previous
|
ScanBy |
The order in which data points should be returned. If you omit this parameter, the default of |
MaxDatapoints |
The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used. |
LabelOptions |
This structure includes the |
Gets statistics for the specified metric
Description
Gets statistics for the specified metric.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_metric_statistics/ for full documentation.
Usage
cloudwatch_get_metric_statistics(
Namespace,
MetricName,
Dimensions = NULL,
StartTime,
EndTime,
Period,
Statistics = NULL,
ExtendedStatistics = NULL,
Unit = NULL
)
Arguments
Namespace |
[required] The namespace of the metric, with or without spaces. |
MetricName |
[required] The name of the metric, with or without spaces. |
Dimensions |
The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide. |
StartTime |
[required] The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request. The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z). CloudWatch rounds the specified time stamp as follows:
If you set |
EndTime |
[required] The time stamp that determines the last data point to return. The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z). |
Period |
[required] The granularity, in seconds, of the returned data points. For metrics
with regular resolution, a period can be as short as one minute (60
seconds) and must be a multiple of 60. For high-resolution metrics that
are collected at intervals of less than one minute, the period can be 1,
5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those
metrics stored by a If the
|
Statistics |
The metric statistics, other than percentile. For percentile statistics,
use |
ExtendedStatistics |
The percentile statistics. Specify values between p0.0 and p100. When
calling |
Unit |
The unit for a given metric. If you omit |
Returns information about the metric stream that you specify
Description
Returns information about the metric stream that you specify.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_metric_stream/ for full documentation.
Usage
cloudwatch_get_metric_stream(Name)
Arguments
Name |
[required] The name of the metric stream to retrieve information about. |
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image
Description
You can use the get_metric_widget_image API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_metric_widget_image/ for full documentation.
Usage
cloudwatch_get_metric_widget_image(MetricWidget, OutputFormat = NULL)
Arguments
MetricWidget |
[required] A JSON string that defines the bitmap graph to be retrieved. The string
includes the metrics to include in the graph, statistics, annotations,
title, axis limits, and so on. You can include only one For more information about the syntax of If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend. |
OutputFormat |
The format of the resulting image. Only PNG images are supported. The default is
The |
Returns a list of the dashboards for your account
Description
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
See https://www.paws-r-sdk.com/docs/cloudwatch_list_dashboards/ for full documentation.
Usage
cloudwatch_list_dashboards(DashboardNamePrefix = NULL, NextToken = NULL)
Arguments
DashboardNamePrefix |
If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_". |
NextToken |
The token returned by a previous call to indicate that there is more data available. |
Returns a list that contains the number of managed Contributor Insights rules in your account
Description
Returns a list that contains the number of managed Contributor Insights rules in your account.
See https://www.paws-r-sdk.com/docs/cloudwatch_list_managed_insight_rules/ for full documentation.
Usage
cloudwatch_list_managed_insight_rules(
ResourceARN,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ResourceARN |
[required] The ARN of an Amazon Web Services resource that has managed Contributor Insights rules. |
NextToken |
Include this value to get the next set of rules if the value was returned by the previous operation. |
MaxResults |
The maximum number of results to return in one operation. If you omit
this parameter, the default number is used. The default number is |
Returns a list of metric streams in this account
Description
Returns a list of metric streams in this account.
See https://www.paws-r-sdk.com/docs/cloudwatch_list_metric_streams/ for full documentation.
Usage
cloudwatch_list_metric_streams(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
Include this value, if it was returned by the previous call, to get the next set of metric streams. |
MaxResults |
The maximum number of results to return in one operation. |
List the specified metrics
Description
List the specified metrics. You can use the returned metrics with get_metric_data or get_metric_statistics to get statistical data.
See https://www.paws-r-sdk.com/docs/cloudwatch_list_metrics/ for full documentation.
Usage
cloudwatch_list_metrics(
Namespace = NULL,
MetricName = NULL,
Dimensions = NULL,
NextToken = NULL,
RecentlyActive = NULL,
IncludeLinkedAccounts = NULL,
OwningAccount = NULL
)
Arguments
Namespace |
The metric namespace to filter against. Only the namespace that matches exactly will be returned. |
MetricName |
The name of the metric to filter against. Only the metrics with names that match exactly will be returned. |
Dimensions |
The dimensions to filter against. Only the dimensions that match exactly will be returned. |
NextToken |
The token returned by a previous call to indicate that there is more data available. |
RecentlyActive |
To filter the results to show only metrics that have had data points
published in the past three hours, specify this parameter with a value
of The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 50 minutes more than the specified time interval. |
IncludeLinkedAccounts |
If you are using this operation in a monitoring account, specify The default is |
OwningAccount |
When you use this operation in a monitoring account, use this field to
return metrics only from one source account. To do so, specify that
source account ID in this field, and also specify |
Displays the tags associated with a CloudWatch resource
Description
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
See https://www.paws-r-sdk.com/docs/cloudwatch_list_tags_for_resource/ for full documentation.
Usage
cloudwatch_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] The ARN of the CloudWatch resource that you want to view tags for. The ARN format of an alarm is
The ARN format of a Contributor Insights rule is
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference. |
Creates an anomaly detection model for a CloudWatch metric
Description
Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_anomaly_detector/ for full documentation.
Usage
cloudwatch_put_anomaly_detector(
Namespace = NULL,
MetricName = NULL,
Dimensions = NULL,
Stat = NULL,
Configuration = NULL,
MetricCharacteristics = NULL,
SingleMetricAnomalyDetector = NULL,
MetricMathAnomalyDetector = NULL
)
Arguments
Namespace |
The namespace of the metric to create the anomaly detection model for. |
MetricName |
The name of the metric to create the anomaly detection model for. |
Dimensions |
The metric dimensions to create the anomaly detection model for. |
Stat |
The statistic to use for the metric and the anomaly detection model. |
Configuration |
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges. The configuration can also include the time zone to use for the metric. |
MetricCharacteristics |
Use this object to include parameters to provide information about your
metric to CloudWatch to help it build more accurate anomaly detection
models. Currently, it includes the |
SingleMetricAnomalyDetector |
A single metric anomaly detector to be created. When using
Instead, specify the single metric anomaly detector attributes as part
of the property |
MetricMathAnomalyDetector |
The metric math anomaly detector to be created. When using
Instead, specify the metric math anomaly detector attributes as part of
the property |
Creates or updates a composite alarm
Description
Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_composite_alarm/ for full documentation.
Usage
cloudwatch_put_composite_alarm(
ActionsEnabled = NULL,
AlarmActions = NULL,
AlarmDescription = NULL,
AlarmName,
AlarmRule,
InsufficientDataActions = NULL,
OKActions = NULL,
Tags = NULL,
ActionsSuppressor = NULL,
ActionsSuppressorWaitPeriod = NULL,
ActionsSuppressorExtensionPeriod = NULL
)
Arguments
ActionsEnabled |
Indicates whether actions should be executed during any changes to the
alarm state of the composite alarm. The default is |
AlarmActions |
The actions to execute when this alarm transitions to the Valid Values: ] Amazon SNS actions:
Lambda actions:
Systems Manager actions:
Start a Amazon Q Developer operational investigation
|
AlarmDescription |
The description for the composite alarm. |
AlarmName |
[required] The name for the composite alarm. This name must be unique within the Region. |
AlarmRule |
[required] An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression. You can use either alarm names or ARNs to reference the other alarms that are to be evaluated. Functions can include the following:
TRUE and FALSE are useful for testing a complex Alarm names specified in The following are some examples of
The |
InsufficientDataActions |
The actions to execute when this alarm transitions to the
Valid Values: ] Amazon SNS actions:
Lambda actions:
|
OKActions |
The actions to execute when this alarm transitions to an Valid Values: ] Amazon SNS actions:
Lambda actions:
|
Tags |
A list of key-value pairs to associate with the alarm. You can associate
as many as 50 tags with an alarm. To be able to associate tags with the
alarm when you create the alarm, you must have the
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. If you are using this operation to update an existing alarm, any tags
you specify in this parameter are ignored. To change the tags of an
existing alarm, use |
ActionsSuppressor |
Actions will be suppressed if the suppressor alarm is in the |
ActionsSuppressorWaitPeriod |
The maximum time in seconds that the composite alarm waits for the
suppressor alarm to go into the
|
ActionsSuppressorExtensionPeriod |
The maximum time in seconds that the composite alarm waits after
suppressor alarm goes out of the
|
Creates a dashboard if it does not already exist, or updates an existing dashboard
Description
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_dashboard/ for full documentation.
Usage
cloudwatch_put_dashboard(DashboardName, DashboardBody)
Arguments
DashboardName |
[required] The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required. |
DashboardBody |
[required] The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required. For more information about the syntax, see Dashboard Body Structure and Syntax. |
Creates a Contributor Insights rule
Description
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_insight_rule/ for full documentation.
Usage
cloudwatch_put_insight_rule(
RuleName,
RuleState = NULL,
RuleDefinition,
Tags = NULL
)
Arguments
RuleName |
[required] A unique name for the rule. |
RuleState |
The state of the rule. Valid values are ENABLED and DISABLED. |
RuleDefinition |
[required] The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax. |
Tags |
A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. To be able to associate tags with a rule, you must have the
If you are using this operation to update an existing Contributor
Insights rule, any tags you specify in this parameter are ignored. To
change the tags of an existing rule, use
|
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource
Description
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You cannot edit these rules with put_insight_rule. The rules can be enabled, disabled, and deleted using enable_insight_rules, disable_insight_rules, and delete_insight_rules. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use list_managed_insight_rules to describe all available rules.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_managed_insight_rules/ for full documentation.
Usage
cloudwatch_put_managed_insight_rules(ManagedRules)
Arguments
ManagedRules |
[required] A list of |
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query
Description
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_metric_alarm/ for full documentation.
Usage
cloudwatch_put_metric_alarm(
AlarmName,
AlarmDescription = NULL,
ActionsEnabled = NULL,
OKActions = NULL,
AlarmActions = NULL,
InsufficientDataActions = NULL,
MetricName = NULL,
Namespace = NULL,
Statistic = NULL,
ExtendedStatistic = NULL,
Dimensions = NULL,
Period = NULL,
Unit = NULL,
EvaluationPeriods,
DatapointsToAlarm = NULL,
Threshold = NULL,
ComparisonOperator,
TreatMissingData = NULL,
EvaluateLowSampleCountPercentile = NULL,
Metrics = NULL,
Tags = NULL,
ThresholdMetricId = NULL
)
Arguments
AlarmName |
[required] The name for the alarm. This name must be unique within the Region. The name must contain only UTF-8 characters, and can't contain ASCII control characters |
AlarmDescription |
The description for the alarm. |
ActionsEnabled |
Indicates whether actions should be executed during any changes to the
alarm state. The default is |
OKActions |
The actions to execute when this alarm transitions to an EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
AlarmActions |
The actions to execute when this alarm transitions to the EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
Start a Amazon Q Developer operational investigation
|
InsufficientDataActions |
The actions to execute when this alarm transitions to the
EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
MetricName |
The name for the metric associated with the alarm. For each
If you are creating an alarm based on a math expression, you cannot
specify this parameter, or any of the |
Namespace |
The namespace for the metric associated specified in |
Statistic |
The statistic for the metric specified in |
ExtendedStatistic |
The extended statistic for the metric specified in If you specify
For more information about these extended statistics, see CloudWatch statistics definitions. |
Dimensions |
The dimensions for the metric specified in |
Period |
The length, in seconds, used each time the metric specified in
Be sure to specify 10 or 30 only for metrics that are stored by a
An alarm's total current evaluation period can be no longer than one
day, so |
Unit |
The unit of measure for the statistic. For example, the units for the
Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the
number of bytes that an instance receives on all network interfaces. You
can also specify a unit when you create a custom metric. Units help
provide conceptual meaning to your data. Metric data points that specify
a unit of measure, such as Percent, are aggregated separately. If you
are creating an alarm based on a metric math expression, you can specify
the unit for each metric (if needed) within the objects in the If you don't specify However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably. We recommend omitting |
EvaluationPeriods |
[required] The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N. An alarm's total current evaluation period can be no longer than one
day, so this number multiplied by |
DatapointsToAlarm |
The number of data points that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide. |
Threshold |
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models. |
ComparisonOperator |
[required] The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. The values |
TreatMissingData |
Sets how this alarm is to handle missing data points. If
Valid Values: Alarms that evaluate metrics in the |
EvaluateLowSampleCountPercentile |
Used only for alarms based on percentiles. If you specify Valid Values: |
Metrics |
An array of Each item in the One item in the If you use the |
Tags |
A list of key-value pairs to associate with the alarm. You can associate
as many as 50 tags with an alarm. To be able to associate tags with the
alarm when you create the alarm, you must have the
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. If you are using this operation to update an existing alarm, any tags
you specify in this parameter are ignored. To change the tags of an
existing alarm, use To use this field to set tags for an alarm when you create it, you must
be signed on with both the |
ThresholdMetricId |
If this is an alarm based on an anomaly detection model, make this value
match the ID of the For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page. If your alarm uses this parameter, it cannot have Auto Scaling actions. |
Publishes metric data to Amazon CloudWatch
Description
Publishes metric data to Amazon CloudWatch. CloudWatch associates the data with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to list_metrics.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_metric_data/ for full documentation.
Usage
cloudwatch_put_metric_data(
Namespace,
MetricData = NULL,
EntityMetricData = NULL,
StrictEntityValidation = NULL
)
Arguments
Namespace |
[required] The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported. To avoid conflicts with Amazon Web Services service namespaces, you
should not specify a namespace that begins with |
MetricData |
The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call. The limit of metrics allowed, 1000, is the sum of both
|
EntityMetricData |
Data for metrics that contain associated entity information. You can
include up to two The limit of metrics allowed, 1000, is the sum of both
|
StrictEntityValidation |
Whether to accept valid metric data when an invalid entity is sent.
This parameter is required when |
Creates or updates a metric stream
Description
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party solutions.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_metric_stream/ for full documentation.
Usage
cloudwatch_put_metric_stream(
Name,
IncludeFilters = NULL,
ExcludeFilters = NULL,
FirehoseArn,
RoleArn,
OutputFormat,
Tags = NULL,
StatisticsConfigurations = NULL,
IncludeLinkedAccountsMetrics = NULL
)
Arguments
Name |
[required] If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region. If you are updating a metric stream, specify the name of that stream here. Valid characters are A-Z, a-z, 0-9, "-" and "_". |
IncludeFilters |
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot include |
ExcludeFilters |
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot include |
FirehoseArn |
[required] The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream. |
RoleArn |
[required] The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:
|
OutputFormat |
[required] The output format for the stream. Valid values are |
Tags |
A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. You can use this parameter only when you are creating a new metric
stream. If you are using this operation to update an existing metric
stream, any tags you specify in this parameter are ignored. To change
the tags of an existing metric stream, use
|
StatisticsConfigurations |
By default, a metric stream always sends the For each entry in this array, you specify one or more metrics and the
list of additional statistics to stream for those metrics. The
additional statistics that you can stream depend on the stream's
|
IncludeLinkedAccountsMetrics |
If you are creating a metric stream in a monitoring account, specify
|
Temporarily sets the state of an alarm for testing purposes
Description
Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.
See https://www.paws-r-sdk.com/docs/cloudwatch_set_alarm_state/ for full documentation.
Usage
cloudwatch_set_alarm_state(
AlarmName,
StateValue,
StateReason,
StateReasonData = NULL
)
Arguments
AlarmName |
[required] The name of the alarm. |
StateValue |
[required] The value of the state. |
StateReason |
[required] The reason that this alarm is set to this specific state, in text format. |
StateReasonData |
The reason that this alarm is set to this specific state, in JSON format. For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action. |
Starts the streaming of metrics for one or more of your metric streams
Description
Starts the streaming of metrics for one or more of your metric streams.
See https://www.paws-r-sdk.com/docs/cloudwatch_start_metric_streams/ for full documentation.
Usage
cloudwatch_start_metric_streams(Names)
Arguments
Names |
[required] The array of the names of metric streams to start streaming. This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will start streaming. |
Stops the streaming of metrics for one or more of your metric streams
Description
Stops the streaming of metrics for one or more of your metric streams.
See https://www.paws-r-sdk.com/docs/cloudwatch_stop_metric_streams/ for full documentation.
Usage
cloudwatch_stop_metric_streams(Names)
Arguments
Names |
[required] The array of the names of metric streams to stop streaming. This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will stop streaming. |
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource
Description
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
See https://www.paws-r-sdk.com/docs/cloudwatch_tag_resource/ for full documentation.
Usage
cloudwatch_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] The ARN of the CloudWatch resource that you're adding tags to. The ARN format of an alarm is
The ARN format of a Contributor Insights rule is
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference. |
Tags |
[required] The list of key-value pairs to associate with the alarm. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/cloudwatch_untag_resource/ for full documentation.
Usage
cloudwatch_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] The ARN of the CloudWatch resource that you're removing tags from. The ARN format of an alarm is
The ARN format of a Contributor Insights rule is
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference. |
TagKeys |
[required] The list of tag keys to remove from the resource. |
Amazon CloudWatch Application Signals
Description
Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.
Application Signals provides the following benefits:
Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.
Create and monitor service level objectives (SLOs).
See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.
Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.
Usage
cloudwatchapplicationsignals(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatchapplicationsignals(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| batch_get_service_level_objective_budget_report | Use this operation to retrieve one or more service level objective (SLO) budget reports |
| create_service_level_objective | Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations |
| delete_service_level_objective | Deletes the specified service level objective |
| get_service | Returns information about a service discovered by Application Signals |
| get_service_level_objective | Returns information about one SLO created in the account |
| list_service_dependencies | Returns a list of service dependencies of the service that you specify |
| list_service_dependents | Returns the list of dependents that invoked the specified service during the provided time range |
| list_service_level_objectives | Returns a list of SLOs created in this account |
| list_service_operations | Returns a list of the operations of this service that have been discovered by Application Signals |
| list_services | Returns a list of services that have been discovered by Application Signals |
| list_tags_for_resource | Displays the tags associated with a CloudWatch resource |
| start_discovery | Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective |
| untag_resource | Removes one or more tags from the specified resource |
| update_service_level_objective | Updates an existing service level objective (SLO) |
Examples
## Not run:
svc <- cloudwatchapplicationsignals()
svc$batch_get_service_level_objective_budget_report(
Foo = 123
)
## End(Not run)
Use this operation to retrieve one or more service level objective (SLO) budget reports
Description
Use this operation to retrieve one or more service level objective (SLO) budget reports.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_batch_get_service_level_objective_budget_report/ for full documentation.
Usage
cloudwatchapplicationsignals_batch_get_service_level_objective_budget_report(
Timestamp,
SloIds
)
Arguments
Timestamp |
[required] The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. |
SloIds |
[required] An array containing the IDs of the service level objectives that you want to include in the report. |
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations
Description
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_create_service_level_objective/ for full documentation.
Usage
cloudwatchapplicationsignals_create_service_level_objective(
Name,
Description = NULL,
SliConfig = NULL,
RequestBasedSliConfig = NULL,
Goal = NULL,
Tags = NULL,
BurnRateConfigurations = NULL
)
Arguments
Name |
[required] A name for this SLO. |
Description |
An optional description for this SLO. |
SliConfig |
If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor. You can't specify both |
RequestBasedSliConfig |
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor. You can't specify both |
Goal |
This structure contains the attributes that determine the goal of the SLO. |
Tags |
A list of key-value pairs to associate with the SLO. You can associate
as many as 50 tags with an SLO. To be able to associate tags with the
SLO when you create the SLO, you must have the Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. |
BurnRateConfigurations |
Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO. |
Deletes the specified service level objective
Description
Deletes the specified service level objective.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_delete_service_level_objective/ for full documentation.
Usage
cloudwatchapplicationsignals_delete_service_level_objective(Id)
Arguments
Id |
[required] The ARN or name of the service level objective to delete. |
Returns information about a service discovered by Application Signals
Description
Returns information about a service discovered by Application Signals.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_get_service/ for full documentation.
Usage
cloudwatchapplicationsignals_get_service(StartTime, EndTime, KeyAttributes)
Arguments
StartTime |
[required] The start of the time period to retrieve information about. When used in
a raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
EndTime |
[required] The end of the time period to retrieve information about. When used in a
raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
KeyAttributes |
[required] Use this field to specify which service you want to retrieve information
for. You must specify at least the This is a string-to-string map. It can include the following fields.
|
Returns information about one SLO created in the account
Description
Returns information about one SLO created in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_get_service_level_objective/ for full documentation.
Usage
cloudwatchapplicationsignals_get_service_level_objective(Id)
Arguments
Id |
[required] The ARN or name of the SLO that you want to retrieve information about.
You can find the ARNs of SLOs by using the
|
Returns a list of service dependencies of the service that you specify
Description
Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_list_service_dependencies/ for full documentation.
Usage
cloudwatchapplicationsignals_list_service_dependencies(
StartTime,
EndTime,
KeyAttributes,
MaxResults = NULL,
NextToken = NULL
)
Arguments
StartTime |
[required] The start of the time period to retrieve information about. When used in
a raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
EndTime |
[required] The end of the time period to retrieve information about. When used in a
raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested end time will be rounded to the nearest hour. |
KeyAttributes |
[required] Use this field to specify which service you want to retrieve information
for. You must specify at least the This is a string-to-string map. It can include the following fields.
|
MaxResults |
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. |
NextToken |
Include this value, if it was returned by the previous operation, to get the next set of service dependencies. |
Returns the list of dependents that invoked the specified service during the provided time range
Description
Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_list_service_dependents/ for full documentation.
Usage
cloudwatchapplicationsignals_list_service_dependents(
StartTime,
EndTime,
KeyAttributes,
MaxResults = NULL,
NextToken = NULL
)
Arguments
StartTime |
[required] The start of the time period to retrieve information about. When used in
a raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
EndTime |
[required] The end of the time period to retrieve information about. When used in a
raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
KeyAttributes |
[required] Use this field to specify which service you want to retrieve information
for. You must specify at least the This is a string-to-string map. It can include the following fields.
|
MaxResults |
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. |
NextToken |
Include this value, if it was returned by the previous operation, to get the next set of service dependents. |
Returns a list of SLOs created in this account
Description
Returns a list of SLOs created in this account.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_list_service_level_objectives/ for full documentation.
Usage
cloudwatchapplicationsignals_list_service_level_objectives(
KeyAttributes = NULL,
OperationName = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
KeyAttributes |
You can use this optional field to specify which services you want to retrieve SLO information for. This is a string-to-string map. It can include the following fields.
|
OperationName |
The name of the operation that this SLO is associated with. |
MaxResults |
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. |
NextToken |
Include this value, if it was returned by the previous operation, to get the next set of service level objectives. |
Returns a list of the operations of this service that have been discovered by Application Signals
Description
Returns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_list_service_operations/ for full documentation.
Usage
cloudwatchapplicationsignals_list_service_operations(
StartTime,
EndTime,
KeyAttributes,
MaxResults = NULL,
NextToken = NULL
)
Arguments
StartTime |
[required] The start of the time period to retrieve information about. When used in
a raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
EndTime |
[required] The end of the time period to retrieve information about. When used in a
raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested end time will be rounded to the nearest hour. |
KeyAttributes |
[required] Use this field to specify which service you want to retrieve information
for. You must specify at least the This is a string-to-string map. It can include the following fields.
|
MaxResults |
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. |
NextToken |
Include this value, if it was returned by the previous operation, to get the next set of service operations. |
Returns a list of services that have been discovered by Application Signals
Description
Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_list_services/ for full documentation.
Usage
cloudwatchapplicationsignals_list_services(
StartTime,
EndTime,
MaxResults = NULL,
NextToken = NULL
)
Arguments
StartTime |
[required] The start of the time period to retrieve information about. When used in
a raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
EndTime |
[required] The end of the time period to retrieve information about. When used in a
raw HTTP Query API, it is formatted as be epoch time in seconds. For
example: Your requested start time will be rounded to the nearest hour. |
MaxResults |
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. |
NextToken |
Include this value, if it was returned by the previous operation, to get the next set of services. |
Displays the tags associated with a CloudWatch resource
Description
Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_list_tags_for_resource/ for full documentation.
Usage
cloudwatchapplicationsignals_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for. The ARN format of an Application Signals SLO is
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference. |
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role
Description
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the following permissions:
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_start_discovery/ for full documentation.
Usage
cloudwatchapplicationsignals_start_discovery()
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective
Description
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_tag_resource/ for full documentation.
Usage
cloudwatchapplicationsignals_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for. The ARN format of an Application Signals SLO is
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference. |
Tags |
[required] The list of key-value pairs to associate with the alarm. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_untag_resource/ for full documentation.
Usage
cloudwatchapplicationsignals_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from. The ARN format of an Application Signals SLO is
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference. |
TagKeys |
[required] The list of tag keys to remove from the resource. |
Updates an existing service level objective (SLO)
Description
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
See https://www.paws-r-sdk.com/docs/cloudwatchapplicationsignals_update_service_level_objective/ for full documentation.
Usage
cloudwatchapplicationsignals_update_service_level_objective(
Id,
Description = NULL,
SliConfig = NULL,
RequestBasedSliConfig = NULL,
Goal = NULL,
BurnRateConfigurations = NULL
)
Arguments
Id |
[required] The Amazon Resource Name (ARN) or name of the service level objective that you want to update. |
Description |
An optional description for the SLO. |
SliConfig |
If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor. |
RequestBasedSliConfig |
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor. You can't specify both |
Goal |
A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold. |
BurnRateConfigurations |
Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO. |
Amazon CloudWatch Evidently
Description
You can use Amazon CloudWatch Evidently to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.
You can also conduct A/B experiments to make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.
Usage
cloudwatchevidently(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatchevidently(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| batch_evaluate_feature | This operation assigns feature variation to user sessions |
| create_experiment | Creates an Evidently experiment |
| create_feature | Creates an Evidently feature that you want to launch or test |
| create_launch | Creates a launch of a given feature |
| create_project | Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments |
| create_segment | Use this operation to define a segment of your audience |
| delete_experiment | Deletes an Evidently experiment |
| delete_feature | Deletes an Evidently feature |
| delete_launch | Deletes an Evidently launch |
| delete_project | Deletes an Evidently project |
| delete_segment | Deletes a segment |
| evaluate_feature | This operation assigns a feature variation to one given user session |
| get_experiment | Returns the details about one experiment |
| get_experiment_results | Retrieves the results of a running or completed experiment |
| get_feature | Returns the details about one feature |
| get_launch | Returns the details about one launch |
| get_project | Returns the details about one launch |
| get_segment | Returns information about the specified segment |
| list_experiments | Returns configuration details about all the experiments in the specified project |
| list_features | Returns configuration details about all the features in the specified project |
| list_launches | Returns configuration details about all the launches in the specified project |
| list_projects | Returns configuration details about all the projects in the current Region in your account |
| list_segment_references | Use this operation to find which experiments or launches are using a specified segment |
| list_segments | Returns a list of audience segments that you have created in your account in this Region |
| list_tags_for_resource | Displays the tags associated with an Evidently resource |
| put_project_events | Sends performance events to Evidently |
| start_experiment | Starts an existing experiment |
| start_launch | Starts an existing launch |
| stop_experiment | Stops an experiment that is currently running |
| stop_launch | Stops a launch that is currently running |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource |
| test_segment_pattern | Use this operation to test a rules pattern that you plan to use to create an audience segment |
| untag_resource | Removes one or more tags from the specified resource |
| update_experiment | Updates an Evidently experiment |
| update_feature | Updates an existing feature |
| update_launch | Updates a launch of a given feature |
| update_project | Updates the description of an existing project |
| update_project_data_delivery | Updates the data storage options for this project |
Examples
## Not run:
svc <- cloudwatchevidently()
svc$batch_evaluate_feature(
Foo = 123
)
## End(Not run)
This operation assigns feature variation to user sessions
Description
This operation assigns feature variation to user sessions. For each user session, you pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_batch_evaluate_feature/ for full documentation.
Usage
cloudwatchevidently_batch_evaluate_feature(project, requests)
Arguments
project |
[required] The name or ARN of the project that contains the feature being evaluated. |
requests |
[required] An array of structures, where each structure assigns a feature variation to one user session. |
Creates an Evidently experiment
Description
Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_create_experiment/ for full documentation.
Usage
cloudwatchevidently_create_experiment(
description = NULL,
metricGoals,
name,
onlineAbConfig = NULL,
project,
randomizationSalt = NULL,
samplingRate = NULL,
segment = NULL,
tags = NULL,
treatments
)
Arguments
description |
An optional description of the experiment. |
metricGoals |
[required] An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. |
name |
[required] A name for the new experiment. |
onlineAbConfig |
A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation. |
project |
[required] The name or ARN of the project that you want to create the new experiment in. |
randomizationSalt |
When Evidently assigns a particular user session to an experiment, it
must use a randomization ID to determine which variation the user
session is served. This randomization ID is a combination of the entity
ID and |
samplingRate |
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature. This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience. |
segment |
Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. |
tags |
Assigns one or more tags (key-value pairs) to the experiment. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with an experiment. For more information, see Tagging Amazon Web Services resources. |
treatments |
[required] An array of structures that describe the configuration of each feature variation used in the experiment. |
Creates an Evidently feature that you want to launch or test
Description
Creates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see create_project.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_create_feature/ for full documentation.
Usage
cloudwatchevidently_create_feature(
defaultVariation = NULL,
description = NULL,
entityOverrides = NULL,
evaluationStrategy = NULL,
name,
project,
tags = NULL,
variations
)
Arguments
defaultVariation |
The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature. This variation must also be listed in the If you omit |
description |
An optional description of the feature. |
entityOverrides |
Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served. This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override. |
evaluationStrategy |
Specify |
name |
[required] The name for the new feature. |
project |
[required] The name or ARN of the project that is to contain the new feature. |
tags |
Assigns one or more tags (key-value pairs) to the feature. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with a feature. For more information, see Tagging Amazon Web Services resources. |
variations |
[required] An array of structures that contain the configuration of the feature's different variations. |
Creates a launch of a given feature
Description
Creates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_create_launch/ for full documentation.
Usage
cloudwatchevidently_create_launch(
description = NULL,
groups,
metricMonitors = NULL,
name,
project,
randomizationSalt = NULL,
scheduledSplitsConfig = NULL,
tags = NULL
)
Arguments
description |
An optional description for the launch. |
groups |
[required] An array of structures that contains the feature and variations that are to be used for the launch. |
metricMonitors |
An array of structures that define the metrics that will be used to monitor the launch performance. |
name |
[required] The name for the new launch. |
project |
[required] The name or ARN of the project that you want to create the launch in. |
randomizationSalt |
When Evidently assigns a particular user session to a launch, it must
use a randomization ID to determine which variation the user session is
served. This randomization ID is a combination of the entity ID and
|
scheduledSplitsConfig |
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. |
tags |
Assigns one or more tags (key-value pairs) to the launch. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with a launch. For more information, see Tagging Amazon Web Services resources. |
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments
Description
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_create_project/ for full documentation.
Usage
cloudwatchevidently_create_project(
appConfigResource = NULL,
dataDelivery = NULL,
description = NULL,
name,
tags = NULL
)
Arguments
appConfigResource |
Use this parameter if the project will use client-side evaluation
powered by AppConfig. Client-side evaluation allows your application to
assign variations to user sessions locally instead of by calling the
This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation. To create a project that uses client-side evaluation, you must have the
|
dataDelivery |
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. |
description |
An optional description of the project. |
name |
[required] The name for the project. |
tags |
Assigns one or more tags (key-value pairs) to the project. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with a project. For more information, see Tagging Amazon Web Services resources. |
Use this operation to define a segment of your audience
Description
Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_create_segment/ for full documentation.
Usage
cloudwatchevidently_create_segment(
description = NULL,
name,
pattern,
tags = NULL
)
Arguments
description |
An optional description for this segment. |
name |
[required] A name for the segment. |
pattern |
[required] The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax. |
tags |
Assigns one or more tags (key-value pairs) to the segment. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with a segment. For more information, see Tagging Amazon Web Services resources. |
Deletes an Evidently experiment
Description
Deletes an Evidently experiment. The feature used for the experiment is not deleted.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_delete_experiment/ for full documentation.
Usage
cloudwatchevidently_delete_experiment(experiment, project)
Arguments
experiment |
[required] The name of the experiment to delete. |
project |
[required] The name or ARN of the project that contains the experiment to delete. |
Deletes an Evidently feature
Description
Deletes an Evidently feature.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_delete_feature/ for full documentation.
Usage
cloudwatchevidently_delete_feature(feature, project)
Arguments
feature |
[required] The name of the feature to delete. |
project |
[required] The name or ARN of the project that contains the feature to delete. |
Deletes an Evidently launch
Description
Deletes an Evidently launch. The feature used for the launch is not deleted.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_delete_launch/ for full documentation.
Usage
cloudwatchevidently_delete_launch(launch, project)
Arguments
launch |
[required] The name of the launch to delete. |
project |
[required] The name or ARN of the project that contains the launch to delete. |
Deletes an Evidently project
Description
Deletes an Evidently project. Before you can delete a project, you must delete all the features that the project contains. To delete a feature, use delete_feature.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_delete_project/ for full documentation.
Usage
cloudwatchevidently_delete_project(project)
Arguments
project |
[required] The name or ARN of the project to delete. |
Deletes a segment
Description
Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_delete_segment/ for full documentation.
Usage
cloudwatchevidently_delete_segment(segment)
Arguments
segment |
[required] Specifies the segment to delete. |
This operation assigns a feature variation to one given user session
Description
This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_evaluate_feature/ for full documentation.
Usage
cloudwatchevidently_evaluate_feature(
entityId,
evaluationContext = NULL,
feature,
project
)
Arguments
entityId |
[required] An internal ID that represents a unique user of the application. This
|
evaluationContext |
A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience. If you include this parameter, the value must be a JSON object. A JSON array is not supported. |
feature |
[required] The name of the feature being evaluated. |
project |
[required] The name or ARN of the project that contains this feature. |
Returns the details about one experiment
Description
Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use list_experiments.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_get_experiment/ for full documentation.
Usage
cloudwatchevidently_get_experiment(experiment, project)
Arguments
experiment |
[required] The name of the experiment that you want to see the details of. |
project |
[required] The name or ARN of the project that contains the experiment. |
Retrieves the results of a running or completed experiment
Description
Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_get_experiment_results/ for full documentation.
Usage
cloudwatchevidently_get_experiment_results(
baseStat = NULL,
endTime = NULL,
experiment,
metricNames,
period = NULL,
project,
reportNames = NULL,
resultStats = NULL,
startTime = NULL,
treatmentNames
)
Arguments
baseStat |
The statistic used to calculate experiment results. Currently the only
valid value is |
endTime |
The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time. |
experiment |
[required] The name of the experiment to retrieve the results of. |
metricNames |
[required] The names of the experiment metrics that you want to see the results of. |
period |
In seconds, the amount of time to aggregate results together. |
project |
[required] The name or ARN of the project that contains the experiment that you want to see the results of. |
reportNames |
The names of the report types that you want to see. Currently,
|
resultStats |
The statistics that you want to see in the returned results.
|
startTime |
The date and time that the experiment started. |
treatmentNames |
[required] The names of the experiment treatments that you want to see the results for. |
Returns the details about one feature
Description
Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use list_features.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_get_feature/ for full documentation.
Usage
cloudwatchevidently_get_feature(feature, project)
Arguments
feature |
[required] The name of the feature that you want to retrieve information for. |
project |
[required] The name or ARN of the project that contains the feature. |
Returns the details about one launch
Description
Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use list_launches.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_get_launch/ for full documentation.
Usage
cloudwatchevidently_get_launch(launch, project)
Arguments
launch |
[required] The name of the launch that you want to see the details of. |
project |
[required] The name or ARN of the project that contains the launch. |
Returns the details about one launch
Description
Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use list_projects.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_get_project/ for full documentation.
Usage
cloudwatchevidently_get_project(project)
Arguments
project |
[required] The name or ARN of the project that you want to see the details of. |
Returns information about the specified segment
Description
Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_get_segment/ for full documentation.
Usage
cloudwatchevidently_get_segment(segment)
Arguments
segment |
[required] The ARN of the segment to return information for. |
Returns configuration details about all the experiments in the specified project
Description
Returns configuration details about all the experiments in the specified project.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_experiments/ for full documentation.
Usage
cloudwatchevidently_list_experiments(
maxResults = NULL,
nextToken = NULL,
project,
status = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
project |
[required] The name or ARN of the project to return the experiment list from. |
status |
Use this optional parameter to limit the returned results to only the experiments with the status that you specify here. |
Returns configuration details about all the features in the specified project
Description
Returns configuration details about all the features in the specified project.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_features/ for full documentation.
Usage
cloudwatchevidently_list_features(maxResults = NULL, nextToken = NULL, project)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
project |
[required] The name or ARN of the project to return the feature list from. |
Returns configuration details about all the launches in the specified project
Description
Returns configuration details about all the launches in the specified project.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_launches/ for full documentation.
Usage
cloudwatchevidently_list_launches(
maxResults = NULL,
nextToken = NULL,
project,
status = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
project |
[required] The name or ARN of the project to return the launch list from. |
status |
Use this optional parameter to limit the returned results to only the launches with the status that you specify here. |
Returns configuration details about all the projects in the current Region in your account
Description
Returns configuration details about all the projects in the current Region in your account.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_projects/ for full documentation.
Usage
cloudwatchevidently_list_projects(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
Use this operation to find which experiments or launches are using a specified segment
Description
Use this operation to find which experiments or launches are using a specified segment.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_segment_references/ for full documentation.
Usage
cloudwatchevidently_list_segment_references(
maxResults = NULL,
nextToken = NULL,
segment,
type
)
Arguments
maxResults |
The maximum number of results to include in the response. If you omit this, the default of 50 is used. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
segment |
[required] The ARN of the segment that you want to view information for. |
type |
[required] Specifies whether to return information about launches or experiments that use this segment. |
Returns a list of audience segments that you have created in your account in this Region
Description
Returns a list of audience segments that you have created in your account in this Region.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_segments/ for full documentation.
Usage
cloudwatchevidently_list_segments(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results to include in the response. If you omit this, the default of 50 is used. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
Displays the tags associated with an Evidently resource
Description
Displays the tags associated with an Evidently resource.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_list_tags_for_resource/ for full documentation.
Usage
cloudwatchevidently_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The ARN of the resource that you want to see the tags of. |
Sends performance events to Evidently
Description
Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_put_project_events/ for full documentation.
Usage
cloudwatchevidently_put_project_events(events, project)
Arguments
events |
[required] An array of event structures that contain the performance data that is being sent to Evidently. |
project |
[required] The name or ARN of the project to write the events to. |
Starts an existing experiment
Description
Starts an existing experiment. To create an experiment, use create_experiment.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_start_experiment/ for full documentation.
Usage
cloudwatchevidently_start_experiment(analysisCompleteTime, experiment, project)
Arguments
analysisCompleteTime |
[required] The date and time to end the experiment. This must be no more than 30 days after the experiment starts. |
experiment |
[required] The name of the experiment to start. |
project |
[required] The name or ARN of the project that contains the experiment to start. |
Starts an existing launch
Description
Starts an existing launch. To create a launch, use create_launch.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_start_launch/ for full documentation.
Usage
cloudwatchevidently_start_launch(launch, project)
Arguments
launch |
[required] The name of the launch to start. |
project |
[required] The name or ARN of the project that contains the launch to start. |
Stops an experiment that is currently running
Description
Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_stop_experiment/ for full documentation.
Usage
cloudwatchevidently_stop_experiment(
desiredState = NULL,
experiment,
project,
reason = NULL
)
Arguments
desiredState |
Specify whether the experiment is to be considered |
experiment |
[required] The name of the experiment to stop. |
project |
[required] The name or ARN of the project that contains the experiment to stop. |
reason |
A string that describes why you are stopping the experiment. |
Stops a launch that is currently running
Description
Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. Also, it will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch will instead be available to the feature's experiment, if there is one. Otherwise, all traffic will be served the default variation after the launch is stopped.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_stop_launch/ for full documentation.
Usage
cloudwatchevidently_stop_launch(
desiredState = NULL,
launch,
project,
reason = NULL
)
Arguments
desiredState |
Specify whether to consider the launch as |
launch |
[required] The name of the launch to stop. |
project |
[required] The name or ARN of the project that contains the launch that you want to stop. |
reason |
A string that describes why you are stopping the launch. |
Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource
Description
Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, features, launches, and experiments can be tagged.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_tag_resource/ for full documentation.
Usage
cloudwatchevidently_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The ARN of the CloudWatch Evidently resource that you're adding tags to. |
tags |
[required] The list of key-value pairs to associate with the resource. |
Use this operation to test a rules pattern that you plan to use to create an audience segment
Description
Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see create_segment.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_test_segment_pattern/ for full documentation.
Usage
cloudwatchevidently_test_segment_pattern(pattern, payload)
Arguments
pattern |
[required] The pattern to test. |
payload |
[required] A sample |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_untag_resource/ for full documentation.
Usage
cloudwatchevidently_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The ARN of the CloudWatch Evidently resource that you're removing tags from. |
tagKeys |
[required] The list of tag keys to remove from the resource. |
Updates an Evidently experiment
Description
Updates an Evidently experiment.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_update_experiment/ for full documentation.
Usage
cloudwatchevidently_update_experiment(
description = NULL,
experiment,
metricGoals = NULL,
onlineAbConfig = NULL,
project,
randomizationSalt = NULL,
removeSegment = NULL,
samplingRate = NULL,
segment = NULL,
treatments = NULL
)
Arguments
description |
An optional description of the experiment. |
experiment |
[required] The name of the experiment to update. |
metricGoals |
An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. |
onlineAbConfig |
A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation. |
project |
[required] The name or ARN of the project that contains the experiment that you want to update. |
randomizationSalt |
When Evidently assigns a particular user session to an experiment, it
must use a randomization ID to determine which variation the user
session is served. This randomization ID is a combination of the entity
ID and |
removeSegment |
Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running. |
samplingRate |
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature. This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience. |
segment |
Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running. |
treatments |
An array of structures that define the variations being tested in the experiment. |
Updates an existing feature
Description
Updates an existing feature.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_update_feature/ for full documentation.
Usage
cloudwatchevidently_update_feature(
addOrUpdateVariations = NULL,
defaultVariation = NULL,
description = NULL,
entityOverrides = NULL,
evaluationStrategy = NULL,
feature,
project,
removeVariations = NULL
)
Arguments
addOrUpdateVariations |
To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation. |
defaultVariation |
The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature. |
description |
An optional description of the feature. |
entityOverrides |
Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served. This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override. |
evaluationStrategy |
Specify |
feature |
[required] The name of the feature to be updated. |
project |
[required] The name or ARN of the project that contains the feature to be updated. |
removeVariations |
Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error. This operation fails if you try to remove a variation that is part of an ongoing launch or experiment. |
Updates a launch of a given feature
Description
Updates a launch of a given feature.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_update_launch/ for full documentation.
Usage
cloudwatchevidently_update_launch(
description = NULL,
groups = NULL,
launch,
metricMonitors = NULL,
project,
randomizationSalt = NULL,
scheduledSplitsConfig = NULL
)
Arguments
description |
An optional description for the launch. |
groups |
An array of structures that contains the feature and variations that are to be used for the launch. |
launch |
[required] The name of the launch that is to be updated. |
metricMonitors |
An array of structures that define the metrics that will be used to monitor the launch performance. |
project |
[required] The name or ARN of the project that contains the launch that you want to update. |
randomizationSalt |
When Evidently assigns a particular user session to a launch, it must
use a randomization ID to determine which variation the user session is
served. This randomization ID is a combination of the entity ID and
|
scheduledSplitsConfig |
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. |
Updates the description of an existing project
Description
Updates the description of an existing project.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_update_project/ for full documentation.
Usage
cloudwatchevidently_update_project(
appConfigResource = NULL,
description = NULL,
project
)
Arguments
appConfigResource |
Use this parameter if the project will use client-side evaluation
powered by AppConfig. Client-side evaluation allows your application to
assign variations to user sessions locally instead of by calling the
This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation. |
description |
An optional description of the project. |
project |
[required] The name or ARN of the project to update. |
Updates the data storage options for this project
Description
Updates the data storage options for this project. If you store evaluation events, you an keep them and analyze them on your own. If you choose not to store evaluation events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
See https://www.paws-r-sdk.com/docs/cloudwatchevidently_update_project_data_delivery/ for full documentation.
Usage
cloudwatchevidently_update_project_data_delivery(
cloudWatchLogs = NULL,
project,
s3Destination = NULL
)
Arguments
cloudWatchLogs |
A structure containing the CloudWatch Logs log group where you want to store evaluation events. |
project |
[required] The name or ARN of the project that you want to modify the data storage options for. |
s3Destination |
A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events. |
Amazon CloudWatch Internet Monitor
Description
Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end users. It can reduce the time it takes for you to diagnose internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global networking footprint to calculate a baseline of performance and availability for internet traffic. This is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements as a baseline, Internet Monitor raises awareness for you when there are significant problems for your end users in the different geographic locations where your application runs.
Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, to easily support using CloudWatch tools with health information for geographies and networks specific to your application. Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.
To use Internet Monitor, you create a monitor and associate your application's resources with it - VPCs, NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor can determine where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and ASNs (typically, internet service providers or ISPs) that communicate with your application.
For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
Usage
cloudwatchinternetmonitor(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatchinternetmonitor(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_monitor | Creates a monitor in Amazon CloudWatch Internet Monitor |
| delete_monitor | Deletes a monitor in Amazon CloudWatch Internet Monitor |
| get_health_event | Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor |
| get_internet_event | Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event |
| get_monitor | Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name |
| get_query_results | Return the data for a query with the Amazon CloudWatch Internet Monitor query interface |
| get_query_status | Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor |
| list_health_events | Lists all health events for a monitor in Amazon CloudWatch Internet Monitor |
| list_internet_events | Lists internet events that cause performance or availability issues for client locations |
| list_monitors | Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor |
| list_tags_for_resource | Lists the tags for a resource |
| start_query | Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface |
| stop_query | Stop a query that is progress for a specific monitor |
| tag_resource | Adds a tag to a resource |
| untag_resource | Removes a tag from a resource |
| update_monitor | Updates a monitor |
Examples
## Not run:
svc <- cloudwatchinternetmonitor()
svc$create_monitor(
Foo = 123
)
## End(Not run)
Creates a monitor in Amazon CloudWatch Internet Monitor
Description
Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_create_monitor/ for full documentation.
Usage
cloudwatchinternetmonitor_create_monitor(
MonitorName,
Resources = NULL,
ClientToken = NULL,
Tags = NULL,
MaxCityNetworksToMonitor = NULL,
InternetMeasurementsLogDelivery = NULL,
TrafficPercentageToMonitor = NULL,
HealthEventsConfig = NULL
)
Arguments
MonitorName |
[required] The name of the monitor. |
Resources |
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories. You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources. If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity. |
ClientToken |
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests. |
Tags |
The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor. |
MaxCityNetworksToMonitor |
The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs. To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. |
InternetMeasurementsLogDelivery |
Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs. |
TrafficPercentageToMonitor |
The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set. To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. |
HealthEventsConfig |
Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met. If you don't set a health event threshold, the default value is 95%. For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide. |
Deletes a monitor in Amazon CloudWatch Internet Monitor
Description
Deletes a monitor in Amazon CloudWatch Internet Monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_delete_monitor/ for full documentation.
Usage
cloudwatchinternetmonitor_delete_monitor(MonitorName)
Arguments
MonitorName |
[required] The name of the monitor to delete. |
Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor
Description
Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_get_health_event/ for full documentation.
Usage
cloudwatchinternetmonitor_get_health_event(
MonitorName,
EventId,
LinkedAccountId = NULL
)
Arguments
MonitorName |
[required] The name of the monitor. |
EventId |
[required] The internally-generated identifier of a health event. Because |
LinkedAccountId |
The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide. |
Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event
Description
Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_get_internet_event/ for full documentation.
Usage
cloudwatchinternetmonitor_get_internet_event(EventId)
Arguments
EventId |
[required] The |
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name
Description
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_get_monitor/ for full documentation.
Usage
cloudwatchinternetmonitor_get_monitor(MonitorName, LinkedAccountId = NULL)
Arguments
MonitorName |
[required] The name of the monitor. |
LinkedAccountId |
The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide. |
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface
Description
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId and a monitor name.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_get_query_results/ for full documentation.
Usage
cloudwatchinternetmonitor_get_query_results(
MonitorName,
QueryId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
MonitorName |
[required] The name of the monitor to return data for. |
QueryId |
[required] The ID of the query that you want to return data results for. A
|
NextToken |
The token for the next set of results. You receive this token from a previous call. |
MaxResults |
The number of query results that you want to return with this call. |
Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor
Description
Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_get_query_status/ for full documentation.
Usage
cloudwatchinternetmonitor_get_query_status(MonitorName, QueryId)
Arguments
MonitorName |
[required] The name of the monitor. |
QueryId |
[required] The ID of the query that you want to return the status for. A |
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor
Description
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_list_health_events/ for full documentation.
Usage
cloudwatchinternetmonitor_list_health_events(
MonitorName,
StartTime = NULL,
EndTime = NULL,
NextToken = NULL,
MaxResults = NULL,
EventStatus = NULL,
LinkedAccountId = NULL
)
Arguments
MonitorName |
[required] The name of the monitor. |
StartTime |
The time when a health event started. |
EndTime |
The time when a health event ended. If the health event is still ongoing, then the end time is not set. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
MaxResults |
The number of health event objects that you want to return with this call. |
EventStatus |
The status of a health event. |
LinkedAccountId |
The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide. |
Lists internet events that cause performance or availability issues for client locations
Description
Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_list_internet_events/ for full documentation.
Usage
cloudwatchinternetmonitor_list_internet_events(
NextToken = NULL,
MaxResults = NULL,
StartTime = NULL,
EndTime = NULL,
EventStatus = NULL,
EventType = NULL
)
Arguments
NextToken |
The token for the next set of results. You receive this token from a previous call. |
MaxResults |
The number of query results that you want to return with this call. |
StartTime |
The start time of the time window that you want to get a list of internet events for. |
EndTime |
The end time of the time window that you want to get a list of internet events for. |
EventStatus |
The status of an internet event. |
EventType |
The type of network impairment. |
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor
Description
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_list_monitors/ for full documentation.
Usage
cloudwatchinternetmonitor_list_monitors(
NextToken = NULL,
MaxResults = NULL,
MonitorStatus = NULL,
IncludeLinkedAccounts = NULL
)
Arguments
NextToken |
The token for the next set of results. You receive this token from a previous call. |
MaxResults |
The number of monitor objects that you want to return with this call. |
MonitorStatus |
The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself. For information about the statuses for a monitor, see Monitor. |
IncludeLinkedAccounts |
A boolean option that you can set to |
Lists the tags for a resource
Description
Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_list_tags_for_resource/ for full documentation.
Usage
cloudwatchinternetmonitor_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for a resource. |
Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface
Description
Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_start_query/ for full documentation.
Usage
cloudwatchinternetmonitor_start_query(
MonitorName,
StartTime,
EndTime,
QueryType,
FilterParameters = NULL,
LinkedAccountId = NULL
)
Arguments
MonitorName |
[required] The name of the monitor to query. |
StartTime |
[required] The timestamp that is the beginning of the period that you want to retrieve data for with your query. |
EndTime |
[required] The timestamp that is the end of the period that you want to retrieve data for with your query. |
QueryType |
[required] The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:
For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide. |
FilterParameters |
The For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide. |
LinkedAccountId |
The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide. |
Stop a query that is progress for a specific monitor
Description
Stop a query that is progress for a specific monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_stop_query/ for full documentation.
Usage
cloudwatchinternetmonitor_stop_query(MonitorName, QueryId)
Arguments
MonitorName |
[required] The name of the monitor. |
QueryId |
[required] The ID of the query that you want to stop. A |
Adds a tag to a resource
Description
Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_tag_resource/ for full documentation.
Usage
cloudwatchinternetmonitor_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. |
Tags |
[required] Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor. |
Removes a tag from a resource
Description
Removes a tag from a resource.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_untag_resource/ for full documentation.
Usage
cloudwatchinternetmonitor_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for a tag you remove a resource from. |
TagKeys |
[required] Tag keys that you remove from a resource. |
Updates a monitor
Description
Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchinternetmonitor_update_monitor/ for full documentation.
Usage
cloudwatchinternetmonitor_update_monitor(
MonitorName,
ResourcesToAdd = NULL,
ResourcesToRemove = NULL,
Status = NULL,
ClientToken = NULL,
MaxCityNetworksToMonitor = NULL,
InternetMeasurementsLogDelivery = NULL,
TrafficPercentageToMonitor = NULL,
HealthEventsConfig = NULL
)
Arguments
MonitorName |
[required] The name of the monitor. |
ResourcesToAdd |
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories. You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources. If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity. |
ResourcesToRemove |
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
Status |
The status for a monitor. The accepted values for |
ClientToken |
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests. |
MaxCityNetworksToMonitor |
The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs. |
InternetMeasurementsLogDelivery |
Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs. |
TrafficPercentageToMonitor |
The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set. To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. |
HealthEventsConfig |
The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users. For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide. |
Amazon CloudWatch Logs
Description
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
-
Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException"). You can also count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
-
Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
-
Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Usage
cloudwatchlogs(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatchlogs(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_kms_key | Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account |
| cancel_export_task | Cancels the specified export task |
| create_delivery | Creates a delivery |
| create_export_task | Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket |
| create_log_anomaly_detector | Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs |
| create_log_group | Creates a log group with the specified name |
| create_log_stream | Creates a log stream for the specified log group |
| delete_account_policy | Deletes a CloudWatch Logs account policy |
| delete_data_protection_policy | Deletes the data protection policy from the specified log group |
| delete_delivery | Deletes a delivery |
| delete_delivery_destination | Deletes a delivery destination |
| delete_delivery_destination_policy | Deletes a delivery destination policy |
| delete_delivery_source | Deletes a delivery source |
| delete_destination | Deletes the specified destination, and eventually disables all the subscription filters that publish to it |
| delete_index_policy | Deletes a log-group level field index policy that was applied to a single log group |
| delete_integration | Deletes the integration between CloudWatch Logs and OpenSearch Service |
| delete_log_anomaly_detector | Deletes the specified CloudWatch Logs anomaly detector |
| delete_log_group | Deletes the specified log group and permanently deletes all the archived log events associated with the log group |
| delete_log_stream | Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream |
| delete_metric_filter | Deletes the specified metric filter |
| delete_query_definition | Deletes a saved CloudWatch Logs Insights query definition |
| delete_resource_policy | Deletes a resource policy from this account |
| delete_retention_policy | Deletes the specified retention policy |
| delete_subscription_filter | Deletes the specified subscription filter |
| delete_transformer | Deletes the log transformer for the specified log group |
| describe_account_policies | Returns a list of all CloudWatch Logs account policies in the account |
| describe_configuration_templates | Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries |
| describe_deliveries | Retrieves a list of the deliveries that have been created in the account |
| describe_delivery_destinations | Retrieves a list of the delivery destinations that have been created in the account |
| describe_delivery_sources | Retrieves a list of the delivery sources that have been created in the account |
| describe_destinations | Lists all your destinations |
| describe_export_tasks | Lists the specified export tasks |
| describe_field_indexes | Returns a list of field indexes listed in the field index policies of one or more log groups |
| describe_index_policies | Returns the field index policies of one or more log groups |
| describe_log_groups | Lists the specified log groups |
| describe_log_streams | Lists the log streams for the specified log group |
| describe_metric_filters | Lists the specified metric filters |
| describe_queries | Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account |
| describe_query_definitions | This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions |
| describe_resource_policies | Lists the resource policies in this account |
| describe_subscription_filters | Lists the subscription filters for the specified log group |
| disassociate_kms_key | Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account |
| filter_log_events | Lists log events from the specified log group |
| get_data_protection_policy | Returns information about a log group data protection policy |
| get_delivery | Returns complete information about one logical delivery |
| get_delivery_destination | Retrieves complete information about one delivery destination |
| get_delivery_destination_policy | Retrieves the delivery destination policy assigned to the delivery destination that you specify |
| get_delivery_source | Retrieves complete information about one delivery source |
| get_integration | Returns information about one integration between CloudWatch Logs and OpenSearch Service |
| get_log_anomaly_detector | Retrieves information about the log anomaly detector that you specify |
| get_log_events | Lists log events from the specified log stream |
| get_log_group_fields | Returns a list of the fields that are included in log events in the specified log group |
| get_log_record | Retrieves all of the fields and values of a single log event |
| get_query_results | Returns the results from the specified query |
| get_transformer | Returns the information about the log transformer associated with this log group |
| list_anomalies | Returns a list of anomalies that log anomaly detectors have found |
| list_integrations | Returns a list of integrations between CloudWatch Logs and other services in this account |
| list_log_anomaly_detectors | Retrieves a list of the log anomaly detectors in the account |
| list_log_groups_for_query | Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query |
| list_tags_for_resource | Displays the tags associated with a CloudWatch Logs resource |
| list_tags_log_group | The ListTagsLogGroup operation is on the path to deprecation |
| put_account_policy | Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account |
| put_data_protection_policy | Creates a data protection policy for the specified log group |
| put_delivery_destination | Creates or updates a logical delivery destination |
| put_delivery_destination_policy | Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account |
| put_delivery_source | Creates or updates a logical delivery source |
| put_destination | Creates or updates a destination |
| put_destination_policy | Creates or updates an access policy associated with an existing destination |
| put_index_policy | Creates or updates a field index policy for the specified log group |
| put_integration | Creates an integration between CloudWatch Logs and another service in this account |
| put_log_events | Uploads a batch of log events to the specified log stream |
| put_metric_filter | Creates or updates a metric filter and associates it with the specified log group |
| put_query_definition | Creates or updates a query definition for CloudWatch Logs Insights |
| put_resource_policy | Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53 |
| put_retention_policy | Sets the retention of the specified log group |
| put_subscription_filter | Creates or updates a subscription filter and associates it with the specified log group |
| put_transformer | Creates or updates a log transformer for a single log group |
| start_live_tail | Starts a Live Tail streaming session for one or more log groups |
| start_query | Starts a query of one or more log groups using CloudWatch Logs Insights |
| stop_query | Stops a CloudWatch Logs Insights query that is in progress |
| tag_log_group | The TagLogGroup operation is on the path to deprecation |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource |
| test_metric_filter | Tests the filter pattern of a metric filter against a sample of log event messages |
| test_transformer | Use this operation to test a log transformer |
| untag_log_group | The UntagLogGroup operation is on the path to deprecation |
| untag_resource | Removes one or more tags from the specified resource |
| update_anomaly | Use this operation to suppress anomaly detection for a specified anomaly or pattern |
| update_delivery_configuration | Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs |
| update_log_anomaly_detector | Updates an existing log anomaly detector |
Examples
## Not run:
svc <- cloudwatchlogs()
svc$associate_kms_key(
Foo = 123
)
## End(Not run)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account
Description
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_associate_kms_key/ for full documentation.
Usage
cloudwatchlogs_associate_kms_key(
logGroupName = NULL,
kmsKeyId,
resourceIdentifier = NULL
)
Arguments
logGroupName |
The name of the log group. In your |
kmsKeyId |
[required] The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys. |
resourceIdentifier |
Specifies the target for this operation. You must specify one of the following:
In your |
Cancels the specified export task
Description
Cancels the specified export task.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_cancel_export_task/ for full documentation.
Usage
cloudwatchlogs_cancel_export_task(taskId)
Arguments
taskId |
[required] The ID of the export task. |
Creates a delivery
Description
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_create_delivery/ for full documentation.
Usage
cloudwatchlogs_create_delivery(
deliverySourceName,
deliveryDestinationArn,
recordFields = NULL,
fieldDelimiter = NULL,
s3DeliveryConfiguration = NULL,
tags = NULL
)
Arguments
deliverySourceName |
[required] The name of the delivery source to use for this delivery. |
deliveryDestinationArn |
[required] The ARN of the delivery destination to use for this delivery. |
recordFields |
The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list. |
fieldDelimiter |
The field delimiter to use between record fields when the final output
format of a delivery is in |
s3DeliveryConfiguration |
This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket. |
tags |
An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources |
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket
Description
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a create_export_task operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_create_export_task/ for full documentation.
Usage
cloudwatchlogs_create_export_task(
taskName = NULL,
logGroupName,
logStreamNamePrefix = NULL,
from,
to,
destination,
destinationPrefix = NULL
)
Arguments
taskName |
The name of the export task. |
logGroupName |
[required] The name of the log group. |
logStreamNamePrefix |
Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied. |
from |
[required] The start time of the range for the request, expressed as the number of
milliseconds after |
to |
[required] The end time of the range for the request, expressed as the number of
milliseconds after You must specify a time that is not earlier than when this log group was created. |
destination |
[required] The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region. |
destinationPrefix |
The prefix used as the start of the key for every object exported. If
you don't specify a value, the default is The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to 1,024 bytes. |
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs
Description
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_create_log_anomaly_detector/ for full documentation.
Usage
cloudwatchlogs_create_log_anomaly_detector(
logGroupArnList,
detectorName = NULL,
evaluationFrequency = NULL,
filterPattern = NULL,
kmsKeyId = NULL,
anomalyVisibilityTime = NULL,
tags = NULL
)
Arguments
logGroupArnList |
[required] An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN. |
detectorName |
A name for this anomaly detector. |
evaluationFrequency |
Specifies how often the anomaly detector is to run and look for
anomalies. Set this value according to the frequency that the log group
receives new logs. For example, if the log group receives new log events
every 10 minutes, then 15 minutes might be a good setting for
|
filterPattern |
You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see Filter and Pattern Syntax. |
kmsKeyId |
Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds. For more information about using a KMS key and to see the required IAM policy, see Use a KMS key with an anomaly detector. |
anomalyVisibilityTime |
The number of days to have visibility on an anomaly. After this time
period has elapsed for an anomaly, it will be automatically baselined
and the anomaly detector will treat new occurrences of a similar anomaly
as normal. Therefore, if you do not correct the cause of an anomaly
during the time period specified in |
tags |
An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources |
Creates a log group with the specified name
Description
Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_create_log_group/ for full documentation.
Usage
cloudwatchlogs_create_log_group(
logGroupName,
kmsKeyId = NULL,
tags = NULL,
logGroupClass = NULL
)
Arguments
logGroupName |
[required] A name for the log group. |
kmsKeyId |
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names. |
tags |
The key-value pairs to use for the tags. You can grant users access to certain log groups while preventing them
from accessing other log groups. To do so, tag your groups and use IAM
policies that refer to those tags. To assign tags when you create a log
group, you must have either the |
logGroupClass |
Use this parameter to specify the log group class for this log group. There are two classes:
If you omit this parameter, the default of The value of For details about the features supported by each class, see Log classes |
Creates a log stream for the specified log group
Description
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_create_log_stream/ for full documentation.
Usage
cloudwatchlogs_create_log_stream(logGroupName, logStreamName)
Arguments
logGroupName |
[required] The name of the log group. |
logStreamName |
[required] The name of the log stream. |
Deletes a CloudWatch Logs account policy
Description
Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_account_policy/ for full documentation.
Usage
cloudwatchlogs_delete_account_policy(policyName, policyType)
Arguments
policyName |
[required] The name of the policy to delete. |
policyType |
[required] The type of policy to delete. |
Deletes the data protection policy from the specified log group
Description
Deletes the data protection policy from the specified log group.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_data_protection_policy/ for full documentation.
Usage
cloudwatchlogs_delete_data_protection_policy(logGroupIdentifier)
Arguments
logGroupIdentifier |
[required] The name or ARN of the log group that you want to delete the data protection policy for. |
Deletes a delivery
Description
Deletes a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_delivery/ for full documentation.
Usage
cloudwatchlogs_delete_delivery(id)
Arguments
id |
[required] The unique ID of the delivery to delete. You can find the ID of a
delivery with the
|
Deletes a delivery destination
Description
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_delivery_destination/ for full documentation.
Usage
cloudwatchlogs_delete_delivery_destination(name)
Arguments
name |
[required] The name of the delivery destination that you want to delete. You can
find a list of delivery destionation names by using the
|
Deletes a delivery destination policy
Description
Deletes a delivery destination policy. For more information about these policies, see put_delivery_destination_policy.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_delivery_destination_policy/ for full documentation.
Usage
cloudwatchlogs_delete_delivery_destination_policy(deliveryDestinationName)
Arguments
deliveryDestinationName |
[required] The name of the delivery destination that you want to delete the policy for. |
Deletes a delivery source
Description
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_delivery_source/ for full documentation.
Usage
cloudwatchlogs_delete_delivery_source(name)
Arguments
name |
[required] The name of the delivery source that you want to delete. |
Deletes the specified destination, and eventually disables all the subscription filters that publish to it
Description
Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_destination/ for full documentation.
Usage
cloudwatchlogs_delete_destination(destinationName)
Arguments
destinationName |
[required] The name of the destination. |
Deletes a log-group level field index policy that was applied to a single log group
Description
Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_index_policy/ for full documentation.
Usage
cloudwatchlogs_delete_index_policy(logGroupIdentifier)
Arguments
logGroupIdentifier |
[required] The log group to delete the index policy for. You can specify either the name or the ARN of the log group. |
Deletes the integration between CloudWatch Logs and OpenSearch Service
Description
Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by setting force to true, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_integration/ for full documentation.
Usage
cloudwatchlogs_delete_integration(integrationName, force = NULL)
Arguments
integrationName |
[required] The name of the integration to delete. To find the name of your
integration, use
|
force |
Specify The default is |
Deletes the specified CloudWatch Logs anomaly detector
Description
Deletes the specified CloudWatch Logs anomaly detector.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_log_anomaly_detector/ for full documentation.
Usage
cloudwatchlogs_delete_log_anomaly_detector(anomalyDetectorArn)
Arguments
anomalyDetectorArn |
[required] The ARN of the anomaly detector to delete. You can find the ARNs of log
anomaly detectors in your account by using the
|
Deletes the specified log group and permanently deletes all the archived log events associated with the log group
Description
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_log_group/ for full documentation.
Usage
cloudwatchlogs_delete_log_group(logGroupName)
Arguments
logGroupName |
[required] The name of the log group. |
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream
Description
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_log_stream/ for full documentation.
Usage
cloudwatchlogs_delete_log_stream(logGroupName, logStreamName)
Arguments
logGroupName |
[required] The name of the log group. |
logStreamName |
[required] The name of the log stream. |
Deletes the specified metric filter
Description
Deletes the specified metric filter.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_metric_filter/ for full documentation.
Usage
cloudwatchlogs_delete_metric_filter(logGroupName, filterName)
Arguments
logGroupName |
[required] The name of the log group. |
filterName |
[required] The name of the metric filter. |
Deletes a saved CloudWatch Logs Insights query definition
Description
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_query_definition/ for full documentation.
Usage
cloudwatchlogs_delete_query_definition(queryDefinitionId)
Arguments
queryDefinitionId |
[required] The ID of the query definition that you want to delete. You can use
|
Deletes a resource policy from this account
Description
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_resource_policy/ for full documentation.
Usage
cloudwatchlogs_delete_resource_policy(policyName = NULL)
Arguments
policyName |
The name of the policy to be revoked. This parameter is required. |
Deletes the specified retention policy
Description
Deletes the specified retention policy.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_retention_policy/ for full documentation.
Usage
cloudwatchlogs_delete_retention_policy(logGroupName)
Arguments
logGroupName |
[required] The name of the log group. |
Deletes the specified subscription filter
Description
Deletes the specified subscription filter.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_subscription_filter/ for full documentation.
Usage
cloudwatchlogs_delete_subscription_filter(logGroupName, filterName)
Arguments
logGroupName |
[required] The name of the log group. |
filterName |
[required] The name of the subscription filter. |
Deletes the log transformer for the specified log group
Description
Deletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_delete_transformer/ for full documentation.
Usage
cloudwatchlogs_delete_transformer(logGroupIdentifier)
Arguments
logGroupIdentifier |
[required] Specify either the name or ARN of the log group to delete the transformer for. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. |
Returns a list of all CloudWatch Logs account policies in the account
Description
Returns a list of all CloudWatch Logs account policies in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_account_policies/ for full documentation.
Usage
cloudwatchlogs_describe_account_policies(
policyType,
policyName = NULL,
accountIdentifiers = NULL,
nextToken = NULL
)
Arguments
policyType |
[required] Use this parameter to limit the returned policies to only the policies that match the policy type that you specify. |
policyName |
Use this parameter to limit the returned policies to only the policy with the name that you specify. |
accountIdentifiers |
If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter. If you omit this parameter, only the policy in the current account is returned. |
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries
Description
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see create_delivery.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_configuration_templates/ for full documentation.
Usage
cloudwatchlogs_describe_configuration_templates(
service = NULL,
logTypes = NULL,
resourceTypes = NULL,
deliveryDestinationTypes = NULL,
nextToken = NULL,
limit = NULL
)
Arguments
service |
Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here. |
logTypes |
Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here. |
resourceTypes |
Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here. |
deliveryDestinationTypes |
Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here. |
nextToken |
|
limit |
Use this parameter to limit the number of configuration templates that are returned in the response. |
Retrieves a list of the deliveries that have been created in the account
Description
Retrieves a list of the deliveries that have been created in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_deliveries/ for full documentation.
Usage
cloudwatchlogs_describe_deliveries(nextToken = NULL, limit = NULL)
Arguments
nextToken |
|
limit |
Optionally specify the maximum number of deliveries to return in the response. |
Retrieves a list of the delivery destinations that have been created in the account
Description
Retrieves a list of the delivery destinations that have been created in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_delivery_destinations/ for full documentation.
Usage
cloudwatchlogs_describe_delivery_destinations(nextToken = NULL, limit = NULL)
Arguments
nextToken |
|
limit |
Optionally specify the maximum number of delivery destinations to return in the response. |
Retrieves a list of the delivery sources that have been created in the account
Description
Retrieves a list of the delivery sources that have been created in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_delivery_sources/ for full documentation.
Usage
cloudwatchlogs_describe_delivery_sources(nextToken = NULL, limit = NULL)
Arguments
nextToken |
|
limit |
Optionally specify the maximum number of delivery sources to return in the response. |
Lists all your destinations
Description
Lists all your destinations. The results are ASCII-sorted by destination name.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_destinations/ for full documentation.
Usage
cloudwatchlogs_describe_destinations(
DestinationNamePrefix = NULL,
nextToken = NULL,
limit = NULL
)
Arguments
DestinationNamePrefix |
The prefix to match. If you don't specify a value, no prefix filter is applied. |
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of items returned. If you don't specify a value, the default maximum value of 50 items is used. |
Lists the specified export tasks
Description
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_export_tasks/ for full documentation.
Usage
cloudwatchlogs_describe_export_tasks(
taskId = NULL,
statusCode = NULL,
nextToken = NULL,
limit = NULL
)
Arguments
taskId |
The ID of the export task. Specifying a task ID filters the results to one or zero export tasks. |
statusCode |
The status code of the export task. Specifying a status code filters the results to zero or more export tasks. |
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of items returned. If you don't specify a value, the default is up to 50 items. |
Returns a list of field indexes listed in the field index policies of one or more log groups
Description
Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see put_index_policy.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_field_indexes/ for full documentation.
Usage
cloudwatchlogs_describe_field_indexes(logGroupIdentifiers, nextToken = NULL)
Arguments
logGroupIdentifiers |
[required] An array containing the names or ARNs of the log groups that you want to retrieve field indexes for. |
nextToken |
Returns the field index policies of one or more log groups
Description
Returns the field index policies of one or more log groups. For more information about field index policies, see put_index_policy.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_index_policies/ for full documentation.
Usage
cloudwatchlogs_describe_index_policies(logGroupIdentifiers, nextToken = NULL)
Arguments
logGroupIdentifiers |
[required] An array containing the name or ARN of the log group that you want to retrieve field index policies for. |
nextToken |
Lists the specified log groups
Description
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_log_groups/ for full documentation.
Usage
cloudwatchlogs_describe_log_groups(
accountIdentifiers = NULL,
logGroupNamePrefix = NULL,
logGroupNamePattern = NULL,
nextToken = NULL,
limit = NULL,
includeLinkedAccounts = NULL,
logGroupClass = NULL
)
Arguments
accountIdentifiers |
When |
logGroupNamePrefix |
The prefix to match.
|
logGroupNamePattern |
If you specify a string for this parameter, the operation returns only
log groups that have names that match the string based on a
case-sensitive substring search. For example, if you specify If you specify
|
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of items returned. If you don't specify a value, the default is up to 50 items. |
includeLinkedAccounts |
If you are using a monitoring account, set this to If this parameter is set to |
logGroupClass |
Specifies the log group class for this log group. There are two classes:
For details about the features supported by each class, see Log classes |
Lists the log streams for the specified log group
Description
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_log_streams/ for full documentation.
Usage
cloudwatchlogs_describe_log_streams(
logGroupName = NULL,
logGroupIdentifier = NULL,
logStreamNamePrefix = NULL,
orderBy = NULL,
descending = NULL,
nextToken = NULL,
limit = NULL
)
Arguments
logGroupName |
The name of the log group. You must include either |
logGroupIdentifier |
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. You must include either |
logStreamNamePrefix |
The prefix to match. If |
orderBy |
If the value is If you order the results by event time, you cannot specify the
|
descending |
If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false. |
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of items returned. If you don't specify a value, the default is up to 50 items. |
Lists the specified metric filters
Description
Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_metric_filters/ for full documentation.
Usage
cloudwatchlogs_describe_metric_filters(
logGroupName = NULL,
filterNamePrefix = NULL,
nextToken = NULL,
limit = NULL,
metricName = NULL,
metricNamespace = NULL
)
Arguments
logGroupName |
The name of the log group. |
filterNamePrefix |
The prefix to match. CloudWatch Logs uses the value that you set here
only if you also include the |
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of items returned. If you don't specify a value, the default is up to 50 items. |
metricName |
Filters results to include only those with the specified metric name. If
you include this parameter in your request, you must also include the
|
metricNamespace |
Filters results to include only those in the specified namespace. If you
include this parameter in your request, you must also include the
|
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account
Description
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_queries/ for full documentation.
Usage
cloudwatchlogs_describe_queries(
logGroupName = NULL,
status = NULL,
maxResults = NULL,
nextToken = NULL,
queryLanguage = NULL
)
Arguments
logGroupName |
Limits the returned queries to only those for the specified log group. |
status |
Limits the returned queries to only those that have the specified
status. Valid values are |
maxResults |
Limits the number of returned queries to the specified number. |
nextToken |
|
queryLanguage |
Limits the returned queries to only the queries that use the specified query language. |
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions
Description
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_query_definitions/ for full documentation.
Usage
cloudwatchlogs_describe_query_definitions(
queryLanguage = NULL,
queryDefinitionNamePrefix = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
queryLanguage |
The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages. |
queryDefinitionNamePrefix |
Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify. |
maxResults |
Limits the number of returned query definitions to the specified number. |
nextToken |
Lists the resource policies in this account
Description
Lists the resource policies in this account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_resource_policies/ for full documentation.
Usage
cloudwatchlogs_describe_resource_policies(nextToken = NULL, limit = NULL)
Arguments
nextToken |
|
limit |
The maximum number of resource policies to be displayed with one call of this API. |
Lists the subscription filters for the specified log group
Description
Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_describe_subscription_filters/ for full documentation.
Usage
cloudwatchlogs_describe_subscription_filters(
logGroupName,
filterNamePrefix = NULL,
nextToken = NULL,
limit = NULL
)
Arguments
logGroupName |
[required] The name of the log group. |
filterNamePrefix |
The prefix to match. If you don't specify a value, no prefix filter is applied. |
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of items returned. If you don't specify a value, the default is up to 50 items. |
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account
Description
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_disassociate_kms_key/ for full documentation.
Usage
cloudwatchlogs_disassociate_kms_key(
logGroupName = NULL,
resourceIdentifier = NULL
)
Arguments
logGroupName |
The name of the log group. In your |
resourceIdentifier |
Specifies the target for this operation. You must specify one of the following:
In your |
Lists log events from the specified log group
Description
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_filter_log_events/ for full documentation.
Usage
cloudwatchlogs_filter_log_events(
logGroupName = NULL,
logGroupIdentifier = NULL,
logStreamNames = NULL,
logStreamNamePrefix = NULL,
startTime = NULL,
endTime = NULL,
filterPattern = NULL,
nextToken = NULL,
limit = NULL,
interleaved = NULL,
unmask = NULL
)
Arguments
logGroupName |
The name of the log group to search. You must include either |
logGroupIdentifier |
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. You must include either |
logStreamNames |
Filters the results to only logs from the log streams in this list. If you specify a value for both |
logStreamNamePrefix |
Filters the results to include only events from log streams that have names starting with this prefix. If you specify a value for both |
startTime |
The start of the time range, expressed as the number of milliseconds
after |
endTime |
The end of the time range, expressed as the number of milliseconds after
|
filterPattern |
The filter pattern to use. For more information, see Filter and Pattern Syntax. If not provided, all the events are matched. |
nextToken |
The token for the next set of events to return. (You received this token from a previous call.) |
limit |
The maximum number of events to return. The default is 10,000 events. |
interleaved |
If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group. |
unmask |
Specify To use this operation with this parameter, you must be signed into an
account with the |
Returns information about a log group data protection policy
Description
Returns information about a log group data protection policy.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_data_protection_policy/ for full documentation.
Usage
cloudwatchlogs_get_data_protection_policy(logGroupIdentifier)
Arguments
logGroupIdentifier |
[required] The name or ARN of the log group that contains the data protection policy that you want to see. |
Returns complete information about one logical delivery
Description
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_delivery/ for full documentation.
Usage
cloudwatchlogs_get_delivery(id)
Arguments
id |
[required] The ID of the delivery that you want to retrieve. |
Retrieves complete information about one delivery destination
Description
Retrieves complete information about one delivery destination.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_delivery_destination/ for full documentation.
Usage
cloudwatchlogs_get_delivery_destination(name)
Arguments
name |
[required] The name of the delivery destination that you want to retrieve. |
Retrieves the delivery destination policy assigned to the delivery destination that you specify
Description
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see put_delivery_destination_policy.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_delivery_destination_policy/ for full documentation.
Usage
cloudwatchlogs_get_delivery_destination_policy(deliveryDestinationName)
Arguments
deliveryDestinationName |
[required] The name of the delivery destination that you want to retrieve the policy of. |
Retrieves complete information about one delivery source
Description
Retrieves complete information about one delivery source.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_delivery_source/ for full documentation.
Usage
cloudwatchlogs_get_delivery_source(name)
Arguments
name |
[required] The name of the delivery source that you want to retrieve. |
Returns information about one integration between CloudWatch Logs and OpenSearch Service
Description
Returns information about one integration between CloudWatch Logs and OpenSearch Service.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_integration/ for full documentation.
Usage
cloudwatchlogs_get_integration(integrationName)
Arguments
integrationName |
[required] The name of the integration that you want to find information about. To
find the name of your integration, use
|
Retrieves information about the log anomaly detector that you specify
Description
Retrieves information about the log anomaly detector that you specify.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_log_anomaly_detector/ for full documentation.
Usage
cloudwatchlogs_get_log_anomaly_detector(anomalyDetectorArn)
Arguments
anomalyDetectorArn |
[required] The ARN of the anomaly detector to retrieve information about. You can
find the ARNs of log anomaly detectors in your account by using the
|
Lists log events from the specified log stream
Description
Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_log_events/ for full documentation.
Usage
cloudwatchlogs_get_log_events(
logGroupName = NULL,
logGroupIdentifier = NULL,
logStreamName,
startTime = NULL,
endTime = NULL,
nextToken = NULL,
limit = NULL,
startFromHead = NULL,
unmask = NULL
)
Arguments
logGroupName |
The name of the log group. You must include either |
logGroupIdentifier |
Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. You must include either |
logStreamName |
[required] The name of the log stream. |
startTime |
The start of the time range, expressed as the number of milliseconds
after |
endTime |
The end of the time range, expressed as the number of milliseconds after
|
nextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
limit |
The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events). |
startFromHead |
If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false. If you are using a previous |
unmask |
Specify To use this operation with this parameter, you must be signed into an
account with the |
Returns a list of the fields that are included in log events in the specified log group
Description
Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_log_group_fields/ for full documentation.
Usage
cloudwatchlogs_get_log_group_fields(
logGroupName = NULL,
time = NULL,
logGroupIdentifier = NULL
)
Arguments
logGroupName |
The name of the log group to search. You must include either |
time |
The time to set as the center of the query. If you specify The |
logGroupIdentifier |
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN. You must include either |
Retrieves all of the fields and values of a single log event
Description
Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_log_record/ for full documentation.
Usage
cloudwatchlogs_get_log_record(logRecordPointer, unmask = NULL)
Arguments
logRecordPointer |
[required] The pointer corresponding to the log event record you want to retrieve.
You get this from the response of a
|
unmask |
Specify To use this operation with this parameter, you must be signed into an
account with the |
Returns the results from the specified query
Description
Returns the results from the specified query.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_query_results/ for full documentation.
Usage
cloudwatchlogs_get_query_results(queryId)
Arguments
queryId |
[required] The ID number of the query. |
Returns the information about the log transformer associated with this log group
Description
Returns the information about the log transformer associated with this log group.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_get_transformer/ for full documentation.
Usage
cloudwatchlogs_get_transformer(logGroupIdentifier)
Arguments
logGroupIdentifier |
[required] Specify either the name or ARN of the log group to return transformer information for. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. |
Returns a list of anomalies that log anomaly detectors have found
Description
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_list_anomalies/ for full documentation.
Usage
cloudwatchlogs_list_anomalies(
anomalyDetectorArn = NULL,
suppressionState = NULL,
limit = NULL,
nextToken = NULL
)
Arguments
anomalyDetectorArn |
Use this to optionally limit the results to only the anomalies found by a certain anomaly detector. |
suppressionState |
You can specify this parameter if you want to the operation to return only anomalies that are currently either suppressed or unsuppressed. |
limit |
The maximum number of items to return. If you don't specify a value, the default maximum value of 50 items is used. |
nextToken |
Returns a list of integrations between CloudWatch Logs and other services in this account
Description
Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_list_integrations/ for full documentation.
Usage
cloudwatchlogs_list_integrations(
integrationNamePrefix = NULL,
integrationType = NULL,
integrationStatus = NULL
)
Arguments
integrationNamePrefix |
To limit the results to integrations that start with a certain name prefix, specify that name prefix here. |
integrationType |
To limit the results to integrations of a certain type, specify that type here. |
integrationStatus |
To limit the results to integrations with a certain status, specify that status here. |
Retrieves a list of the log anomaly detectors in the account
Description
Retrieves a list of the log anomaly detectors in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_list_log_anomaly_detectors/ for full documentation.
Usage
cloudwatchlogs_list_log_anomaly_detectors(
filterLogGroupArn = NULL,
limit = NULL,
nextToken = NULL
)
Arguments
filterLogGroupArn |
Use this to optionally filter the results to only include anomaly detectors that are associated with the specified log group. |
limit |
The maximum number of items to return. If you don't specify a value, the default maximum value of 50 items is used. |
nextToken |
Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query
Description
Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the filterIndex command, because the log groups are dynamically selected in these cases.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_list_log_groups_for_query/ for full documentation.
Usage
cloudwatchlogs_list_log_groups_for_query(
queryId,
nextToken = NULL,
maxResults = NULL
)
Arguments
queryId |
[required] The ID of the query to use. This query ID is from the response to your
|
nextToken |
|
maxResults |
Limits the number of returned log groups to the specified number. |
Displays the tags associated with a CloudWatch Logs resource
Description
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_list_tags_for_resource/ for full documentation.
Usage
cloudwatchlogs_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The ARN of the resource that you want to view tags for. The ARN format of a log group is
The ARN format of a destination is
For more information about ARN format, see CloudWatch Logs resources and operations. |
The ListTagsLogGroup operation is on the path to deprecation
Description
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use list_tags_for_resource instead.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_list_tags_log_group/ for full documentation.
Usage
cloudwatchlogs_list_tags_log_group(logGroupName)
Arguments
logGroupName |
[required] The name of the log group. |
Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account
Description
Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_account_policy/ for full documentation.
Usage
cloudwatchlogs_put_account_policy(
policyName,
policyDocument,
policyType,
scope = NULL,
selectionCriteria = NULL
)
Arguments
policyName |
[required] A name for the policy. This must be unique within the account. |
policyDocument |
[required] Specify the policy, in JSON. Data protection policy A data protection policy must include two JSON blocks:
For an example data protection policy, see the Examples section on this page. The contents of the two In addition to the two JSON blocks, the The JSON specified in Subscription filter policy A subscription filter policy can include the following attributes in a JSON block:
Transformer policy A transformer policy must include one JSON block with the array of processors and their configurations. For more information about available processors, see Processors that you can use. Field index policy A field index filter policy can include the following attribute in a JSON block:
It must contain at least one field index. The following is an example of an index policy document that creates two
indexes,
|
policyType |
[required] The type of policy that you're creating or updating. |
scope |
Currently the only valid value for this parameter is |
selectionCriteria |
Use this parameter to apply the new policy to a subset of log groups in the account. Specifing If If The Using the |
Creates a data protection policy for the specified log group
Description
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_data_protection_policy/ for full documentation.
Usage
cloudwatchlogs_put_data_protection_policy(logGroupIdentifier, policyDocument)
Arguments
logGroupIdentifier |
[required] Specify either the log group name or log group ARN. |
policyDocument |
[required] Specify the data protection policy, in JSON. This policy must include two JSON blocks:
For an example data protection policy, see the Examples section on this page. The contents of the two In addition to the two JSON blocks, the The JSON specified in |
Creates or updates a logical delivery destination
Description
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_delivery_destination/ for full documentation.
Usage
cloudwatchlogs_put_delivery_destination(
name,
outputFormat = NULL,
deliveryDestinationConfiguration,
tags = NULL
)
Arguments
name |
[required] A name for this delivery destination. This name must be unique for all delivery destinations in your account. |
outputFormat |
The format for the logs that this delivery destination will receive. |
deliveryDestinationConfiguration |
[required] A structure that contains the ARN of the Amazon Web Services resource that will receive the logs. |
tags |
An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources |
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account
Description
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_delivery_destination_policy/ for full documentation.
Usage
cloudwatchlogs_put_delivery_destination_policy(
deliveryDestinationName,
deliveryDestinationPolicy
)
Arguments
deliveryDestinationName |
[required] The name of the delivery destination to assign this policy to. |
deliveryDestinationPolicy |
[required] The contents of the policy. |
Creates or updates a logical delivery source
Description
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_delivery_source/ for full documentation.
Usage
cloudwatchlogs_put_delivery_source(name, resourceArn, logType, tags = NULL)
Arguments
name |
[required] A name for this delivery source. This name must be unique for all delivery sources in your account. |
resourceArn |
[required] The ARN of the Amazon Web Services resource that is generating and
sending logs. For example,
|
logType |
[required] Defines the type of log that the source is sending.
|
tags |
An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources |
Creates or updates a destination
Description
Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_destination/ for full documentation.
Usage
cloudwatchlogs_put_destination(
destinationName,
targetArn,
roleArn,
tags = NULL
)
Arguments
destinationName |
[required] A name for the destination. |
targetArn |
[required] The ARN of an Amazon Kinesis stream to which to deliver matching log events. |
roleArn |
[required] The ARN of an IAM role that grants CloudWatch Logs permissions to call
the Amazon Kinesis |
tags |
An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources |
Creates or updates an access policy associated with an existing destination
Description
Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_destination_policy/ for full documentation.
Usage
cloudwatchlogs_put_destination_policy(
destinationName,
accessPolicy,
forceUpdate = NULL
)
Arguments
destinationName |
[required] A name for an existing destination. |
accessPolicy |
[required] An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes. |
forceUpdate |
Specify true if you are updating an existing destination policy to grant
permission to an organization ID instead of granting permission to
individual Amazon Web Services accounts. Before you update a destination
policy this way, you must first update the subscription filters in the
accounts that send logs to this destination. If you do not, the
subscription filters might stop working. By specifying If you omit this parameter, the default of |
Creates or updates a field index policy for the specified log group
Description
Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_index_policy/ for full documentation.
Usage
cloudwatchlogs_put_index_policy(logGroupIdentifier, policyDocument)
Arguments
logGroupIdentifier |
[required] Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end. |
policyDocument |
[required] The index policy document, in JSON format. The following is an example
of an index policy document that creates two indexes,
The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see Field index syntax and quotas. |
Creates an integration between CloudWatch Logs and another service in this account
Description
Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_integration/ for full documentation.
Usage
cloudwatchlogs_put_integration(
integrationName,
resourceConfig,
integrationType
)
Arguments
integrationName |
[required] A name for the integration. |
resourceConfig |
[required] A structure that contains configuration information for the integration that you are creating. |
integrationType |
[required] The type of integration. Currently, the only supported type is
|
Uploads a batch of log events to the specified log stream
Description
Uploads a batch of log events to the specified log stream.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_log_events/ for full documentation.
Usage
cloudwatchlogs_put_log_events(
logGroupName,
logStreamName,
logEvents,
sequenceToken = NULL,
entity = NULL
)
Arguments
logGroupName |
[required] The name of the log group. |
logStreamName |
[required] The name of the log stream. |
logEvents |
[required] The log events. |
sequenceToken |
The sequence token obtained from the response of the previous
The |
entity |
The entity associated with the log events. |
Creates or updates a metric filter and associates it with the specified log group
Description
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through put_log_events.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_metric_filter/ for full documentation.
Usage
cloudwatchlogs_put_metric_filter(
logGroupName,
filterName,
filterPattern,
metricTransformations,
applyOnTransformedLogs = NULL
)
Arguments
logGroupName |
[required] The name of the log group. |
filterName |
[required] A name for the metric filter. |
filterPattern |
[required] A filter pattern for extracting metric data out of ingested log events. |
metricTransformations |
[required] A collection of information that defines how metric data gets emitted. |
applyOnTransformedLogs |
This parameter is valid only for log groups that have an active log
transformer. For more information about log transformers, see
If the log group uses either a log-group level or account-level
transformer, and you specify |
Creates or updates a query definition for CloudWatch Logs Insights
Description
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_query_definition/ for full documentation.
Usage
cloudwatchlogs_put_query_definition(
queryLanguage = NULL,
name,
queryDefinitionId = NULL,
logGroupNames = NULL,
queryString,
clientToken = NULL
)
Arguments
queryLanguage |
Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages. |
name |
[required] A name for the query definition. If you are saving numerous query
definitions, we recommend that you name them. This way, you can find the
ones you want by using the first part of the name as a filter in the
|
queryDefinitionId |
If you are updating a query definition, use this parameter to specify
the ID of the query definition that you want to update. You can use
If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation. |
logGroupNames |
Use this parameter to include specific log groups as part of your query
definition. If your query uses the OpenSearch Service query language,
you specify the log group names inside the If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups. |
queryString |
[required] The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax. |
clientToken |
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error. |
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53
Description
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_resource_policy/ for full documentation.
Usage
cloudwatchlogs_put_resource_policy(policyName = NULL, policyDocument = NULL)
Arguments
policyName |
Name of the new policy. This parameter is required. |
policyDocument |
Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required. The following example creates a resource policy enabling the Route 53
service to put DNS query logs in to the specified log group. Replace
CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys. In the example resource policy, you would replace the value of
|
Sets the retention of the specified log group
Description
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_retention_policy/ for full documentation.
Usage
cloudwatchlogs_put_retention_policy(logGroupName, retentionInDays)
Arguments
logGroupName |
[required] The name of the log group. |
retentionInDays |
[required] |
Creates or updates a subscription filter and associates it with the specified log group
Description
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through put_log_events and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_subscription_filter/ for full documentation.
Usage
cloudwatchlogs_put_subscription_filter(
logGroupName,
filterName,
filterPattern,
destinationArn,
roleArn = NULL,
distribution = NULL,
applyOnTransformedLogs = NULL
)
Arguments
logGroupName |
[required] The name of the log group. |
filterName |
[required] A name for the subscription filter. If you are updating an existing
filter, you must specify the correct name in |
filterPattern |
[required] A filter pattern for subscribing to a filtered stream of log events. |
destinationArn |
[required] The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
|
roleArn |
The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. |
distribution |
The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream. |
applyOnTransformedLogs |
This parameter is valid only for log groups that have an active log
transformer. For more information about log transformers, see
If the log group uses either a log-group level or account-level
transformer, and you specify |
Creates or updates a log transformer for a single log group
Description
Creates or updates a log transformer for a single log group. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_transformer/ for full documentation.
Usage
cloudwatchlogs_put_transformer(logGroupIdentifier, transformerConfig)
Arguments
logGroupIdentifier |
[required] Specify either the name or ARN of the log group to create the transformer for. |
transformerConfig |
[required] This structure contains the configuration of this log transformer. A log transformer is an array of processors, where each processor applies one type of transformation to the log events that are ingested. |
Starts a Live Tail streaming session for one or more log groups
Description
Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_start_live_tail/ for full documentation.
Usage
cloudwatchlogs_start_live_tail(
logGroupIdentifiers,
logStreamNames = NULL,
logStreamNamePrefixes = NULL,
logEventFilterPattern = NULL
)
Arguments
logGroupIdentifiers |
[required] An array where each item in the array is a log group to include in the Live Tail session. Specify each log group by its ARN. If you specify an ARN, the ARN can't end with an asterisk (*). You can include up to 10 log groups. |
logStreamNames |
If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session. If you specify this field, you can't also specify the
You can specify this parameter only if you specify only one log group in
|
logStreamNamePrefixes |
If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session. If you specify this field, you can't also specify the You can specify this parameter only if you specify only one log group in
|
logEventFilterPattern |
An optional pattern to use to filter the results to include only log
events that match the pattern. For example, a filter pattern of
Regular expression filter patterns are supported. For more information about filter pattern syntax, see Filter and Pattern Syntax. |
Starts a query of one or more log groups using CloudWatch Logs Insights
Description
Starts a query of one or more log groups using CloudWatch Logs Insights. You specify the log groups and time range to query and the query string to use.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_start_query/ for full documentation.
Usage
cloudwatchlogs_start_query(
queryLanguage = NULL,
logGroupName = NULL,
logGroupNames = NULL,
logGroupIdentifiers = NULL,
startTime,
endTime,
queryString,
limit = NULL
)
Arguments
queryLanguage |
Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages. |
logGroupName |
The log group on which to perform the query. A |
logGroupNames |
The list of log groups to be queried. You can include up to 50 log groups. A |
logGroupIdentifiers |
The list of log groups to query. You can include up to 50 log groups. You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end. A |
startTime |
[required] The beginning of the time range to query. The range is inclusive, so the
specified start time is included in the query. Specified as epoch time,
the number of seconds since |
endTime |
[required] The end of the time range to query. The range is inclusive, so the
specified end time is included in the query. Specified as epoch time,
the number of seconds since |
queryString |
[required] The query string to use. For more information, see CloudWatch Logs Insights Query Syntax. |
limit |
The maximum number of log events to return in the query. If the query
string uses the |
Stops a CloudWatch Logs Insights query that is in progress
Description
Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_stop_query/ for full documentation.
Usage
cloudwatchlogs_stop_query(queryId)
Arguments
queryId |
[required] The ID number of the query to stop. To find this ID number, use
|
The TagLogGroup operation is on the path to deprecation
Description
The TagLogGroup operation is on the path to deprecation. We recommend that you use tag_resource instead.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_tag_log_group/ for full documentation.
Usage
cloudwatchlogs_tag_log_group(logGroupName, tags)
Arguments
logGroupName |
[required] The name of the log group. |
tags |
[required] The key-value pairs to use for the tags. |
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource
Description
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_tag_resource/ for full documentation.
Usage
cloudwatchlogs_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The ARN of the resource that you're adding tags to. The ARN format of a log group is
The ARN format of a destination is
For more information about ARN format, see CloudWatch Logs resources and operations. |
tags |
[required] The list of key-value pairs to associate with the resource. |
Tests the filter pattern of a metric filter against a sample of log event messages
Description
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_test_metric_filter/ for full documentation.
Usage
cloudwatchlogs_test_metric_filter(filterPattern, logEventMessages)
Arguments
filterPattern |
[required] |
logEventMessages |
[required] The log event messages to test. |
Use this operation to test a log transformer
Description
Use this operation to test a log transformer. You enter the transformer configuration and a set of log events to test with. The operation responds with an array that includes the original log events and the transformed versions.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_test_transformer/ for full documentation.
Usage
cloudwatchlogs_test_transformer(transformerConfig, logEventMessages)
Arguments
transformerConfig |
[required] This structure contains the configuration of this log transformer that you want to test. A log transformer is an array of processors, where each processor applies one type of transformation to the log events that are ingested. |
logEventMessages |
[required] An array of the raw log events that you want to use to test this transformer. |
The UntagLogGroup operation is on the path to deprecation
Description
The UntagLogGroup operation is on the path to deprecation. We recommend that you use untag_resource instead.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_untag_log_group/ for full documentation.
Usage
cloudwatchlogs_untag_log_group(logGroupName, tags)
Arguments
logGroupName |
[required] The name of the log group. |
tags |
[required] The tag keys. The corresponding tags are removed from the log group. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_untag_resource/ for full documentation.
Usage
cloudwatchlogs_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The ARN of the CloudWatch Logs resource that you're removing tags from. The ARN format of a log group is
The ARN format of a destination is
For more information about ARN format, see CloudWatch Logs resources and operations. |
tagKeys |
[required] The list of tag keys to remove from the resource. |
Use this operation to suppress anomaly detection for a specified anomaly or pattern
Description
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_update_anomaly/ for full documentation.
Usage
cloudwatchlogs_update_anomaly(
anomalyId = NULL,
patternId = NULL,
anomalyDetectorArn,
suppressionType = NULL,
suppressionPeriod = NULL,
baseline = NULL
)
Arguments
anomalyId |
If you are suppressing or unsuppressing an anomaly, specify its unique
ID here. You can find anomaly IDs by using the
|
patternId |
If you are suppressing or unsuppressing an pattern, specify its unique
ID here. You can find pattern IDs by using the
|
anomalyDetectorArn |
[required] The ARN of the anomaly detector that this operation is to act on. |
suppressionType |
Use this to specify whether the suppression to be temporary or infinite.
If you specify |
suppressionPeriod |
If you are temporarily suppressing an anomaly or pattern, use this structure to specify how long the suppression is to last. |
baseline |
Set this to The default is |
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs
Description
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_update_delivery_configuration/ for full documentation.
Usage
cloudwatchlogs_update_delivery_configuration(
id,
recordFields = NULL,
fieldDelimiter = NULL,
s3DeliveryConfiguration = NULL
)
Arguments
id |
[required] The ID of the delivery to be updated by this request. |
recordFields |
The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list. |
fieldDelimiter |
The field delimiter to use between record fields when the final output
format of a delivery is in |
s3DeliveryConfiguration |
This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket. |
Updates an existing log anomaly detector
Description
Updates an existing log anomaly detector.
See https://www.paws-r-sdk.com/docs/cloudwatchlogs_update_log_anomaly_detector/ for full documentation.
Usage
cloudwatchlogs_update_log_anomaly_detector(
anomalyDetectorArn,
evaluationFrequency = NULL,
filterPattern = NULL,
anomalyVisibilityTime = NULL,
enabled
)
Arguments
anomalyDetectorArn |
[required] The ARN of the anomaly detector that you want to update. |
evaluationFrequency |
Specifies how often the anomaly detector runs and look for anomalies.
Set this value according to the frequency that the log group receives
new logs. For example, if the log group receives new log events every 10
minutes, then setting |
filterPattern |
|
anomalyVisibilityTime |
The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an anomaly during this time, it will be considered normal going forward and will not be detected. |
enabled |
[required] Use this parameter to pause or restart the anomaly detector. |
CloudWatch Observability Access Manager
Description
Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.
Usage
cloudwatchobservabilityaccessmanager(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatchobservabilityaccessmanager(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_link | Creates a link between a source account and a sink that you have created in a monitoring account |
| create_sink | Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability |
| delete_link | Deletes a link between a monitoring account sink and a source account |
| delete_sink | Deletes a sink |
| get_link | Returns complete information about one link |
| get_sink | Returns complete information about one monitoring account sink |
| get_sink_policy | Returns the current sink policy attached to this sink |
| list_attached_links | Returns a list of source account links that are linked to this monitoring account sink |
| list_links | Use this operation in a source account to return a list of links to monitoring account sinks that this source account has |
| list_sinks | Use this operation in a monitoring account to return the list of sinks created in that account |
| list_tags_for_resource | Displays the tags associated with a resource |
| put_sink_policy | Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified resource |
| untag_resource | Removes one or more tags from the specified resource |
| update_link | Use this operation to change what types of data are shared from a source account to its linked monitoring account sink |
Examples
## Not run:
svc <- cloudwatchobservabilityaccessmanager()
svc$create_link(
Foo = 123
)
## End(Not run)
Creates a link between a source account and a sink that you have created in a monitoring account
Description
Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_create_link/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_create_link(
LabelTemplate,
LinkConfiguration = NULL,
ResourceTypes,
SinkIdentifier,
Tags = NULL
)
Arguments
LabelTemplate |
[required] Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account. You can use a custom label or use the following variables:
|
LinkConfiguration |
Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account. |
ResourceTypes |
[required] An array of strings that define which types of data that the source account shares with the monitoring account. |
SinkIdentifier |
[required] The ARN of the sink to use to create this link. You can use
For more information about sinks, see
|
Tags |
Assigns one or more tags (key-value pairs) to the link. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. |
Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability
Description
Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_create_sink/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_create_sink(Name, Tags = NULL)
Arguments
Name |
[required] A name for the sink. |
Tags |
Assigns one or more tags (key-value pairs) to the link. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. |
Deletes a link between a monitoring account sink and a source account
Description
Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_delete_link/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_delete_link(Identifier)
Arguments
Identifier |
[required] The ARN of the link to delete. |
Deletes a sink
Description
Deletes a sink. You must delete all links to a sink before you can delete that sink.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_delete_sink/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_delete_sink(Identifier)
Arguments
Identifier |
[required] The ARN of the sink to delete. |
Returns complete information about one link
Description
Returns complete information about one link.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_get_link/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_get_link(Identifier)
Arguments
Identifier |
[required] The ARN of the link to retrieve information for. |
Returns complete information about one monitoring account sink
Description
Returns complete information about one monitoring account sink.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_get_sink/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_get_sink(Identifier)
Arguments
Identifier |
[required] The ARN of the sink to retrieve information for. |
Returns the current sink policy attached to this sink
Description
Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_get_sink_policy/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_get_sink_policy(SinkIdentifier)
Arguments
SinkIdentifier |
[required] The ARN of the sink to retrieve the policy of. |
Returns a list of source account links that are linked to this monitoring account sink
Description
Returns a list of source account links that are linked to this monitoring account sink.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_list_attached_links/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_list_attached_links(
MaxResults = NULL,
NextToken = NULL,
SinkIdentifier
)
Arguments
MaxResults |
Limits the number of returned links to the specified number. |
NextToken |
The token for the next set of items to return. You received this token from a previous call. |
SinkIdentifier |
[required] The ARN of the sink that you want to retrieve links for. |
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has
Description
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_list_links/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_list_links(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
Limits the number of returned links to the specified number. |
NextToken |
The token for the next set of items to return. You received this token from a previous call. |
Use this operation in a monitoring account to return the list of sinks created in that account
Description
Use this operation in a monitoring account to return the list of sinks created in that account.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_list_sinks/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_list_sinks(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
Limits the number of returned links to the specified number. |
NextToken |
The token for the next set of items to return. You received this token from a previous call. |
Displays the tags associated with a resource
Description
Displays the tags associated with a resource. Both sinks and links support tagging.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_list_tags_for_resource/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The ARN of the resource that you want to view tags for. The ARN format of a sink is
The ARN format of a link is
For more information about ARN format, see CloudWatch Logs resources and operations. Unlike tagging permissions in other Amazon Web Services services, to
retrieve the list of tags for links or sinks you must have the
|
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink
Description
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_put_sink_policy/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_put_sink_policy(Policy, SinkIdentifier)
Arguments
Policy |
[required] The JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here. The policy must be in JSON string format with quotation marks escaped and no newlines. For examples of different types of policies, see the Examples section on this page. |
SinkIdentifier |
[required] The ARN of the sink to attach this policy to. |
Assigns one or more tags (key-value pairs) to the specified resource
Description
Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_tag_resource/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The ARN of the resource that you're adding tags to. The ARN format of a sink is
The ARN format of a link is
For more information about ARN format, see CloudWatch Logs resources and operations. |
Tags |
[required] The list of key-value pairs to associate with the resource. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_untag_resource/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The ARN of the resource that you're removing tags from. The ARN format of a sink is
The ARN format of a link is
For more information about ARN format, see CloudWatch Logs resources and operations. |
TagKeys |
[required] The list of tag keys to remove from the resource. |
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink
Description
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.
See https://www.paws-r-sdk.com/docs/cloudwatchobservabilityaccessmanager_update_link/ for full documentation.
Usage
cloudwatchobservabilityaccessmanager_update_link(
Identifier,
LinkConfiguration = NULL,
ResourceTypes
)
Arguments
Identifier |
[required] The ARN of the link that you want to update. |
LinkConfiguration |
Use this structure to filter which metric namespaces and which log groups are to be shared from the source account to the monitoring account. |
ResourceTypes |
[required] An array of strings that define which types of data that the source account will send to the monitoring account. Your input here replaces the current set of data types that are shared. |
CloudWatch RUM
Description
With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.
You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.
Usage
cloudwatchrum(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudwatchrum(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| batch_create_rum_metric_definitions | Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination |
| batch_delete_rum_metric_definitions | Removes the specified metrics from being sent to an extended metrics destination |
| batch_get_rum_metric_definitions | Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination |
| create_app_monitor | Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM |
| delete_app_monitor | Deletes an existing app monitor |
| delete_rum_metrics_destination | Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination |
| get_app_monitor | Retrieves the complete configuration information for one app monitor |
| get_app_monitor_data | Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data |
| list_app_monitors | Returns a list of the Amazon CloudWatch RUM app monitors in the account |
| list_rum_metrics_destinations | Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor |
| list_tags_for_resource | Displays the tags associated with a CloudWatch RUM resource |
| put_rum_events | Sends telemetry events about your application performance and user behavior to CloudWatch RUM |
| put_rum_metrics_destination | Creates or updates a destination to receive extended metrics from CloudWatch RUM |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource |
| untag_resource | Removes one or more tags from the specified resource |
| update_app_monitor | Updates the configuration of an existing app monitor |
| update_rum_metric_definition | Modifies one existing metric definition for CloudWatch RUM extended metrics |
Examples
## Not run:
svc <- cloudwatchrum()
svc$batch_create_rum_metric_definitions(
Foo = 123
)
## End(Not run)
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination
Description
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_batch_create_rum_metric_definitions/ for full documentation.
Usage
cloudwatchrum_batch_create_rum_metric_definitions(
AppMonitorName,
Destination,
DestinationArn = NULL,
MetricDefinitions
)
Arguments
AppMonitorName |
[required] The name of the CloudWatch RUM app monitor that is to send the metrics. |
Destination |
[required] The destination to send the metrics to. Valid values are |
DestinationArn |
This parameter is required if This parameter specifies the ARN of the Evidently experiment that is to
receive the metrics. You must have already defined this experiment as a
valid destination. For more information, see
|
MetricDefinitions |
[required] An array of structures which define the metrics that you want to send. |
Removes the specified metrics from being sent to an extended metrics destination
Description
Removes the specified metrics from being sent to an extended metrics destination.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_batch_delete_rum_metric_definitions/ for full documentation.
Usage
cloudwatchrum_batch_delete_rum_metric_definitions(
AppMonitorName,
Destination,
DestinationArn = NULL,
MetricDefinitionIds
)
Arguments
AppMonitorName |
[required] The name of the CloudWatch RUM app monitor that is sending these metrics. |
Destination |
[required] Defines the destination where you want to stop sending the specified
metrics. Valid values are |
DestinationArn |
This parameter is required if This parameter specifies the ARN of the Evidently experiment that was receiving the metrics that are being deleted. |
MetricDefinitionIds |
[required] An array of structures which define the metrics that you want to stop sending. |
Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination
Description
Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_batch_get_rum_metric_definitions/ for full documentation.
Usage
cloudwatchrum_batch_get_rum_metric_definitions(
AppMonitorName,
Destination,
DestinationArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AppMonitorName |
[required] The name of the CloudWatch RUM app monitor that is sending the metrics. |
Destination |
[required] The type of destination that you want to view metrics for. Valid values
are |
DestinationArn |
This parameter is required if This parameter specifies the ARN of the Evidently experiment that corresponds to the destination. |
MaxResults |
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100. To retrieve the remaining results, make another call with the returned
|
NextToken |
Use the token returned by the previous operation to request the next page of results. |
Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM
Description
Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_create_app_monitor/ for full documentation.
Usage
cloudwatchrum_create_app_monitor(
AppMonitorConfiguration = NULL,
CustomEvents = NULL,
CwLogEnabled = NULL,
Domain,
Name,
Tags = NULL
)
Arguments
AppMonitorConfiguration |
A structure that contains much of the configuration data for the app
monitor. If you are using Amazon Cognito for authorization, you must
include this structure in your request, and it must include the ID of
the Amazon Cognito identity pool to use for authorization. If you don't
include If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions. |
CustomEvents |
Specifies whether this app monitor allows the web client to define and
send custom events. If you omit this parameter, custom events are
For more information about custom events, see Send custom events. |
CwLogEnabled |
Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. If you omit this parameter, the default is |
Domain |
[required] The top-level internet domain name for which your application has administrative authority. |
Name |
[required] A name for the app monitor. |
Tags |
Assigns one or more tags (key-value pairs) to the app monitor. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with an app monitor. For more information, see Tagging Amazon Web Services resources. |
Deletes an existing app monitor
Description
Deletes an existing app monitor. This immediately stops the collection of data.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_delete_app_monitor/ for full documentation.
Usage
cloudwatchrum_delete_app_monitor(Name)
Arguments
Name |
[required] The name of the app monitor to delete. |
Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination
Description
Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_delete_rum_metrics_destination/ for full documentation.
Usage
cloudwatchrum_delete_rum_metrics_destination(
AppMonitorName,
Destination,
DestinationArn = NULL
)
Arguments
AppMonitorName |
[required] The name of the app monitor that is sending metrics to the destination that you want to delete. |
Destination |
[required] The type of destination to delete. Valid values are |
DestinationArn |
This parameter is required if |
Retrieves the complete configuration information for one app monitor
Description
Retrieves the complete configuration information for one app monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_get_app_monitor/ for full documentation.
Usage
cloudwatchrum_get_app_monitor(Name)
Arguments
Name |
[required] The app monitor to retrieve information for. |
Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data
Description
Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_get_app_monitor_data/ for full documentation.
Usage
cloudwatchrum_get_app_monitor_data(
Filters = NULL,
MaxResults = NULL,
Name,
NextToken = NULL,
TimeRange
)
Arguments
Filters |
An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. |
MaxResults |
The maximum number of results to return in one operation. |
Name |
[required] The name of the app monitor that collected the data that you want to retrieve. |
NextToken |
Use the token returned by the previous operation to request the next page of results. |
TimeRange |
[required] A structure that defines the time range that you want to retrieve results from. |
Returns a list of the Amazon CloudWatch RUM app monitors in the account
Description
Returns a list of the Amazon CloudWatch RUM app monitors in the account.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_list_app_monitors/ for full documentation.
Usage
cloudwatchrum_list_app_monitors(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100. |
NextToken |
Use the token returned by the previous operation to request the next page of results. |
Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor
Description
Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_list_rum_metrics_destinations/ for full documentation.
Usage
cloudwatchrum_list_rum_metrics_destinations(
AppMonitorName,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AppMonitorName |
[required] The name of the app monitor associated with the destinations that you want to retrieve. |
MaxResults |
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100. To retrieve the remaining results, make another call with the returned
|
NextToken |
Use the token returned by the previous operation to request the next page of results. |
Displays the tags associated with a CloudWatch RUM resource
Description
Displays the tags associated with a CloudWatch RUM resource.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_list_tags_for_resource/ for full documentation.
Usage
cloudwatchrum_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The ARN of the resource that you want to see the tags of. |
Sends telemetry events about your application performance and user behavior to CloudWatch RUM
Description
Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes put_rum_events operations to send this data to RUM.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_put_rum_events/ for full documentation.
Usage
cloudwatchrum_put_rum_events(
AppMonitorDetails,
BatchId,
Id,
RumEvents,
UserDetails
)
Arguments
AppMonitorDetails |
[required] A structure that contains information about the app monitor that collected this telemetry information. |
BatchId |
[required] A unique identifier for this batch of RUM event data. |
Id |
[required] The ID of the app monitor that is sending this data. |
RumEvents |
[required] An array of structures that contain the telemetry event data. |
UserDetails |
[required] A structure that contains information about the user session that this batch of events was collected from. |
Creates or updates a destination to receive extended metrics from CloudWatch RUM
Description
Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_put_rum_metrics_destination/ for full documentation.
Usage
cloudwatchrum_put_rum_metrics_destination(
AppMonitorName,
Destination,
DestinationArn = NULL,
IamRoleArn = NULL
)
Arguments
AppMonitorName |
[required] The name of the CloudWatch RUM app monitor that will send the metrics. |
Destination |
[required] Defines the destination to send the metrics to. Valid values are
|
DestinationArn |
Use this parameter only if |
IamRoleArn |
This parameter is required if This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment. If you specify this parameter, you must be signed on to a role that has
PassRole
permissions attached to it, to allow the role to be passed. The
CloudWatchAmazonCloudWatchRUMFullAccess
policy doesn't include |
Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource
Description
Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_tag_resource/ for full documentation.
Usage
cloudwatchrum_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The ARN of the CloudWatch RUM resource that you're adding tags to. |
Tags |
[required] The list of key-value pairs to associate with the resource. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_untag_resource/ for full documentation.
Usage
cloudwatchrum_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The ARN of the CloudWatch RUM resource that you're removing tags from. |
TagKeys |
[required] The list of tag keys to remove from the resource. |
Updates the configuration of an existing app monitor
Description
Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_update_app_monitor/ for full documentation.
Usage
cloudwatchrum_update_app_monitor(
AppMonitorConfiguration = NULL,
CustomEvents = NULL,
CwLogEnabled = NULL,
Domain = NULL,
Name
)
Arguments
AppMonitorConfiguration |
A structure that contains much of the configuration data for the app
monitor. If you are using Amazon Cognito for authorization, you must
include this structure in your request, and it must include the ID of
the Amazon Cognito identity pool to use for authorization. If you don't
include |
CustomEvents |
Specifies whether this app monitor allows the web client to define and
send custom events. The default is for custom events to be For more information about custom events, see Send custom events. |
CwLogEnabled |
Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. |
Domain |
The top-level internet domain name for which your application has administrative authority. |
Name |
[required] The name of the app monitor to update. |
Modifies one existing metric definition for CloudWatch RUM extended metrics
Description
Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.
See https://www.paws-r-sdk.com/docs/cloudwatchrum_update_rum_metric_definition/ for full documentation.
Usage
cloudwatchrum_update_rum_metric_definition(
AppMonitorName,
Destination,
DestinationArn = NULL,
MetricDefinition,
MetricDefinitionId
)
Arguments
AppMonitorName |
[required] The name of the CloudWatch RUM app monitor that sends these metrics. |
Destination |
[required] The destination to send the metrics to. Valid values are |
DestinationArn |
This parameter is required if This parameter specifies the ARN of the Evidently experiment that is to
receive the metrics. You must have already defined this experiment as a
valid destination. For more information, see
|
MetricDefinition |
[required] A structure that contains the new definition that you want to use for this metric. |
MetricDefinitionId |
[required] The ID of the metric definition to update. |
AWS Config
Description
Config
Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources.
You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide.
Usage
configservice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- configservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_resource_types | Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording |
| batch_get_aggregate_resource_config | Returns the current configuration items for resources that are present in your Config aggregator |
| batch_get_resource_config | Returns the BaseConfigurationItem for one or more requested resources |
| delete_aggregation_authorization | Deletes the authorization granted to the specified configuration aggregator account in a specified region |
| delete_config_rule | Deletes the specified Config rule and all of its evaluation results |
| delete_configuration_aggregator | Deletes the specified configuration aggregator and the aggregated data associated with the aggregator |
| delete_configuration_recorder | Deletes the customer managed configuration recorder |
| delete_conformance_pack | Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack |
| delete_delivery_channel | Deletes the delivery channel |
| delete_evaluation_results | Deletes the evaluation results for the specified Config rule |
| delete_organization_config_rule | Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization |
| delete_organization_conformance_pack | Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization |
| delete_pending_aggregation_request | Deletes pending authorization requests for a specified aggregator account in a specified region |
| delete_remediation_configuration | Deletes the remediation configuration |
| delete_remediation_exceptions | Deletes one or more remediation exceptions mentioned in the resource keys |
| delete_resource_config | Records the configuration state for a custom resource that has been deleted |
| delete_retention_configuration | Deletes the retention configuration |
| delete_service_linked_configuration_recorder | Deletes an existing service-linked configuration recorder |
| delete_stored_query | Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region |
| deliver_config_snapshot | Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel |
| describe_aggregate_compliance_by_config_rules | Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules |
| describe_aggregate_compliance_by_conformance_packs | Returns a list of the existing and deleted conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack |
| describe_aggregation_authorizations | Returns a list of authorizations granted to various aggregator accounts and regions |
| describe_compliance_by_config_rule | Indicates whether the specified Config rules are compliant |
| describe_compliance_by_resource | Indicates whether the specified Amazon Web Services resources are compliant |
| describe_config_rule_evaluation_status | Returns status information for each of your Config managed rules |
| describe_config_rules | Returns details about your Config rules |
| describe_configuration_aggregators | Returns the details of one or more configuration aggregators |
| describe_configuration_aggregator_sources_status | Returns status information for sources within an aggregator |
| describe_configuration_recorders | Returns details for the configuration recorder you specify |
| describe_configuration_recorder_status | Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders |
| describe_conformance_pack_compliance | Returns compliance details for each rule in that conformance pack |
| describe_conformance_packs | Returns a list of one or more conformance packs |
| describe_conformance_pack_status | Provides one or more conformance packs deployment status |
| describe_delivery_channels | Returns details about the specified delivery channel |
| describe_delivery_channel_status | Returns the current status of the specified delivery channel |
| describe_organization_config_rules | Returns a list of organization Config rules |
| describe_organization_config_rule_statuses | Provides organization Config rule deployment status for an organization |
| describe_organization_conformance_packs | Returns a list of organization conformance packs |
| describe_organization_conformance_pack_statuses | Provides organization conformance pack deployment status for an organization |
| describe_pending_aggregation_requests | Returns a list of all pending aggregation requests |
| describe_remediation_configurations | Returns the details of one or more remediation configurations |
| describe_remediation_exceptions | Returns the details of one or more remediation exceptions |
| describe_remediation_execution_status | Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed |
| describe_retention_configurations | Returns the details of one or more retention configurations |
| disassociate_resource_types | Removes all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording |
| get_aggregate_compliance_details_by_config_rule | Returns the evaluation results for the specified Config rule for a specific resource in a rule |
| get_aggregate_config_rule_compliance_summary | Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator |
| get_aggregate_conformance_pack_compliance_summary | Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator |
| get_aggregate_discovered_resource_counts | Returns the resource counts across accounts and regions that are present in your Config aggregator |
| get_aggregate_resource_config | Returns configuration item that is aggregated for your specific resource in a specific source account and region |
| get_compliance_details_by_config_rule | Returns the evaluation results for the specified Config rule |
| get_compliance_details_by_resource | Returns the evaluation results for the specified Amazon Web Services resource |
| get_compliance_summary_by_config_rule | Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each |
| get_compliance_summary_by_resource_type | Returns the number of resources that are compliant and the number that are noncompliant |
| get_conformance_pack_compliance_details | Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack |
| get_conformance_pack_compliance_summary | Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack |
| get_custom_rule_policy | Returns the policy definition containing the logic for your Config Custom Policy rule |
| get_discovered_resource_counts | Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account |
| get_organization_config_rule_detailed_status | Returns detailed status for each member account within an organization for a given organization Config rule |
| get_organization_conformance_pack_detailed_status | Returns detailed status for each member account within an organization for a given organization conformance pack |
| get_organization_custom_rule_policy | Returns the policy definition containing the logic for your organization Config Custom Policy rule |
| get_resource_config_history | For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type |
| get_resource_evaluation_summary | Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run |
| get_stored_query | Returns the details of a specific stored query |
| list_aggregate_discovered_resources | Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions |
| list_configuration_recorders | Returns a list of configuration recorders depending on the filters you specify |
| list_conformance_pack_compliance_scores | Returns a list of conformance pack compliance scores |
| list_discovered_resources | Accepts a resource type and returns a list of resource identifiers for the resources of that type |
| list_resource_evaluations | Returns a list of proactive resource evaluations |
| list_stored_queries | Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region |
| list_tags_for_resource | List the tags for Config resource |
| put_aggregation_authorization | Authorizes the aggregator account and region to collect data from the source account and region |
| put_config_rule | Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations |
| put_configuration_aggregator | Creates and updates the configuration aggregator with the selected source accounts and regions |
| put_configuration_recorder | Creates or updates the customer managed configuration recorder |
| put_conformance_pack | Creates or updates a conformance pack |
| put_delivery_channel | Creates or updates a delivery channel to deliver configuration information and other compliance information |
| put_evaluations | Used by an Lambda function to deliver evaluation results to Config |
| put_external_evaluation | Add or updates the evaluations for process checks |
| put_organization_config_rule | Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations |
| put_organization_conformance_pack | Deploys conformance packs across member accounts in an Amazon Web Services Organization |
| put_remediation_configurations | Adds or updates the remediation configuration with a specific Config rule with the selected target or action |
| put_remediation_exceptions | A remediation exception is when a specified resource is no longer considered for auto-remediation |
| put_resource_config | Records the configuration state for the resource provided in the request |
| put_retention_configuration | Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information |
| put_service_linked_configuration_recorder | Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify |
| put_stored_query | Saves a new query or updates an existing saved query |
| select_aggregate_resource_config | Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties |
| select_resource_config | Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties |
| start_config_rules_evaluation | Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources |
| start_configuration_recorder | Starts the customer managed configuration recorder |
| start_remediation_execution | Runs an on-demand remediation for the specified Config rules against the last known remediation configuration |
| start_resource_evaluation | Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules |
| stop_configuration_recorder | Stops the customer managed configuration recorder |
| tag_resource | Associates the specified tags to a resource with the specified ResourceArn |
| untag_resource | Deletes specified tags from a resource |
Examples
## Not run:
svc <- configservice()
svc$associate_resource_types(
Foo = 123
)
## End(Not run)
Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording
Description
Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording.
See https://www.paws-r-sdk.com/docs/configservice_associate_resource_types/ for full documentation.
Usage
configservice_associate_resource_types(ConfigurationRecorderArn, ResourceTypes)
Arguments
ConfigurationRecorderArn |
[required] The Amazon Resource Name (ARN) of the specified configuration recorder. |
ResourceTypes |
[required] The list of resource types you want to add to the recording group of the specified configuration recorder. |
Returns the current configuration items for resources that are present in your Config aggregator
Description
Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.
See https://www.paws-r-sdk.com/docs/configservice_batch_get_aggregate_resource_config/ for full documentation.
Usage
configservice_batch_get_aggregate_resource_config(
ConfigurationAggregatorName,
ResourceIdentifiers
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
ResourceIdentifiers |
[required] A list of aggregate ResourceIdentifiers objects. |
Returns the BaseConfigurationItem for one or more requested resources
Description
Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.
See https://www.paws-r-sdk.com/docs/configservice_batch_get_resource_config/ for full documentation.
Usage
configservice_batch_get_resource_config(resourceKeys)
Arguments
resourceKeys |
[required] A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. |
Deletes the authorization granted to the specified configuration aggregator account in a specified region
Description
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
See https://www.paws-r-sdk.com/docs/configservice_delete_aggregation_authorization/ for full documentation.
Usage
configservice_delete_aggregation_authorization(
AuthorizedAccountId,
AuthorizedAwsRegion
)
Arguments
AuthorizedAccountId |
[required] The 12-digit account ID of the account authorized to aggregate data. |
AuthorizedAwsRegion |
[required] The region authorized to collect aggregated data. |
Deletes the specified Config rule and all of its evaluation results
Description
Deletes the specified Config rule and all of its evaluation results.
See https://www.paws-r-sdk.com/docs/configservice_delete_config_rule/ for full documentation.
Usage
configservice_delete_config_rule(ConfigRuleName)
Arguments
ConfigRuleName |
[required] The name of the Config rule that you want to delete. |
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator
Description
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
See https://www.paws-r-sdk.com/docs/configservice_delete_configuration_aggregator/ for full documentation.
Usage
configservice_delete_configuration_aggregator(ConfigurationAggregatorName)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Deletes the customer managed configuration recorder
Description
Deletes the customer managed configuration recorder.
See https://www.paws-r-sdk.com/docs/configservice_delete_configuration_recorder/ for full documentation.
Usage
configservice_delete_configuration_recorder(ConfigurationRecorderName)
Arguments
ConfigurationRecorderName |
[required] The name of the customer managed configuration recorder that you want to
delete. You can retrieve the name of your configuration recorders by
using the
|
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack
Description
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
See https://www.paws-r-sdk.com/docs/configservice_delete_conformance_pack/ for full documentation.
Usage
configservice_delete_conformance_pack(ConformancePackName)
Arguments
ConformancePackName |
[required] Name of the conformance pack you want to delete. |
Deletes the delivery channel
Description
Deletes the delivery channel.
See https://www.paws-r-sdk.com/docs/configservice_delete_delivery_channel/ for full documentation.
Usage
configservice_delete_delivery_channel(DeliveryChannelName)
Arguments
DeliveryChannelName |
[required] The name of the delivery channel that you want to delete. |
Deletes the evaluation results for the specified Config rule
Description
Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the start_config_rules_evaluation API to start evaluating your Amazon Web Services resources against the rule.
See https://www.paws-r-sdk.com/docs/configservice_delete_evaluation_results/ for full documentation.
Usage
configservice_delete_evaluation_results(ConfigRuleName)
Arguments
ConfigRuleName |
[required] The name of the Config rule for which you want to delete the evaluation results. |
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization
Description
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
See https://www.paws-r-sdk.com/docs/configservice_delete_organization_config_rule/ for full documentation.
Usage
configservice_delete_organization_config_rule(OrganizationConfigRuleName)
Arguments
OrganizationConfigRuleName |
[required] The name of organization Config rule that you want to delete. |
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization
Description
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
See https://www.paws-r-sdk.com/docs/configservice_delete_organization_conformance_pack/ for full documentation.
Usage
configservice_delete_organization_conformance_pack(
OrganizationConformancePackName
)
Arguments
OrganizationConformancePackName |
[required] The name of organization conformance pack that you want to delete. |
Deletes pending authorization requests for a specified aggregator account in a specified region
Description
Deletes pending authorization requests for a specified aggregator account in a specified region.
See https://www.paws-r-sdk.com/docs/configservice_delete_pending_aggregation_request/ for full documentation.
Usage
configservice_delete_pending_aggregation_request(
RequesterAccountId,
RequesterAwsRegion
)
Arguments
RequesterAccountId |
[required] The 12-digit account ID of the account requesting to aggregate data. |
RequesterAwsRegion |
[required] The region requesting to aggregate data. |
Deletes the remediation configuration
Description
Deletes the remediation configuration.
See https://www.paws-r-sdk.com/docs/configservice_delete_remediation_configuration/ for full documentation.
Usage
configservice_delete_remediation_configuration(
ConfigRuleName,
ResourceType = NULL
)
Arguments
ConfigRuleName |
[required] The name of the Config rule for which you want to delete remediation configuration. |
ResourceType |
The type of a resource. |
Deletes one or more remediation exceptions mentioned in the resource keys
Description
Deletes one or more remediation exceptions mentioned in the resource keys.
See https://www.paws-r-sdk.com/docs/configservice_delete_remediation_exceptions/ for full documentation.
Usage
configservice_delete_remediation_exceptions(ConfigRuleName, ResourceKeys)
Arguments
ConfigRuleName |
[required] The name of the Config rule for which you want to delete remediation exception configuration. |
ResourceKeys |
[required] An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys. |
Records the configuration state for a custom resource that has been deleted
Description
Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
See https://www.paws-r-sdk.com/docs/configservice_delete_resource_config/ for full documentation.
Usage
configservice_delete_resource_config(ResourceType, ResourceId)
Arguments
ResourceType |
[required] The type of the resource. |
ResourceId |
[required] Unique identifier of the resource. |
Deletes the retention configuration
Description
Deletes the retention configuration.
See https://www.paws-r-sdk.com/docs/configservice_delete_retention_configuration/ for full documentation.
Usage
configservice_delete_retention_configuration(RetentionConfigurationName)
Arguments
RetentionConfigurationName |
[required] The name of the retention configuration to delete. |
Deletes an existing service-linked configuration recorder
Description
Deletes an existing service-linked configuration recorder.
See https://www.paws-r-sdk.com/docs/configservice_delete_service_linked_configuration_recorder/ for full documentation.
Usage
configservice_delete_service_linked_configuration_recorder(ServicePrincipal)
Arguments
ServicePrincipal |
[required] The service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to delete. |
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region
Description
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/configservice_delete_stored_query/ for full documentation.
Usage
configservice_delete_stored_query(QueryName)
Arguments
QueryName |
[required] The name of the query that you want to delete. |
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel
Description
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.
See https://www.paws-r-sdk.com/docs/configservice_deliver_config_snapshot/ for full documentation.
Usage
configservice_deliver_config_snapshot(deliveryChannelName)
Arguments
deliveryChannelName |
[required] The name of the delivery channel through which the snapshot is delivered. |
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules
Description
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
See https://www.paws-r-sdk.com/docs/configservice_describe_aggregate_compliance_by_config_rules/ for full documentation.
Usage
configservice_describe_aggregate_compliance_by_config_rules(
ConfigurationAggregatorName,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Filters |
Filters the results by ConfigRuleComplianceFilters object. |
Limit |
The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default. |
NextToken |
The |
Returns a list of the existing and deleted conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack
Description
Returns a list of the existing and deleted conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
See https://www.paws-r-sdk.com/docs/configservice_describe_aggregate_compliance_by_conformance_packs/ for full documentation.
Usage
configservice_describe_aggregate_compliance_by_conformance_packs(
ConfigurationAggregatorName,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Filters |
Filters the result by |
Limit |
The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default. |
NextToken |
The |
Returns a list of authorizations granted to various aggregator accounts and regions
Description
Returns a list of authorizations granted to various aggregator accounts and regions.
See https://www.paws-r-sdk.com/docs/configservice_describe_aggregation_authorizations/ for full documentation.
Usage
configservice_describe_aggregation_authorizations(
Limit = NULL,
NextToken = NULL
)
Arguments
Limit |
The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default. |
NextToken |
The |
Indicates whether the specified Config rules are compliant
Description
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this operation returns the number of Amazon Web Services resources that do not comply with the rule.
See https://www.paws-r-sdk.com/docs/configservice_describe_compliance_by_config_rule/ for full documentation.
Usage
configservice_describe_compliance_by_config_rule(
ConfigRuleNames = NULL,
ComplianceTypes = NULL,
NextToken = NULL
)
Arguments
ConfigRuleNames |
Specify one or more Config rule names to filter the results by rule. |
ComplianceTypes |
Filters the results by compliance. |
NextToken |
The |
Indicates whether the specified Amazon Web Services resources are compliant
Description
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this operation returns the number of Config rules that the resource does not comply with.
See https://www.paws-r-sdk.com/docs/configservice_describe_compliance_by_resource/ for full documentation.
Usage
configservice_describe_compliance_by_resource(
ResourceType = NULL,
ResourceId = NULL,
ComplianceTypes = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ResourceType |
The types of Amazon Web Services resources for which you want compliance
information (for example, |
ResourceId |
The ID of the Amazon Web Services resource for which you want compliance
information. You can specify only one resource ID. If you specify a
resource ID, you must also specify a type for |
ComplianceTypes |
Filters the results by compliance. |
Limit |
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
NextToken |
The |
Returns status information for each of your Config managed rules
Description
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
See https://www.paws-r-sdk.com/docs/configservice_describe_config_rule_evaluation_status/ for full documentation.
Usage
configservice_describe_config_rule_evaluation_status(
ConfigRuleNames = NULL,
NextToken = NULL,
Limit = NULL
)
Arguments
ConfigRuleNames |
The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use. |
NextToken |
The |
Limit |
The number of rule evaluation results that you want returned. This parameter is required if the rule limit for your account is more than the default of 1000 rules. For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide. |
Returns details about your Config rules
Description
Returns details about your Config rules.
See https://www.paws-r-sdk.com/docs/configservice_describe_config_rules/ for full documentation.
Usage
configservice_describe_config_rules(
ConfigRuleNames = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
ConfigRuleNames |
The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules. |
NextToken |
The |
Filters |
Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide. |
Returns status information for sources within an aggregator
Description
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
See https://www.paws-r-sdk.com/docs/configservice_describe_configuration_aggregator_sources_status/ for full documentation.
Usage
configservice_describe_configuration_aggregator_sources_status(
ConfigurationAggregatorName,
UpdateStatus = NULL,
NextToken = NULL,
Limit = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
UpdateStatus |
Filters the status type.
|
NextToken |
The |
Limit |
The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default. |
Returns the details of one or more configuration aggregators
Description
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account.
See https://www.paws-r-sdk.com/docs/configservice_describe_configuration_aggregators/ for full documentation.
Usage
configservice_describe_configuration_aggregators(
ConfigurationAggregatorNames = NULL,
NextToken = NULL,
Limit = NULL
)
Arguments
ConfigurationAggregatorNames |
The name of the configuration aggregators. |
NextToken |
The |
Limit |
The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default. |
Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders
Description
Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders.
See https://www.paws-r-sdk.com/docs/configservice_describe_configuration_recorder_status/ for full documentation.
Usage
configservice_describe_configuration_recorder_status(
ConfigurationRecorderNames = NULL,
ServicePrincipal = NULL,
Arn = NULL
)
Arguments
ConfigurationRecorderNames |
The name of the configuration recorder. If the name is not specified, the opertation returns the status for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder. |
ServicePrincipal |
For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. |
Arn |
The Amazon Resource Name (ARN) of the configuration recorder that you want to specify. |
Returns details for the configuration recorder you specify
Description
Returns details for the configuration recorder you specify.
See https://www.paws-r-sdk.com/docs/configservice_describe_configuration_recorders/ for full documentation.
Usage
configservice_describe_configuration_recorders(
ConfigurationRecorderNames = NULL,
ServicePrincipal = NULL,
Arn = NULL
)
Arguments
ConfigurationRecorderNames |
A list of names of the configuration recorders that you want to specify. |
ServicePrincipal |
For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. |
Arn |
The Amazon Resource Name (ARN) of the configuration recorder that you want to specify. |
Returns compliance details for each rule in that conformance pack
Description
Returns compliance details for each rule in that conformance pack.
See https://www.paws-r-sdk.com/docs/configservice_describe_conformance_pack_compliance/ for full documentation.
Usage
configservice_describe_conformance_pack_compliance(
ConformancePackName,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConformancePackName |
[required] Name of the conformance pack. |
Filters |
A |
Limit |
The maximum number of Config rules within a conformance pack are returned on each page. |
NextToken |
The |
Provides one or more conformance packs deployment status
Description
Provides one or more conformance packs deployment status.
See https://www.paws-r-sdk.com/docs/configservice_describe_conformance_pack_status/ for full documentation.
Usage
configservice_describe_conformance_pack_status(
ConformancePackNames = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConformancePackNames |
Comma-separated list of conformance pack names. |
Limit |
The maximum number of conformance packs status returned on each page. |
NextToken |
The |
Returns a list of one or more conformance packs
Description
Returns a list of one or more conformance packs.
See https://www.paws-r-sdk.com/docs/configservice_describe_conformance_packs/ for full documentation.
Usage
configservice_describe_conformance_packs(
ConformancePackNames = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConformancePackNames |
Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs. |
Limit |
The maximum number of conformance packs returned on each page. |
NextToken |
The |
Returns the current status of the specified delivery channel
Description
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account.
See https://www.paws-r-sdk.com/docs/configservice_describe_delivery_channel_status/ for full documentation.
Usage
configservice_describe_delivery_channel_status(DeliveryChannelNames = NULL)
Arguments
DeliveryChannelNames |
A list of delivery channel names. |
Returns details about the specified delivery channel
Description
Returns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels associated with the account.
See https://www.paws-r-sdk.com/docs/configservice_describe_delivery_channels/ for full documentation.
Usage
configservice_describe_delivery_channels(DeliveryChannelNames = NULL)
Arguments
DeliveryChannelNames |
A list of delivery channel names. |
Provides organization Config rule deployment status for an organization
Description
Provides organization Config rule deployment status for an organization.
See https://www.paws-r-sdk.com/docs/configservice_describe_organization_config_rule_statuses/ for full documentation.
Usage
configservice_describe_organization_config_rule_statuses(
OrganizationConfigRuleNames = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
OrganizationConfigRuleNames |
The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules. |
Limit |
The maximum number of |
NextToken |
The |
Returns a list of organization Config rules
Description
Returns a list of organization Config rules.
See https://www.paws-r-sdk.com/docs/configservice_describe_organization_config_rules/ for full documentation.
Usage
configservice_describe_organization_config_rules(
OrganizationConfigRuleNames = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
OrganizationConfigRuleNames |
The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules. |
Limit |
The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100. |
NextToken |
The |
Provides organization conformance pack deployment status for an organization
Description
Provides organization conformance pack deployment status for an organization.
See https://www.paws-r-sdk.com/docs/configservice_describe_organization_conformance_pack_statuses/ for full documentation.
Usage
configservice_describe_organization_conformance_pack_statuses(
OrganizationConformancePackNames = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
OrganizationConformancePackNames |
The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs. |
Limit |
The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100. |
NextToken |
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. |
Returns a list of organization conformance packs
Description
Returns a list of organization conformance packs.
See https://www.paws-r-sdk.com/docs/configservice_describe_organization_conformance_packs/ for full documentation.
Usage
configservice_describe_organization_conformance_packs(
OrganizationConformancePackNames = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
OrganizationConformancePackNames |
The name that you assign to an organization conformance pack. |
Limit |
The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100. |
NextToken |
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. |
Returns a list of all pending aggregation requests
Description
Returns a list of all pending aggregation requests.
See https://www.paws-r-sdk.com/docs/configservice_describe_pending_aggregation_requests/ for full documentation.
Usage
configservice_describe_pending_aggregation_requests(
Limit = NULL,
NextToken = NULL
)
Arguments
Limit |
The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default. |
NextToken |
The |
Returns the details of one or more remediation configurations
Description
Returns the details of one or more remediation configurations.
See https://www.paws-r-sdk.com/docs/configservice_describe_remediation_configurations/ for full documentation.
Usage
configservice_describe_remediation_configurations(ConfigRuleNames)
Arguments
ConfigRuleNames |
[required] A list of Config rule names of remediation configurations for which you want details. |
Returns the details of one or more remediation exceptions
Description
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
See https://www.paws-r-sdk.com/docs/configservice_describe_remediation_exceptions/ for full documentation.
Usage
configservice_describe_remediation_exceptions(
ConfigRuleName,
ResourceKeys = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigRuleName |
[required] The name of the Config rule. |
ResourceKeys |
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys. |
Limit |
The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default. |
NextToken |
The |
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed
Description
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
See https://www.paws-r-sdk.com/docs/configservice_describe_remediation_execution_status/ for full documentation.
Usage
configservice_describe_remediation_execution_status(
ConfigRuleName,
ResourceKeys = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigRuleName |
[required] The name of the Config rule. |
ResourceKeys |
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. |
Limit |
The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default. |
NextToken |
The |
Returns the details of one or more retention configurations
Description
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all the retention configurations for that account.
See https://www.paws-r-sdk.com/docs/configservice_describe_retention_configurations/ for full documentation.
Usage
configservice_describe_retention_configurations(
RetentionConfigurationNames = NULL,
NextToken = NULL
)
Arguments
RetentionConfigurationNames |
A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account. Currently, Config supports only one retention configuration per region in your account. |
NextToken |
The |
Removes all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording
Description
Removes all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording.
See https://www.paws-r-sdk.com/docs/configservice_disassociate_resource_types/ for full documentation.
Usage
configservice_disassociate_resource_types(
ConfigurationRecorderArn,
ResourceTypes
)
Arguments
ConfigurationRecorderArn |
[required] The Amazon Resource Name (ARN) of the specified configuration recorder. |
ResourceTypes |
[required] The list of resource types you want to remove from the recording group of the specified configuration recorder. |
Returns the evaluation results for the specified Config rule for a specific resource in a rule
Description
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
See https://www.paws-r-sdk.com/docs/configservice_get_aggregate_compliance_details_by_config_rule/ for full documentation.
Usage
configservice_get_aggregate_compliance_details_by_config_rule(
ConfigurationAggregatorName,
ConfigRuleName,
AccountId,
AwsRegion,
ComplianceType = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
ConfigRuleName |
[required] The name of the Config rule for which you want compliance information. |
AccountId |
[required] The 12-digit account ID of the source account. |
AwsRegion |
[required] The source region from where the data is aggregated. |
ComplianceType |
The resource compliance status. For the |
Limit |
The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
NextToken |
The |
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator
Description
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
See https://www.paws-r-sdk.com/docs/configservice_get_aggregate_config_rule_compliance_summary/ for full documentation.
Usage
configservice_get_aggregate_config_rule_compliance_summary(
ConfigurationAggregatorName,
Filters = NULL,
GroupByKey = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Filters |
Filters the results based on the ConfigRuleComplianceSummaryFilters object. |
GroupByKey |
Groups the result based on ACCOUNT_ID or AWS_REGION. |
Limit |
The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default. |
NextToken |
The |
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator
Description
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/configservice_get_aggregate_conformance_pack_compliance_summary/ for full documentation.
Usage
configservice_get_aggregate_conformance_pack_compliance_summary(
ConfigurationAggregatorName,
Filters = NULL,
GroupByKey = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Filters |
Filters the results based on the
|
GroupByKey |
Groups the result based on Amazon Web Services account ID or Amazon Web Services Region. |
Limit |
The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default. |
NextToken |
The |
Returns the resource counts across accounts and regions that are present in your Config aggregator
Description
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
See https://www.paws-r-sdk.com/docs/configservice_get_aggregate_discovered_resource_counts/ for full documentation.
Usage
configservice_get_aggregate_discovered_resource_counts(
ConfigurationAggregatorName,
Filters = NULL,
GroupByKey = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Filters |
Filters the results based on the |
GroupByKey |
The key to group the resource counts. |
Limit |
The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default. |
NextToken |
The |
Returns configuration item that is aggregated for your specific resource in a specific source account and region
Description
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
See https://www.paws-r-sdk.com/docs/configservice_get_aggregate_resource_config/ for full documentation.
Usage
configservice_get_aggregate_resource_config(
ConfigurationAggregatorName,
ResourceIdentifier
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
ResourceIdentifier |
[required] An object that identifies aggregate resource. |
Returns the evaluation results for the specified Config rule
Description
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
See https://www.paws-r-sdk.com/docs/configservice_get_compliance_details_by_config_rule/ for full documentation.
Usage
configservice_get_compliance_details_by_config_rule(
ConfigRuleName,
ComplianceTypes = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigRuleName |
[required] The name of the Config rule for which you want compliance information. |
ComplianceTypes |
Filters the results by compliance.
|
Limit |
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
NextToken |
The |
Returns the evaluation results for the specified Amazon Web Services resource
Description
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.
See https://www.paws-r-sdk.com/docs/configservice_get_compliance_details_by_resource/ for full documentation.
Usage
configservice_get_compliance_details_by_resource(
ResourceType = NULL,
ResourceId = NULL,
ComplianceTypes = NULL,
NextToken = NULL,
ResourceEvaluationId = NULL
)
Arguments
ResourceType |
The type of the Amazon Web Services resource for which you want compliance information. |
ResourceId |
The ID of the Amazon Web Services resource for which you want compliance information. |
ComplianceTypes |
Filters the results by compliance.
|
NextToken |
The |
ResourceEvaluationId |
The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results. You need to only provide either a |
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each
Description
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
See https://www.paws-r-sdk.com/docs/configservice_get_compliance_summary_by_config_rule/ for full documentation.
Usage
configservice_get_compliance_summary_by_config_rule()
Returns the number of resources that are compliant and the number that are noncompliant
Description
Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
See https://www.paws-r-sdk.com/docs/configservice_get_compliance_summary_by_resource_type/ for full documentation.
Usage
configservice_get_compliance_summary_by_resource_type(ResourceTypes = NULL)
Arguments
ResourceTypes |
Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type. For this request, you can specify an Amazon Web Services resource type
such as |
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack
Description
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
See https://www.paws-r-sdk.com/docs/configservice_get_conformance_pack_compliance_details/ for full documentation.
Usage
configservice_get_conformance_pack_compliance_details(
ConformancePackName,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConformancePackName |
[required] Name of the conformance pack. |
Filters |
A |
Limit |
The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100. |
NextToken |
The |
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack
Description
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
See https://www.paws-r-sdk.com/docs/configservice_get_conformance_pack_compliance_summary/ for full documentation.
Usage
configservice_get_conformance_pack_compliance_summary(
ConformancePackNames,
Limit = NULL,
NextToken = NULL
)
Arguments
ConformancePackNames |
[required] Names of conformance packs. |
Limit |
The maximum number of conformance packs returned on each page. |
NextToken |
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. |
Returns the policy definition containing the logic for your Config Custom Policy rule
Description
Returns the policy definition containing the logic for your Config Custom Policy rule.
See https://www.paws-r-sdk.com/docs/configservice_get_custom_rule_policy/ for full documentation.
Usage
configservice_get_custom_rule_policy(ConfigRuleName = NULL)
Arguments
ConfigRuleName |
The name of your Config Custom Policy rule. |
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account
Description
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/configservice_get_discovered_resource_counts/ for full documentation.
Usage
configservice_get_discovered_resource_counts(
resourceTypes = NULL,
limit = NULL,
nextToken = NULL
)
Arguments
resourceTypes |
The comma-separated list that specifies the resource types that you want
Config to return (for example, If a value for If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects. |
limit |
The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
nextToken |
The |
Returns detailed status for each member account within an organization for a given organization Config rule
Description
Returns detailed status for each member account within an organization for a given organization Config rule.
See https://www.paws-r-sdk.com/docs/configservice_get_organization_config_rule_detailed_status/ for full documentation.
Usage
configservice_get_organization_config_rule_detailed_status(
OrganizationConfigRuleName,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
OrganizationConfigRuleName |
[required] The name of your organization Config rule for which you want status details for member accounts. |
Filters |
A |
Limit |
The maximum number of |
NextToken |
The |
Returns detailed status for each member account within an organization for a given organization conformance pack
Description
Returns detailed status for each member account within an organization for a given organization conformance pack.
See https://www.paws-r-sdk.com/docs/configservice_get_organization_conformance_pack_detailed_status/ for full documentation.
Usage
configservice_get_organization_conformance_pack_detailed_status(
OrganizationConformancePackName,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
OrganizationConformancePackName |
[required] The name of organization conformance pack for which you want status details for member accounts. |
Filters |
An |
Limit |
The maximum number of |
NextToken |
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. |
Returns the policy definition containing the logic for your organization Config Custom Policy rule
Description
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
See https://www.paws-r-sdk.com/docs/configservice_get_organization_custom_rule_policy/ for full documentation.
Usage
configservice_get_organization_custom_rule_policy(OrganizationConfigRuleName)
Arguments
OrganizationConfigRuleName |
[required] The name of your organization Config Custom Policy rule. |
For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type
Description
For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type. For more information, see Selecting Which Resources Config Records.
See https://www.paws-r-sdk.com/docs/configservice_get_resource_config_history/ for full documentation.
Usage
configservice_get_resource_config_history(
resourceType,
resourceId,
laterTime = NULL,
earlierTime = NULL,
chronologicalOrder = NULL,
limit = NULL,
nextToken = NULL
)
Arguments
resourceType |
[required] The resource type. |
resourceId |
[required] The ID of the resource (for example., |
laterTime |
The chronologically latest time in the time range for which the history requested. If not specified, current time is taken. |
earlierTime |
The chronologically earliest time in the time range for which the history requested. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded. |
chronologicalOrder |
The chronological order for configuration items listed. By default, the results are listed in reverse chronological order. |
limit |
The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
nextToken |
The |
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run
Description
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
See https://www.paws-r-sdk.com/docs/configservice_get_resource_evaluation_summary/ for full documentation.
Usage
configservice_get_resource_evaluation_summary(ResourceEvaluationId)
Arguments
ResourceEvaluationId |
[required] The unique |
Returns the details of a specific stored query
Description
Returns the details of a specific stored query.
See https://www.paws-r-sdk.com/docs/configservice_get_stored_query/ for full documentation.
Usage
configservice_get_stored_query(QueryName)
Arguments
QueryName |
[required] The name of the query. |
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions
Description
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.
See https://www.paws-r-sdk.com/docs/configservice_list_aggregate_discovered_resources/ for full documentation.
Usage
configservice_list_aggregate_discovered_resources(
ConfigurationAggregatorName,
ResourceType,
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
ResourceType |
[required] The type of resources that you want Config to list in the response. |
Filters |
Filters the results based on the |
Limit |
The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
NextToken |
The |
Returns a list of configuration recorders depending on the filters you specify
Description
Returns a list of configuration recorders depending on the filters you specify.
See https://www.paws-r-sdk.com/docs/configservice_list_configuration_recorders/ for full documentation.
Usage
configservice_list_configuration_recorders(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
Filters the results based on a list of |
MaxResults |
The maximum number of results to include in the response. |
NextToken |
The |
Returns a list of conformance pack compliance scores
Description
Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
See https://www.paws-r-sdk.com/docs/configservice_list_conformance_pack_compliance_scores/ for full documentation.
Usage
configservice_list_conformance_pack_compliance_scores(
Filters = NULL,
SortOrder = NULL,
SortBy = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
Filters |
Filters the results based on the
|
SortOrder |
Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order. By default, conformance pack compliance scores are sorted in
alphabetical order by name of the conformance pack. Conformance pack
compliance scores are sorted in reverse alphabetical order if you enter
You can sort conformance pack compliance scores by the numerical value
of the compliance score by entering |
SortBy |
Sorts your conformance pack compliance scores in either ascending or
descending order, depending on By default, conformance pack compliance scores are sorted in
alphabetical order by name of the conformance pack. Enter |
Limit |
The maximum number of conformance pack compliance scores returned on each page. |
NextToken |
The |
Accepts a resource type and returns a list of resource identifiers for the resources of that type
Description
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
See https://www.paws-r-sdk.com/docs/configservice_list_discovered_resources/ for full documentation.
Usage
configservice_list_discovered_resources(
resourceType,
resourceIds = NULL,
resourceName = NULL,
limit = NULL,
includeDeletedResources = NULL,
nextToken = NULL
)
Arguments
resourceType |
[required] The type of resources that you want Config to list in the response. |
resourceIds |
The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds. |
resourceName |
The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered. |
limit |
The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
includeDeletedResources |
Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included. |
nextToken |
The |
Returns a list of proactive resource evaluations
Description
Returns a list of proactive resource evaluations.
See https://www.paws-r-sdk.com/docs/configservice_list_resource_evaluations/ for full documentation.
Usage
configservice_list_resource_evaluations(
Filters = NULL,
Limit = NULL,
NextToken = NULL
)
Arguments
Filters |
Returns a |
Limit |
The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default. |
NextToken |
The |
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region
Description
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
See https://www.paws-r-sdk.com/docs/configservice_list_stored_queries/ for full documentation.
Usage
configservice_list_stored_queries(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. |
MaxResults |
The maximum number of results to be returned with a single call. |
List the tags for Config resource
Description
List the tags for Config resource.
See https://www.paws-r-sdk.com/docs/configservice_list_tags_for_resource/ for full documentation.
Usage
configservice_list_tags_for_resource(
ResourceArn,
Limit = NULL,
NextToken = NULL
)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported:
|
Limit |
The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default. |
NextToken |
The |
Authorizes the aggregator account and region to collect data from the source account and region
Description
Authorizes the aggregator account and region to collect data from the source account and region.
See https://www.paws-r-sdk.com/docs/configservice_put_aggregation_authorization/ for full documentation.
Usage
configservice_put_aggregation_authorization(
AuthorizedAccountId,
AuthorizedAwsRegion,
Tags = NULL
)
Arguments
AuthorizedAccountId |
[required] The 12-digit account ID of the account authorized to aggregate data. |
AuthorizedAwsRegion |
[required] The region authorized to collect aggregated data. |
Tags |
An array of tag object. |
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations
Description
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
See https://www.paws-r-sdk.com/docs/configservice_put_config_rule/ for full documentation.
Usage
configservice_put_config_rule(ConfigRule, Tags = NULL)
Arguments
ConfigRule |
[required] The rule that you want to add to your account. |
Tags |
An array of tag object. |
Creates and updates the configuration aggregator with the selected source accounts and regions
Description
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
See https://www.paws-r-sdk.com/docs/configservice_put_configuration_aggregator/ for full documentation.
Usage
configservice_put_configuration_aggregator(
ConfigurationAggregatorName,
AccountAggregationSources = NULL,
OrganizationAggregationSource = NULL,
Tags = NULL,
AggregatorFilters = NULL
)
Arguments
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
AccountAggregationSources |
A list of AccountAggregationSource object. |
OrganizationAggregationSource |
An OrganizationAggregationSource object. |
Tags |
An array of tag object. |
AggregatorFilters |
An object to filter configuration recorders in an aggregator. Either
|
Creates or updates the customer managed configuration recorder
Description
Creates or updates the customer managed configuration recorder.
See https://www.paws-r-sdk.com/docs/configservice_put_configuration_recorder/ for full documentation.
Usage
configservice_put_configuration_recorder(ConfigurationRecorder, Tags = NULL)
Arguments
ConfigurationRecorder |
[required] An object for the configuration recorder. A configuration recorder records configuration changes for the resource types in scope. |
Tags |
The tags for the customer managed configuration recorder. Each tag consists of a key and an optional value, both of which you define. |
Creates or updates a conformance pack
Description
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
See https://www.paws-r-sdk.com/docs/configservice_put_conformance_pack/ for full documentation.
Usage
configservice_put_conformance_pack(
ConformancePackName,
TemplateS3Uri = NULL,
TemplateBody = NULL,
DeliveryS3Bucket = NULL,
DeliveryS3KeyPrefix = NULL,
ConformancePackInputParameters = NULL,
TemplateSSMDocumentDetails = NULL
)
Arguments
ConformancePackName |
[required] The unique name of the conformance pack you want to deploy. |
TemplateS3Uri |
The location of the file containing the template body
( You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed. |
TemplateBody |
A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes. You can use a YAML template with two resource types: Config rule
( |
DeliveryS3Bucket |
The name of the Amazon S3 bucket where Config stores conformance pack templates. This field is optional. |
DeliveryS3KeyPrefix |
The prefix for the Amazon S3 bucket. This field is optional. |
ConformancePackInputParameters |
A list of |
TemplateSSMDocumentDetails |
An object of type |
Creates or updates a delivery channel to deliver configuration information and other compliance information
Description
Creates or updates a delivery channel to deliver configuration information and other compliance information.
See https://www.paws-r-sdk.com/docs/configservice_put_delivery_channel/ for full documentation.
Usage
configservice_put_delivery_channel(DeliveryChannel)
Arguments
DeliveryChannel |
[required] An object for the delivery channel. A delivery channel sends notifications and updated configuration states. |
Used by an Lambda function to deliver evaluation results to Config
Description
Used by an Lambda function to deliver evaluation results to Config. This operation is required in every Lambda function that is invoked by an Config rule.
See https://www.paws-r-sdk.com/docs/configservice_put_evaluations/ for full documentation.
Usage
configservice_put_evaluations(Evaluations = NULL, ResultToken, TestMode = NULL)
Arguments
Evaluations |
The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function. |
ResultToken |
[required] An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation. |
TestMode |
Use this parameter to specify a test run for
When |
Add or updates the evaluations for process checks
Description
Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
See https://www.paws-r-sdk.com/docs/configservice_put_external_evaluation/ for full documentation.
Usage
configservice_put_external_evaluation(ConfigRuleName, ExternalEvaluation)
Arguments
ConfigRuleName |
[required] The name of the Config rule. |
ExternalEvaluation |
[required] An |
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations
Description
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.
See https://www.paws-r-sdk.com/docs/configservice_put_organization_config_rule/ for full documentation.
Usage
configservice_put_organization_config_rule(
OrganizationConfigRuleName,
OrganizationManagedRuleMetadata = NULL,
OrganizationCustomRuleMetadata = NULL,
ExcludedAccounts = NULL,
OrganizationCustomPolicyRuleMetadata = NULL
)
Arguments
OrganizationConfigRuleName |
[required] The name that you assign to an organization Config rule. |
OrganizationManagedRuleMetadata |
An |
OrganizationCustomRuleMetadata |
An |
ExcludedAccounts |
A comma-separated list of accounts that you want to exclude from an organization Config rule. |
OrganizationCustomPolicyRuleMetadata |
An |
Deploys conformance packs across member accounts in an Amazon Web Services Organization
Description
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
See https://www.paws-r-sdk.com/docs/configservice_put_organization_conformance_pack/ for full documentation.
Usage
configservice_put_organization_conformance_pack(
OrganizationConformancePackName,
TemplateS3Uri = NULL,
TemplateBody = NULL,
DeliveryS3Bucket = NULL,
DeliveryS3KeyPrefix = NULL,
ConformancePackInputParameters = NULL,
ExcludedAccounts = NULL
)
Arguments
OrganizationConformancePackName |
[required] Name of the organization conformance pack you want to create. |
TemplateS3Uri |
Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB). You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed. |
TemplateBody |
A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. |
DeliveryS3Bucket |
The name of the Amazon S3 bucket where Config stores conformance pack templates. This field is optional. If used, it must be prefixed with
|
DeliveryS3KeyPrefix |
The prefix for the Amazon S3 bucket. This field is optional. |
ConformancePackInputParameters |
A list of |
ExcludedAccounts |
A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack. |
Adds or updates the remediation configuration with a specific Config rule with the selected target or action
Description
Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
See https://www.paws-r-sdk.com/docs/configservice_put_remediation_configurations/ for full documentation.
Usage
configservice_put_remediation_configurations(RemediationConfigurations)
Arguments
RemediationConfigurations |
[required] A list of remediation configuration objects. |
A remediation exception is when a specified resource is no longer considered for auto-remediation
Description
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
See https://www.paws-r-sdk.com/docs/configservice_put_remediation_exceptions/ for full documentation.
Usage
configservice_put_remediation_exceptions(
ConfigRuleName,
ResourceKeys,
Message = NULL,
ExpirationTime = NULL
)
Arguments
ConfigRuleName |
[required] The name of the Config rule for which you want to create remediation exception. |
ResourceKeys |
[required] An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys. |
Message |
The message contains an explanation of the exception. |
ExpirationTime |
The exception is automatically deleted after the expiration date. |
Records the configuration state for the resource provided in the request
Description
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
See https://www.paws-r-sdk.com/docs/configservice_put_resource_config/ for full documentation.
Usage
configservice_put_resource_config(
ResourceType,
SchemaVersionId,
ResourceId,
ResourceName = NULL,
Configuration,
Tags = NULL
)
Arguments
ResourceType |
[required] The type of the resource. The custom resource type must be registered with CloudFormation. You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::. |
SchemaVersionId |
[required] Version of the schema registered for the ResourceType in CloudFormation. |
ResourceId |
[required] Unique identifier of the resource. |
ResourceName |
Name of the resource. |
Configuration |
[required] The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation. The configuration JSON must not exceed 64 KB. |
Tags |
Tags associated with the resource. This field is not to be confused with the Amazon Web Services-wide tag
feature for Amazon Web Services resources. Tags for
|
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information
Description
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.
See https://www.paws-r-sdk.com/docs/configservice_put_retention_configuration/ for full documentation.
Usage
configservice_put_retention_configuration(RetentionPeriodInDays)
Arguments
RetentionPeriodInDays |
[required] Number of days Config stores your historical information. Currently, only applicable to the configuration item history. |
Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify
Description
Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify.
See https://www.paws-r-sdk.com/docs/configservice_put_service_linked_configuration_recorder/ for full documentation.
Usage
configservice_put_service_linked_configuration_recorder(
ServicePrincipal,
Tags = NULL
)
Arguments
ServicePrincipal |
[required] The service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to create. |
Tags |
The tags for a service-linked configuration recorder. Each tag consists of a key and an optional value, both of which you define. |
Saves a new query or updates an existing saved query
Description
Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/configservice_put_stored_query/ for full documentation.
Usage
configservice_put_stored_query(StoredQuery, Tags = NULL)
Arguments
StoredQuery |
[required] A list of When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional. |
Tags |
A list of |
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties
Description
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
See https://www.paws-r-sdk.com/docs/configservice_select_aggregate_resource_config/ for full documentation.
Usage
configservice_select_aggregate_resource_config(
Expression,
ConfigurationAggregatorName,
Limit = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Expression |
[required] The SQL query SELECT command. |
ConfigurationAggregatorName |
[required] The name of the configuration aggregator. |
Limit |
The maximum number of query results returned on each page. |
MaxResults |
The maximum number of query results returned on each page. Config also allows the Limit request parameter. |
NextToken |
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. |
Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties
Description
Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.
See https://www.paws-r-sdk.com/docs/configservice_select_resource_config/ for full documentation.
Usage
configservice_select_resource_config(
Expression,
Limit = NULL,
NextToken = NULL
)
Arguments
Expression |
[required] The SQL query |
Limit |
The maximum number of query results returned on each page. |
NextToken |
The |
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources
Description
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use start_config_rules_evaluation when you want to test that a rule you updated is working as expected. start_config_rules_evaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.
See https://www.paws-r-sdk.com/docs/configservice_start_config_rules_evaluation/ for full documentation.
Usage
configservice_start_config_rules_evaluation(ConfigRuleNames = NULL)
Arguments
ConfigRuleNames |
The list of names of Config rules that you want to run evaluations for. |
Starts the customer managed configuration recorder
Description
Starts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify.
See https://www.paws-r-sdk.com/docs/configservice_start_configuration_recorder/ for full documentation.
Usage
configservice_start_configuration_recorder(ConfigurationRecorderName)
Arguments
ConfigurationRecorderName |
[required] The name of the customer managed configuration recorder that you want to start. |
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration
Description
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
See https://www.paws-r-sdk.com/docs/configservice_start_remediation_execution/ for full documentation.
Usage
configservice_start_remediation_execution(ConfigRuleName, ResourceKeys)
Arguments
ConfigRuleName |
[required] The list of names of Config rules that you want to run remediation execution for. |
ResourceKeys |
[required] A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. |
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules
Description
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
See https://www.paws-r-sdk.com/docs/configservice_start_resource_evaluation/ for full documentation.
Usage
configservice_start_resource_evaluation(
ResourceDetails,
EvaluationContext = NULL,
EvaluationMode,
EvaluationTimeout = NULL,
ClientToken = NULL
)
Arguments
ResourceDetails |
[required] Returns a |
EvaluationContext |
Returns an |
EvaluationMode |
[required] The mode of an evaluation. The valid values for this API are |
EvaluationTimeout |
The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default. |
ClientToken |
A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error. |
Stops the customer managed configuration recorder
Description
Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.
See https://www.paws-r-sdk.com/docs/configservice_stop_configuration_recorder/ for full documentation.
Usage
configservice_stop_configuration_recorder(ConfigurationRecorderName)
Arguments
ConfigurationRecorderName |
[required] The name of the customer managed configuration recorder that you want to stop. |
Associates the specified tags to a resource with the specified ResourceArn
Description
Associates the specified tags to a resource with the specified ResourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.
See https://www.paws-r-sdk.com/docs/configservice_tag_resource/ for full documentation.
Usage
configservice_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported:
|
Tags |
[required] An array of tag object. |
Deletes specified tags from a resource
Description
Deletes specified tags from a resource.
See https://www.paws-r-sdk.com/docs/configservice_untag_resource/ for full documentation.
Usage
configservice_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported:
|
TagKeys |
[required] The keys of the tags to be removed. |
AWS Control Tower
Description
Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.
To call these APIs, you'll need to know:
the
controlIdentifierfor the control–or guardrail–you are targeting.the ARN associated with the target organizational unit (OU), which we call the
targetIdentifier.the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control
Tower control:
The controlIdentifier is an ARN that is specified for each control.
You can view the controlIdentifier in the console on the Control
details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in
each Amazon Web Services Region for each control. You can find the
controlIdentifier for each Region and control in the Tables of control metadata
or the Control availability by Region tables
in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
-
ARN format for Amazon Web Services Control Tower:
arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED -
ARN format for Amazon Web Services Control Catalog:
arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide
, or in the Amazon Web Services Control Tower console, on the Control
details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as
get_enabled_control and
list_enabled_controls always
return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the "Actions" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an
organizational unit (OU) as a way to register the OU with Amazon Web
Services Control Tower, programmatically. For a general overview of this
capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the "Actions" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The
enable_controlanddisable_controlAPI operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.If you use an Amazon Web Services Control Tower identifier to call the
enable_controlAPI, and then callenable_controlagain with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to thedisable_controlAPI operation.Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
Usage
controltower(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- controltower(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_landing_zone | Creates a new landing zone |
| delete_landing_zone | Decommissions a landing zone |
| disable_baseline | Disable an EnabledBaseline resource on the specified Target |
| disable_control | This API call turns off a control |
| enable_baseline | Enable (apply) a Baseline to a Target |
| enable_control | This API call activates a control |
| get_baseline | Retrieve details about an existing Baseline resource by specifying its identifier |
| get_baseline_operation | Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline |
| get_control_operation | Returns the status of a particular EnableControl or DisableControl operation |
| get_enabled_baseline | Retrieve details of an EnabledBaseline resource by specifying its identifier |
| get_enabled_control | Retrieves details about an enabled control |
| get_landing_zone | Returns details about the landing zone |
| get_landing_zone_operation | Returns the status of the specified landing zone operation |
| list_baselines | Returns a summary list of all available baselines |
| list_control_operations | Provides a list of operations in progress or queued |
| list_enabled_baselines | Returns a list of summaries describing EnabledBaseline resources |
| list_enabled_controls | Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains |
| list_landing_zone_operations | Lists all landing zone operations from the past 90 days |
| list_landing_zones | Returns the landing zone ARN for the landing zone deployed in your managed account |
| list_tags_for_resource | Returns a list of tags associated with the resource |
| reset_enabled_baseline | Re-enables an EnabledBaseline resource |
| reset_enabled_control | Resets an enabled control |
| reset_landing_zone | This API call resets a landing zone |
| tag_resource | Applies tags to a resource |
| untag_resource | Removes tags from a resource |
| update_enabled_baseline | Updates an EnabledBaseline resource's applied parameters or version |
| update_enabled_control | Updates the configuration of an already enabled control |
| update_landing_zone | This API call updates the landing zone |
Examples
## Not run:
svc <- controltower()
svc$create_landing_zone(
Foo = 123
)
## End(Not run)
Creates a new landing zone
Description
Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
See https://www.paws-r-sdk.com/docs/controltower_create_landing_zone/ for full documentation.
Usage
controltower_create_landing_zone(manifest, tags = NULL, version)
Arguments
manifest |
[required] The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone. |
tags |
Tags to be applied to the landing zone. |
version |
[required] The landing zone version, for example, 3.0. |
Decommissions a landing zone
Description
Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
See https://www.paws-r-sdk.com/docs/controltower_delete_landing_zone/ for full documentation.
Usage
controltower_delete_landing_zone(landingZoneIdentifier)
Arguments
landingZoneIdentifier |
[required] The unique identifier of the landing zone. |
Disable an EnabledBaseline resource on the specified Target
Description
Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_disable_baseline/ for full documentation.
Usage
controltower_disable_baseline(enabledBaselineIdentifier)
Arguments
enabledBaselineIdentifier |
[required] Identifier of the |
This API call turns off a control
Description
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_disable_control/ for full documentation.
Usage
controltower_disable_control(controlIdentifier, targetIdentifier)
Arguments
controlIdentifier |
[required] The ARN of the control. Only Strongly recommended and Elective
controls are permitted, with the exception of the Region deny
control. For information on how to find the |
targetIdentifier |
[required] The ARN of the organizational unit. For information on how to find the
|
Enable (apply) a Baseline to a Target
Description
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_enable_baseline/ for full documentation.
Usage
controltower_enable_baseline(
baselineIdentifier,
baselineVersion,
parameters = NULL,
tags = NULL,
targetIdentifier
)
Arguments
baselineIdentifier |
[required] The ARN of the baseline to be enabled. |
baselineVersion |
[required] The specific version to be enabled of the specified baseline. |
parameters |
A list of |
tags |
Tags associated with input to
|
targetIdentifier |
[required] The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets. |
This API call activates a control
Description
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_enable_control/ for full documentation.
Usage
controltower_enable_control(
controlIdentifier,
parameters = NULL,
tags = NULL,
targetIdentifier
)
Arguments
controlIdentifier |
[required] The ARN of the control. Only Strongly recommended and Elective
controls are permitted, with the exception of the Region deny
control. For information on how to find the |
parameters |
A list of input parameter values, which are specified to configure the control when you enable it. |
tags |
Tags to be applied to the |
targetIdentifier |
[required] The ARN of the organizational unit. For information on how to find the
|
Retrieve details about an existing Baseline resource by specifying its identifier
Description
Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_get_baseline/ for full documentation.
Usage
controltower_get_baseline(baselineIdentifier)
Arguments
baselineIdentifier |
[required] The ARN of the |
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline
Description
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: enable_baseline, disable_baseline, update_enabled_baseline, reset_enabled_baseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_get_baseline_operation/ for full documentation.
Usage
controltower_get_baseline_operation(operationIdentifier)
Arguments
operationIdentifier |
[required] The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset). |
Returns the status of a particular EnableControl or DisableControl operation
Description
Returns the status of a particular enable_control or disable_control operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_get_control_operation/ for full documentation.
Usage
controltower_get_control_operation(operationIdentifier)
Arguments
operationIdentifier |
[required] The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days. |
Retrieve details of an EnabledBaseline resource by specifying its identifier
Description
Retrieve details of an EnabledBaseline resource by specifying its identifier.
See https://www.paws-r-sdk.com/docs/controltower_get_enabled_baseline/ for full documentation.
Usage
controltower_get_enabled_baseline(enabledBaselineIdentifier)
Arguments
enabledBaselineIdentifier |
[required] Identifier of the |
Retrieves details about an enabled control
Description
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_get_enabled_control/ for full documentation.
Usage
controltower_get_enabled_control(enabledControlIdentifier)
Arguments
enabledControlIdentifier |
[required] The |
Returns details about the landing zone
Description
Returns details about the landing zone. Displays a message in case of error.
See https://www.paws-r-sdk.com/docs/controltower_get_landing_zone/ for full documentation.
Usage
controltower_get_landing_zone(landingZoneIdentifier)
Arguments
landingZoneIdentifier |
[required] The unique identifier of the landing zone. |
Returns the status of the specified landing zone operation
Description
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
See https://www.paws-r-sdk.com/docs/controltower_get_landing_zone_operation/ for full documentation.
Usage
controltower_get_landing_zone_operation(operationIdentifier)
Arguments
operationIdentifier |
[required] A unique identifier assigned to a landing zone operation. |
Returns a summary list of all available baselines
Description
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_list_baselines/ for full documentation.
Usage
controltower_list_baselines(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results to be shown. |
nextToken |
A pagination token. |
Provides a list of operations in progress or queued
Description
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
See https://www.paws-r-sdk.com/docs/controltower_list_control_operations/ for full documentation.
Usage
controltower_list_control_operations(
filter = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
filter |
An input filter for the
|
maxResults |
The maximum number of results to be shown. |
nextToken |
A pagination token. |
Returns a list of summaries describing EnabledBaseline resources
Description
Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_list_enabled_baselines/ for full documentation.
Usage
controltower_list_enabled_baselines(
filter = NULL,
includeChildren = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
filter |
A filter applied on the |
includeChildren |
A value that can be set to include the child enabled baselines in responses. The default value is false. |
maxResults |
The maximum number of results to be shown. |
nextToken |
A pagination token. |
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains
Description
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_list_enabled_controls/ for full documentation.
Usage
controltower_list_enabled_controls(
filter = NULL,
maxResults = NULL,
nextToken = NULL,
targetIdentifier = NULL
)
Arguments
filter |
An input filter for the
|
maxResults |
How many results to return per API call. |
nextToken |
The token to continue the list from a previous API call with the same parameters. |
targetIdentifier |
The ARN of the organizational unit. For information on how to find the
|
Lists all landing zone operations from the past 90 days
Description
Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
See https://www.paws-r-sdk.com/docs/controltower_list_landing_zone_operations/ for full documentation.
Usage
controltower_list_landing_zone_operations(
filter = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
filter |
An input filter for the
|
maxResults |
How many results to return per API call. |
nextToken |
The token to continue the list from a previous API call with the same parameters. |
Returns the landing zone ARN for the landing zone deployed in your managed account
Description
Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
See https://www.paws-r-sdk.com/docs/controltower_list_landing_zones/ for full documentation.
Usage
controltower_list_landing_zones(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of returned landing zone ARNs, which is one. |
nextToken |
The token to continue the list from a previous API call with the same parameters. |
Returns a list of tags associated with the resource
Description
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_list_tags_for_resource/ for full documentation.
Usage
controltower_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The ARN of the resource. |
Re-enables an EnabledBaseline resource
Description
Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_reset_enabled_baseline/ for full documentation.
Usage
controltower_reset_enabled_baseline(enabledBaselineIdentifier)
Arguments
enabledBaselineIdentifier |
[required] Specifies the ID of the |
Resets an enabled control
Description
Resets an enabled control.
See https://www.paws-r-sdk.com/docs/controltower_reset_enabled_control/ for full documentation.
Usage
controltower_reset_enabled_control(enabledControlIdentifier)
Arguments
enabledControlIdentifier |
[required] The ARN of the enabled control to be reset. |
This API call resets a landing zone
Description
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
See https://www.paws-r-sdk.com/docs/controltower_reset_landing_zone/ for full documentation.
Usage
controltower_reset_landing_zone(landingZoneIdentifier)
Arguments
landingZoneIdentifier |
[required] The unique identifier of the landing zone. |
Applies tags to a resource
Description
Applies tags to a resource. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_tag_resource/ for full documentation.
Usage
controltower_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The ARN of the resource to be tagged. |
tags |
[required] Tags to be applied to the resource. |
Removes tags from a resource
Description
Removes tags from a resource. For usage examples, see the Controls Reference Guide .
See https://www.paws-r-sdk.com/docs/controltower_untag_resource/ for full documentation.
Usage
controltower_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The ARN of the resource. |
tagKeys |
[required] Tag keys to be removed from the resource. |
Updates an EnabledBaseline resource's applied parameters or version
Description
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
See https://www.paws-r-sdk.com/docs/controltower_update_enabled_baseline/ for full documentation.
Usage
controltower_update_enabled_baseline(
baselineVersion,
enabledBaselineIdentifier,
parameters = NULL
)
Arguments
baselineVersion |
[required] Specifies the new |
enabledBaselineIdentifier |
[required] Specifies the |
parameters |
Parameters to apply when making an update. |
Updates the configuration of an already enabled control
Description
Updates the configuration of an already enabled control.
See https://www.paws-r-sdk.com/docs/controltower_update_enabled_control/ for full documentation.
Usage
controltower_update_enabled_control(enabledControlIdentifier, parameters)
Arguments
enabledControlIdentifier |
[required] The ARN of the enabled control that will be updated. |
parameters |
[required] A key/value pair, where |
This API call updates the landing zone
Description
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
See https://www.paws-r-sdk.com/docs/controltower_update_landing_zone/ for full documentation.
Usage
controltower_update_landing_zone(landingZoneIdentifier, manifest, version)
Arguments
landingZoneIdentifier |
[required] The unique identifier of the landing zone. |
manifest |
[required] The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design. |
version |
[required] The landing zone version, for example, 3.2. |
FinSpace User Environment Management service
Description
The FinSpace management service provides the APIs for managing FinSpace environments.
Usage
finspace(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- finspace(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_environment | Create a new FinSpace environment |
| create_kx_changeset | Creates a changeset for a kdb database |
| create_kx_cluster | Creates a new kdb cluster |
| create_kx_database | Creates a new kdb database in the environment |
| create_kx_dataview | Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters |
| create_kx_environment | Creates a managed kdb environment for the account |
| create_kx_scaling_group | Creates a new scaling group |
| create_kx_user | Creates a user in FinSpace kdb environment with an associated IAM role |
| create_kx_volume | Creates a new volume with a specific amount of throughput and storage capacity |
| delete_environment | Delete an FinSpace environment |
| delete_kx_cluster | Deletes a kdb cluster |
| delete_kx_cluster_node | Deletes the specified nodes from a cluster |
| delete_kx_database | Deletes the specified database and all of its associated data |
| delete_kx_dataview | Deletes the specified dataview |
| delete_kx_environment | Deletes the kdb environment |
| delete_kx_scaling_group | Deletes the specified scaling group |
| delete_kx_user | Deletes a user in the specified kdb environment |
| delete_kx_volume | Deletes a volume |
| get_environment | Returns the FinSpace environment object |
| get_kx_changeset | Returns information about a kdb changeset |
| get_kx_cluster | Retrieves information about a kdb cluster |
| get_kx_connection_string | Retrieves a connection string for a user to connect to a kdb cluster |
| get_kx_database | Returns database information for the specified environment ID |
| get_kx_dataview | Retrieves details of the dataview |
| get_kx_environment | Retrieves all the information for the specified kdb environment |
| get_kx_scaling_group | Retrieves details of a scaling group |
| get_kx_user | Retrieves information about the specified kdb user |
| get_kx_volume | Retrieves the information about the volume |
| list_environments | A list of all of your FinSpace environments |
| list_kx_changesets | Returns a list of all the changesets for a database |
| list_kx_cluster_nodes | Lists all the nodes in a kdb cluster |
| list_kx_clusters | Returns a list of clusters |
| list_kx_databases | Returns a list of all the databases in the kdb environment |
| list_kx_dataviews | Returns a list of all the dataviews in the database |
| list_kx_environments | Returns a list of kdb environments created in an account |
| list_kx_scaling_groups | Returns a list of scaling groups in a kdb environment |
| list_kx_users | Lists all the users in a kdb environment |
| list_kx_volumes | Lists all the volumes in a kdb environment |
| list_tags_for_resource | A list of all tags for a resource |
| tag_resource | Adds metadata tags to a FinSpace resource |
| untag_resource | Removes metadata tags from a FinSpace resource |
| update_environment | Update your FinSpace environment |
| update_kx_cluster_code_configuration | Allows you to update code configuration on a running cluster |
| update_kx_cluster_databases | Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached |
| update_kx_database | Updates information for the given kdb database |
| update_kx_dataview | Updates the specified dataview |
| update_kx_environment | Updates information for the given kdb environment |
| update_kx_environment_network | Updates environment network to connect to your internal network by using a transit gateway |
| update_kx_user | Updates the user details |
| update_kx_volume | Updates the throughput or capacity of a volume |
Examples
## Not run:
svc <- finspace()
svc$create_environment(
Foo = 123
)
## End(Not run)
Create a new FinSpace environment
Description
Create a new FinSpace environment.
See https://www.paws-r-sdk.com/docs/finspace_create_environment/ for full documentation.
Usage
finspace_create_environment(
name,
description = NULL,
kmsKeyId = NULL,
tags = NULL,
federationMode = NULL,
federationParameters = NULL,
superuserParameters = NULL,
dataBundles = NULL
)
Arguments
name |
[required] The name of the FinSpace environment to be created. |
description |
The description of the FinSpace environment to be created. |
kmsKeyId |
The KMS key id to encrypt your data in the FinSpace environment. |
tags |
Add tags to your FinSpace environment. |
federationMode |
Authentication mode for the environment.
|
federationParameters |
Configuration information when authentication mode is FEDERATED. |
superuserParameters |
Configuration information for the superuser. |
dataBundles |
The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
|
Creates a changeset for a kdb database
Description
Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_changeset/ for full documentation.
Usage
finspace_create_kx_changeset(
environmentId,
databaseName,
changeRequests,
clientToken
)
Arguments
environmentId |
[required] A unique identifier of the kdb environment. |
databaseName |
[required] The name of the kdb database. |
changeRequests |
[required] A list of change request objects that are run in order. A change request
object consists of
All the change requests require a mandatory Here are few examples of how you can use the change request object:
|
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Creates a new kdb cluster
Description
Creates a new kdb cluster.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_cluster/ for full documentation.
Usage
finspace_create_kx_cluster(
clientToken = NULL,
environmentId,
clusterName,
clusterType,
tickerplantLogConfiguration = NULL,
databases = NULL,
cacheStorageConfigurations = NULL,
autoScalingConfiguration = NULL,
clusterDescription = NULL,
capacityConfiguration = NULL,
releaseLabel,
vpcConfiguration,
initializationScript = NULL,
commandLineArguments = NULL,
code = NULL,
executionRole = NULL,
savedownStorageConfiguration = NULL,
azMode,
availabilityZoneId = NULL,
tags = NULL,
scalingGroupConfiguration = NULL
)
Arguments
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
environmentId |
[required] A unique identifier for the kdb environment. |
clusterName |
[required] A unique name for the cluster that you want to create. |
clusterType |
[required] Specifies the type of KDB database that is being created. The following types are available:
|
tickerplantLogConfiguration |
A configuration to store Tickerplant logs. It consists of a list of
volumes that will be mounted to your cluster. For the cluster type
|
databases |
A list of databases that will be available for querying. |
cacheStorageConfigurations |
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. |
autoScalingConfiguration |
The configuration based on which FinSpace will scale in or scale out nodes in your cluster. |
clusterDescription |
A description of the cluster. |
capacityConfiguration |
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances. |
releaseLabel |
[required] The version of FinSpace managed kdb to run. |
vpcConfiguration |
[required] Configuration details about the network where the Privatelink endpoint of the cluster resides. |
initializationScript |
Specifies a Q program that will be run at launch of a cluster. It is a
relative path within .zip file that contains the custom code, which
will be loaded on the cluster. It must include the file name itself. For
example, |
commandLineArguments |
Defines the key-value pairs to make them available inside the cluster. |
code |
The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster. |
executionRole |
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster. |
savedownStorageConfiguration |
The size and type of the temporary storage that is used to hold data
during the savedown process. This parameter is required when you choose
|
azMode |
[required] The number of availability zones you want to assign per cluster. This can be one of the following
|
availabilityZoneId |
The availability zone identifiers for the requested regions. |
tags |
A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster. |
scalingGroupConfiguration |
The structure that stores the configuration details of a scaling group. |
Creates a new kdb database in the environment
Description
Creates a new kdb database in the environment.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_database/ for full documentation.
Usage
finspace_create_kx_database(
environmentId,
databaseName,
description = NULL,
tags = NULL,
clientToken
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
databaseName |
[required] The name of the kdb database. |
description |
A description of the database. |
tags |
A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database |
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters
Description
Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_dataview/ for full documentation.
Usage
finspace_create_kx_dataview(
environmentId,
databaseName,
dataviewName,
azMode,
availabilityZoneId = NULL,
changesetId = NULL,
segmentConfigurations = NULL,
autoUpdate = NULL,
readWrite = NULL,
description = NULL,
tags = NULL,
clientToken
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, where you want to create the dataview. |
databaseName |
[required] The name of the database where you want to create a dataview. |
dataviewName |
[required] A unique identifier for the dataview. |
azMode |
[required] The number of availability zones you want to assign per volume.
Currently, FinSpace only supports |
availabilityZoneId |
The identifier of the availability zones. |
changesetId |
A unique identifier of the changeset that you want to use to ingest data. |
segmentConfigurations |
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. |
autoUpdate |
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false. |
readWrite |
The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.
|
description |
A description of the dataview. |
tags |
A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview. |
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Creates a managed kdb environment for the account
Description
Creates a managed kdb environment for the account.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_environment/ for full documentation.
Usage
finspace_create_kx_environment(
name,
description = NULL,
kmsKeyId,
tags = NULL,
clientToken = NULL
)
Arguments
name |
[required] The name of the kdb environment that you want to create. |
description |
A description for the kdb environment. |
kmsKeyId |
[required] The KMS key ID to encrypt your data in the FinSpace environment. |
tags |
A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Creates a new scaling group
Description
Creates a new scaling group.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_scaling_group/ for full documentation.
Usage
finspace_create_kx_scaling_group(
clientToken,
environmentId,
scalingGroupName,
hostType,
availabilityZoneId,
tags = NULL
)
Arguments
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
environmentId |
[required] A unique identifier for the kdb environment, where you want to create the scaling group. |
scalingGroupName |
[required] A unique identifier for the kdb scaling group. |
hostType |
[required] The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. You can add one of the following values:
|
availabilityZoneId |
[required] The identifier of the availability zones. |
tags |
A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group. |
Creates a user in FinSpace kdb environment with an associated IAM role
Description
Creates a user in FinSpace kdb environment with an associated IAM role.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_user/ for full documentation.
Usage
finspace_create_kx_user(
environmentId,
userName,
iamRole,
tags = NULL,
clientToken = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment where you want to create a user. |
userName |
[required] A unique identifier for the user. |
iamRole |
[required] The IAM role ARN that will be associated with the user. |
tags |
A list of key-value pairs to label the user. You can add up to 50 tags to a user. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Creates a new volume with a specific amount of throughput and storage capacity
Description
Creates a new volume with a specific amount of throughput and storage capacity.
See https://www.paws-r-sdk.com/docs/finspace_create_kx_volume/ for full documentation.
Usage
finspace_create_kx_volume(
clientToken = NULL,
environmentId,
volumeType,
volumeName,
description = NULL,
nas1Configuration = NULL,
azMode,
availabilityZoneIds,
tags = NULL
)
Arguments
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
environmentId |
[required] A unique identifier for the kdb environment, whose clusters can attach to the volume. |
volumeType |
[required] The type of file system volume. Currently, FinSpace only supports
|
volumeName |
[required] A unique identifier for the volume. |
description |
A description of the volume. |
nas1Configuration |
Specifies the configuration for the Network attached storage (NAS_1)
file system volume. This parameter is required when you choose
|
azMode |
[required] The number of availability zones you want to assign per volume.
Currently, FinSpace only supports |
availabilityZoneIds |
[required] The identifier of the availability zones. |
tags |
A list of key-value pairs to label the volume. You can add up to 50 tags to a volume. |
Delete an FinSpace environment
Description
Delete an FinSpace environment.
See https://www.paws-r-sdk.com/docs/finspace_delete_environment/ for full documentation.
Usage
finspace_delete_environment(environmentId)
Arguments
environmentId |
[required] The identifier for the FinSpace environment. |
Deletes a kdb cluster
Description
Deletes a kdb cluster.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_cluster/ for full documentation.
Usage
finspace_delete_kx_cluster(environmentId, clusterName, clientToken = NULL)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
clusterName |
[required] The name of the cluster that you want to delete. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Deletes the specified nodes from a cluster
Description
Deletes the specified nodes from a cluster.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_cluster_node/ for full documentation.
Usage
finspace_delete_kx_cluster_node(environmentId, clusterName, nodeId)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
clusterName |
[required] The name of the cluster, for which you want to delete the nodes. |
nodeId |
[required] A unique identifier for the node that you want to delete. |
Deletes the specified database and all of its associated data
Description
Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_database/ for full documentation.
Usage
finspace_delete_kx_database(environmentId, databaseName, clientToken)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
databaseName |
[required] The name of the kdb database that you want to delete. |
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Deletes the specified dataview
Description
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_dataview/ for full documentation.
Usage
finspace_delete_kx_dataview(
environmentId,
databaseName,
dataviewName,
clientToken
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, from where you want to delete the dataview. |
databaseName |
[required] The name of the database whose dataview you want to delete. |
dataviewName |
[required] The name of the dataview that you want to delete. |
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Deletes the kdb environment
Description
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_environment/ for full documentation.
Usage
finspace_delete_kx_environment(environmentId, clientToken = NULL)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Deletes the specified scaling group
Description
Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_scaling_group/ for full documentation.
Usage
finspace_delete_kx_scaling_group(
environmentId,
scalingGroupName,
clientToken = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, from where you want to delete the dataview. |
scalingGroupName |
[required] A unique identifier for the kdb scaling group. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Deletes a user in the specified kdb environment
Description
Deletes a user in the specified kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_user/ for full documentation.
Usage
finspace_delete_kx_user(userName, environmentId, clientToken = NULL)
Arguments
userName |
[required] A unique identifier for the user that you want to delete. |
environmentId |
[required] A unique identifier for the kdb environment. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Deletes a volume
Description
Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.
See https://www.paws-r-sdk.com/docs/finspace_delete_kx_volume/ for full documentation.
Usage
finspace_delete_kx_volume(environmentId, volumeName, clientToken = NULL)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, whose clusters can attach to the volume. |
volumeName |
[required] The name of the volume that you want to delete. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Returns the FinSpace environment object
Description
Returns the FinSpace environment object.
See https://www.paws-r-sdk.com/docs/finspace_get_environment/ for full documentation.
Usage
finspace_get_environment(environmentId)
Arguments
environmentId |
[required] The identifier of the FinSpace environment. |
Returns information about a kdb changeset
Description
Returns information about a kdb changeset.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_changeset/ for full documentation.
Usage
finspace_get_kx_changeset(environmentId, databaseName, changesetId)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
databaseName |
[required] The name of the kdb database. |
changesetId |
[required] A unique identifier of the changeset for which you want to retrieve data. |
Retrieves information about a kdb cluster
Description
Retrieves information about a kdb cluster.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_cluster/ for full documentation.
Usage
finspace_get_kx_cluster(environmentId, clusterName)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
clusterName |
[required] The name of the cluster that you want to retrieve. |
Retrieves a connection string for a user to connect to a kdb cluster
Description
Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_connection_string/ for full documentation.
Usage
finspace_get_kx_connection_string(userArn, environmentId, clusterName)
Arguments
userArn |
[required] The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide. |
environmentId |
[required] A unique identifier for the kdb environment. |
clusterName |
[required] A name of the kdb cluster. |
Returns database information for the specified environment ID
Description
Returns database information for the specified environment ID.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_database/ for full documentation.
Usage
finspace_get_kx_database(environmentId, databaseName)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
databaseName |
[required] The name of the kdb database. |
Retrieves details of the dataview
Description
Retrieves details of the dataview.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_dataview/ for full documentation.
Usage
finspace_get_kx_dataview(environmentId, databaseName, dataviewName)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, from where you want to retrieve the dataview details. |
databaseName |
[required] The name of the database where you created the dataview. |
dataviewName |
[required] A unique identifier for the dataview. |
Retrieves all the information for the specified kdb environment
Description
Retrieves all the information for the specified kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_environment/ for full documentation.
Usage
finspace_get_kx_environment(environmentId)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
Retrieves details of a scaling group
Description
Retrieves details of a scaling group.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_scaling_group/ for full documentation.
Usage
finspace_get_kx_scaling_group(environmentId, scalingGroupName)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
scalingGroupName |
[required] A unique identifier for the kdb scaling group. |
Retrieves information about the specified kdb user
Description
Retrieves information about the specified kdb user.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_user/ for full documentation.
Usage
finspace_get_kx_user(userName, environmentId)
Arguments
userName |
[required] A unique identifier for the user. |
environmentId |
[required] A unique identifier for the kdb environment. |
Retrieves the information about the volume
Description
Retrieves the information about the volume.
See https://www.paws-r-sdk.com/docs/finspace_get_kx_volume/ for full documentation.
Usage
finspace_get_kx_volume(environmentId, volumeName)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, whose clusters can attach to the volume. |
volumeName |
[required] A unique identifier for the volume. |
A list of all of your FinSpace environments
Description
A list of all of your FinSpace environments.
See https://www.paws-r-sdk.com/docs/finspace_list_environments/ for full documentation.
Usage
finspace_list_environments(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
A token generated by FinSpace that specifies where to continue
pagination if a previous request was truncated. To get the next set of
pages, pass in the |
maxResults |
The maximum number of results to return in this request. |
Returns a list of all the changesets for a database
Description
Returns a list of all the changesets for a database.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_changesets/ for full documentation.
Usage
finspace_list_kx_changesets(
environmentId,
databaseName,
nextToken = NULL,
maxResults = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
databaseName |
[required] The name of the kdb database. |
nextToken |
A token that indicates where a results page should begin. |
maxResults |
The maximum number of results to return in this request. |
Lists all the nodes in a kdb cluster
Description
Lists all the nodes in a kdb cluster.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_cluster_nodes/ for full documentation.
Usage
finspace_list_kx_cluster_nodes(
environmentId,
clusterName,
nextToken = NULL,
maxResults = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
clusterName |
[required] A unique name for the cluster. |
nextToken |
A token that indicates where a results page should begin. |
maxResults |
The maximum number of results to return in this request. |
Returns a list of clusters
Description
Returns a list of clusters.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_clusters/ for full documentation.
Usage
finspace_list_kx_clusters(
environmentId,
clusterType = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
clusterType |
Specifies the type of KDB database that is being created. The following types are available:
|
maxResults |
The maximum number of results to return in this request. |
nextToken |
A token that indicates where a results page should begin. |
Returns a list of all the databases in the kdb environment
Description
Returns a list of all the databases in the kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_databases/ for full documentation.
Usage
finspace_list_kx_databases(environmentId, nextToken = NULL, maxResults = NULL)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
nextToken |
A token that indicates where a results page should begin. |
maxResults |
The maximum number of results to return in this request. |
Returns a list of all the dataviews in the database
Description
Returns a list of all the dataviews in the database.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_dataviews/ for full documentation.
Usage
finspace_list_kx_dataviews(
environmentId,
databaseName,
nextToken = NULL,
maxResults = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews. |
databaseName |
[required] The name of the database where the dataviews were created. |
nextToken |
A token that indicates where a results page should begin. |
maxResults |
The maximum number of results to return in this request. |
Returns a list of kdb environments created in an account
Description
Returns a list of kdb environments created in an account.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_environments/ for full documentation.
Usage
finspace_list_kx_environments(nextToken = NULL, maxResults = NULL)
Arguments
nextToken |
A token that indicates where a results page should begin. |
maxResults |
The maximum number of results to return in this request. |
Returns a list of scaling groups in a kdb environment
Description
Returns a list of scaling groups in a kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_scaling_groups/ for full documentation.
Usage
finspace_list_kx_scaling_groups(
environmentId,
maxResults = NULL,
nextToken = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups. |
maxResults |
The maximum number of results to return in this request. |
nextToken |
A token that indicates where a results page should begin. |
Lists all the users in a kdb environment
Description
Lists all the users in a kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_users/ for full documentation.
Usage
finspace_list_kx_users(environmentId, nextToken = NULL, maxResults = NULL)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
nextToken |
A token that indicates where a results page should begin. |
maxResults |
The maximum number of results to return in this request. |
Lists all the volumes in a kdb environment
Description
Lists all the volumes in a kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_list_kx_volumes/ for full documentation.
Usage
finspace_list_kx_volumes(
environmentId,
maxResults = NULL,
nextToken = NULL,
volumeType = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, whose clusters can attach to the volume. |
maxResults |
The maximum number of results to return in this request. |
nextToken |
A token that indicates where a results page should begin. |
volumeType |
The type of file system volume. Currently, FinSpace only supports
|
A list of all tags for a resource
Description
A list of all tags for a resource.
See https://www.paws-r-sdk.com/docs/finspace_list_tags_for_resource/ for full documentation.
Usage
finspace_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name of the resource. |
Adds metadata tags to a FinSpace resource
Description
Adds metadata tags to a FinSpace resource.
See https://www.paws-r-sdk.com/docs/finspace_tag_resource/ for full documentation.
Usage
finspace_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) for the resource. |
tags |
[required] One or more tags to be assigned to the resource. |
Removes metadata tags from a FinSpace resource
Description
Removes metadata tags from a FinSpace resource.
See https://www.paws-r-sdk.com/docs/finspace_untag_resource/ for full documentation.
Usage
finspace_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). |
tagKeys |
[required] The tag keys (names) of one or more tags to be removed. |
Update your FinSpace environment
Description
Update your FinSpace environment.
See https://www.paws-r-sdk.com/docs/finspace_update_environment/ for full documentation.
Usage
finspace_update_environment(
environmentId,
name = NULL,
description = NULL,
federationMode = NULL,
federationParameters = NULL
)
Arguments
environmentId |
[required] The identifier of the FinSpace environment. |
name |
The name of the environment. |
description |
The description of the environment. |
federationMode |
Authentication mode for the environment.
|
federationParameters |
Allows you to update code configuration on a running cluster
Description
Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_cluster_code_configuration/ for full documentation.
Usage
finspace_update_kx_cluster_code_configuration(
environmentId,
clusterName,
clientToken = NULL,
code,
initializationScript = NULL,
commandLineArguments = NULL,
deploymentConfiguration = NULL
)
Arguments
environmentId |
[required] A unique identifier of the kdb environment. |
clusterName |
[required] The name of the cluster. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
code |
[required] |
initializationScript |
Specifies a Q program that will be run at launch of a cluster. It is a
relative path within .zip file that contains the custom code, which
will be loaded on the cluster. It must include the file name itself. For
example, You cannot update this parameter for a |
commandLineArguments |
Specifies the key-value pairs to make them available inside the cluster. You cannot update this parameter for a |
deploymentConfiguration |
The configuration that allows you to choose how you want to update the code on a cluster. |
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached
Description
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_cluster_databases/ for full documentation.
Usage
finspace_update_kx_cluster_databases(
environmentId,
clusterName,
clientToken = NULL,
databases,
deploymentConfiguration = NULL
)
Arguments
environmentId |
[required] The unique identifier of a kdb environment. |
clusterName |
[required] A unique name for the cluster that you want to modify. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
databases |
[required] The structure of databases mounted on the cluster. |
deploymentConfiguration |
The configuration that allows you to choose how you want to update the databases on a cluster. |
Updates information for the given kdb database
Description
Updates information for the given kdb database.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_database/ for full documentation.
Usage
finspace_update_kx_database(
environmentId,
databaseName,
description = NULL,
clientToken
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
databaseName |
[required] The name of the kdb database. |
description |
A description of the database. |
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Updates the specified dataview
Description
Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
See https://www.paws-r-sdk.com/docs/finspace_update_kx_dataview/ for full documentation.
Usage
finspace_update_kx_dataview(
environmentId,
databaseName,
dataviewName,
description = NULL,
changesetId = NULL,
segmentConfigurations = NULL,
clientToken
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment, where you want to update the dataview. |
databaseName |
[required] The name of the database. |
dataviewName |
[required] The name of the dataview that you want to update. |
description |
The description for a dataview. |
changesetId |
A unique identifier for the changeset. |
segmentConfigurations |
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. |
clientToken |
[required] A token that ensures idempotency. This token expires in 10 minutes. |
Updates information for the given kdb environment
Description
Updates information for the given kdb environment.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_environment/ for full documentation.
Usage
finspace_update_kx_environment(
environmentId,
name = NULL,
description = NULL,
clientToken = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
name |
The name of the kdb environment. |
description |
A description of the kdb environment. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Updates environment network to connect to your internal network by using a transit gateway
Description
Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_environment_network/ for full documentation.
Usage
finspace_update_kx_environment_network(
environmentId,
transitGatewayConfiguration = NULL,
customDNSConfiguration = NULL,
clientToken = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
transitGatewayConfiguration |
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network. |
customDNSConfiguration |
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Updates the user details
Description
Updates the user details. You can only update the IAM role associated with a user.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_user/ for full documentation.
Usage
finspace_update_kx_user(environmentId, userName, iamRole, clientToken = NULL)
Arguments
environmentId |
[required] A unique identifier for the kdb environment. |
userName |
[required] A unique identifier for the user. |
iamRole |
[required] The IAM role ARN that is associated with the user. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
Updates the throughput or capacity of a volume
Description
Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.
See https://www.paws-r-sdk.com/docs/finspace_update_kx_volume/ for full documentation.
Usage
finspace_update_kx_volume(
environmentId,
volumeName,
description = NULL,
clientToken = NULL,
nas1Configuration = NULL
)
Arguments
environmentId |
[required] A unique identifier for the kdb environment where you created the storage volume. |
volumeName |
[required] A unique identifier for the volume. |
description |
A description of the volume. |
clientToken |
A token that ensures idempotency. This token expires in 10 minutes. |
nas1Configuration |
Specifies the configuration for the Network attached storage (NAS_1) file system volume. |
AWS Health APIs and Notifications
Description
Health
The Health API provides access to the Health information that appears in the Health Dashboard. You can use the API operations to get information about events that might affect your Amazon Web Services services and resources.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan
from Amazon Web Services Support to use the Health API.
If you call the Health API from an Amazon Web Services account that
doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan,
you receive a SubscriptionRequiredException error.
For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see Best practices for managing Amazon Web Services access keys in the Amazon Web Services General Reference.
You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Health API in the Health User Guide.
For authentication of requests, Health uses the Signature Version 4 Signing Process.
If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating Health events in the Health User Guide.
When you use the Health API operations to return Health events, see the following recommendations:
Use the eventScopeCode parameter to specify whether to return Health events that are public or account-specific.
Use pagination to view all events from the response. For example, if you call the
describe_events_for_organizationoperation to get all events in your organization, you might receive several page results. Specify thenextTokenin the next request to return more results.
Usage
health(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- health(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| describe_affected_accounts_for_organization | Returns a list of accounts in the organization from Organizations that are affected by the provided event |
| describe_affected_entities | Returns a list of entities that have been affected by the specified events, based on the specified filter criteria |
| describe_affected_entities_for_organization | Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria |
| describe_entity_aggregates | Returns the number of entities that are affected by each of the specified events |
| describe_entity_aggregates_for_organization | Returns a list of entity aggregates for your Organizations that are affected by each of the specified events |
| describe_event_aggregates | Returns the number of events of each event type (issue, scheduled change, and account notification) |
| describe_event_details | Returns detailed information about one or more specified events |
| describe_event_details_for_organization | Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization |
| describe_events | Returns information about events that meet the specified filter criteria |
| describe_events_for_organization | Returns information about events across your organization in Organizations |
| describe_event_types | Returns the event types that meet the specified filter criteria |
| describe_health_service_status_for_organization | This operation provides status information on enabling or disabling Health to work with your organization |
| disable_health_service_access_for_organization | Disables Health from working with Organizations |
| enable_health_service_access_for_organization | Enables Health to work with Organizations |
Examples
## Not run:
svc <- health()
svc$describe_affected_accounts_for_organization(
Foo = 123
)
## End(Not run)
Returns a list of accounts in the organization from Organizations that are affected by the provided event
Description
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
See https://www.paws-r-sdk.com/docs/health_describe_affected_accounts_for_organization/ for full documentation.
Usage
health_describe_affected_accounts_for_organization(
eventArn,
nextToken = NULL,
maxResults = NULL
)
Arguments
eventArn |
[required] The unique identifier for the event. The event ARN has the
For example, an event ARN might look like the following:
|
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. |
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria
Description
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
See https://www.paws-r-sdk.com/docs/health_describe_affected_entities/ for full documentation.
Usage
health_describe_affected_entities(
filter,
locale = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
filter |
[required] Values to narrow the results returned. At least one event ARN is required. |
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. |
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria
Description
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.
See https://www.paws-r-sdk.com/docs/health_describe_affected_entities_for_organization/ for full documentation.
Usage
health_describe_affected_entities_for_organization(
organizationEntityFilters = NULL,
locale = NULL,
nextToken = NULL,
maxResults = NULL,
organizationEntityAccountFilters = NULL
)
Arguments
organizationEntityFilters |
A JSON set of elements including the |
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. |
organizationEntityAccountFilters |
A JSON set of elements including the |
Returns the number of entities that are affected by each of the specified events
Description
Returns the number of entities that are affected by each of the specified events.
See https://www.paws-r-sdk.com/docs/health_describe_entity_aggregates/ for full documentation.
Usage
health_describe_entity_aggregates(eventArns = NULL)
Arguments
eventArns |
A list of event ARNs (unique identifiers). For example:
|
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events
Description
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
See https://www.paws-r-sdk.com/docs/health_describe_entity_aggregates_for_organization/ for full documentation.
Usage
health_describe_entity_aggregates_for_organization(
eventArns,
awsAccountIds = NULL
)
Arguments
eventArns |
[required] A list of event ARNs (unique identifiers). For example:
|
awsAccountIds |
A list of 12-digit Amazon Web Services account numbers that contains the affected entities. |
Returns the number of events of each event type (issue, scheduled change, and account notification)
Description
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
See https://www.paws-r-sdk.com/docs/health_describe_event_aggregates/ for full documentation.
Usage
health_describe_event_aggregates(
filter = NULL,
aggregateField,
maxResults = NULL,
nextToken = NULL
)
Arguments
filter |
Values to narrow the results returned. |
aggregateField |
[required] The only currently supported value is |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. |
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
Returns detailed information about one or more specified events
Description
Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by describe_events), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the describe_affected_entities operation.
See https://www.paws-r-sdk.com/docs/health_describe_event_details/ for full documentation.
Usage
health_describe_event_details(eventArns, locale = NULL)
Arguments
eventArns |
[required] A list of event ARNs (unique identifiers). For example:
|
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization
Description
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the describe_affected_entities_for_organization operation.
See https://www.paws-r-sdk.com/docs/health_describe_event_details_for_organization/ for full documentation.
Usage
health_describe_event_details_for_organization(
organizationEventDetailFilters,
locale = NULL
)
Arguments
organizationEventDetailFilters |
[required] A set of JSON elements that includes the |
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
Returns the event types that meet the specified filter criteria
Description
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Services service, and event code. The metadata for each event appears in the EventType object.
See https://www.paws-r-sdk.com/docs/health_describe_event_types/ for full documentation.
Usage
health_describe_event_types(
filter = NULL,
locale = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
filter |
Values to narrow the results returned. |
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. If you don't specify the |
Returns information about events that meet the specified filter criteria
Description
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the describe_event_details and describe_affected_entities operations.
See https://www.paws-r-sdk.com/docs/health_describe_events/ for full documentation.
Usage
health_describe_events(
filter = NULL,
nextToken = NULL,
maxResults = NULL,
locale = NULL
)
Arguments
filter |
Values to narrow the results returned. |
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. |
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
Returns information about events across your organization in Organizations
Description
Returns information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:
See https://www.paws-r-sdk.com/docs/health_describe_events_for_organization/ for full documentation.
Usage
health_describe_events_for_organization(
filter = NULL,
nextToken = NULL,
maxResults = NULL,
locale = NULL
)
Arguments
filter |
Values to narrow the results returned. |
nextToken |
If the results of a search are large, only a portion of the results are
returned, and a |
maxResults |
The maximum number of items to return in one batch, between 10 and 100, inclusive. |
locale |
The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
This operation provides status information on enabling or disabling Health to work with your organization
Description
This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.
See https://www.paws-r-sdk.com/docs/health_describe_health_service_status_for_organization/ for full documentation.
Usage
health_describe_health_service_status_for_organization()
Disables Health from working with Organizations
Description
Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the Health User Guide.
See https://www.paws-r-sdk.com/docs/health_disable_health_service_access_for_organization/ for full documentation.
Usage
health_disable_health_service_access_for_organization()
Enables Health to work with Organizations
Description
Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.
See https://www.paws-r-sdk.com/docs/health_enable_health_service_access_for_organization/ for full documentation.
Usage
health_enable_health_service_access_for_organization()
AWS License Manager
Description
License Manager makes it easier to manage licenses from software vendors across multiple Amazon Web Services accounts and on-premises servers.
Usage
licensemanager(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- licensemanager(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| accept_grant | Accepts the specified grant |
| check_in_license | Checks in the specified license |
| checkout_borrow_license | Checks out the specified license for offline use |
| checkout_license | Checks out the specified license |
| create_grant | Creates a grant for the specified license |
| create_grant_version | Creates a new version of the specified grant |
| create_license | Creates a license |
| create_license_configuration | Creates a license configuration |
| create_license_conversion_task_for_resource | Creates a new license conversion task |
| create_license_manager_report_generator | Creates a report generator |
| create_license_version | Creates a new version of the specified license |
| create_token | Creates a long-lived token |
| delete_grant | Deletes the specified grant |
| delete_license | Deletes the specified license |
| delete_license_configuration | Deletes the specified license configuration |
| delete_license_manager_report_generator | Deletes the specified report generator |
| delete_token | Deletes the specified token |
| extend_license_consumption | Extends the expiration date for license consumption |
| get_access_token | Gets a temporary access token to use with AssumeRoleWithWebIdentity |
| get_grant | Gets detailed information about the specified grant |
| get_license | Gets detailed information about the specified license |
| get_license_configuration | Gets detailed information about the specified license configuration |
| get_license_conversion_task | Gets information about the specified license type conversion task |
| get_license_manager_report_generator | Gets information about the specified report generator |
| get_license_usage | Gets detailed information about the usage of the specified license |
| get_service_settings | Gets the License Manager settings for the current Region |
| list_associations_for_license_configuration | Lists the resource associations for the specified license configuration |
| list_distributed_grants | Lists the grants distributed for the specified license |
| list_failures_for_license_configuration_operations | Lists the license configuration operations that failed |
| list_license_configurations | Lists the license configurations for your account |
| list_license_conversion_tasks | Lists the license type conversion tasks for your account |
| list_license_manager_report_generators | Lists the report generators for your account |
| list_licenses | Lists the licenses for your account |
| list_license_specifications_for_resource | Describes the license configurations for the specified resource |
| list_license_versions | Lists all versions of the specified license |
| list_received_grants | Lists grants that are received |
| list_received_grants_for_organization | Lists the grants received for all accounts in the organization |
| list_received_licenses | Lists received licenses |
| list_received_licenses_for_organization | Lists the licenses received for all accounts in the organization |
| list_resource_inventory | Lists resources managed using Systems Manager inventory |
| list_tags_for_resource | Lists the tags for the specified license configuration |
| list_tokens | Lists your tokens |
| list_usage_for_license_configuration | Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time |
| reject_grant | Rejects the specified grant |
| tag_resource | Adds the specified tags to the specified license configuration |
| untag_resource | Removes the specified tags from the specified license configuration |
| update_license_configuration | Modifies the attributes of an existing license configuration |
| update_license_manager_report_generator | Updates a report generator |
| update_license_specifications_for_resource | Adds or removes the specified license configurations for the specified Amazon Web Services resource |
| update_service_settings | Updates License Manager settings for the current Region |
Examples
## Not run:
svc <- licensemanager()
svc$accept_grant(
Foo = 123
)
## End(Not run)
Accepts the specified grant
Description
Accepts the specified grant.
See https://www.paws-r-sdk.com/docs/licensemanager_accept_grant/ for full documentation.
Usage
licensemanager_accept_grant(GrantArn)
Arguments
GrantArn |
[required] Amazon Resource Name (ARN) of the grant. |
Checks in the specified license
Description
Checks in the specified license. Check in a license when it is no longer in use.
See https://www.paws-r-sdk.com/docs/licensemanager_check_in_license/ for full documentation.
Usage
licensemanager_check_in_license(LicenseConsumptionToken, Beneficiary = NULL)
Arguments
LicenseConsumptionToken |
[required] License consumption token. |
Beneficiary |
License beneficiary. |
Checks out the specified license for offline use
Description
Checks out the specified license for offline use.
See https://www.paws-r-sdk.com/docs/licensemanager_checkout_borrow_license/ for full documentation.
Usage
licensemanager_checkout_borrow_license(
LicenseArn,
Entitlements,
DigitalSignatureMethod,
NodeId = NULL,
CheckoutMetadata = NULL,
ClientToken
)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration. |
Entitlements |
[required] License entitlements. Partial checkouts are not supported. |
DigitalSignatureMethod |
[required] Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS. |
NodeId |
Node ID. |
CheckoutMetadata |
Information about constraints. |
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
Checks out the specified license
Description
Checks out the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_checkout_license/ for full documentation.
Usage
licensemanager_checkout_license(
ProductSKU,
CheckoutType,
KeyFingerprint,
Entitlements,
ClientToken,
Beneficiary = NULL,
NodeId = NULL
)
Arguments
ProductSKU |
[required] Product SKU. |
CheckoutType |
[required] Checkout type. |
KeyFingerprint |
[required] Key fingerprint identifying the license. |
Entitlements |
[required] License entitlements. |
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
Beneficiary |
License beneficiary. |
NodeId |
Node ID. |
Creates a grant for the specified license
Description
Creates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.
See https://www.paws-r-sdk.com/docs/licensemanager_create_grant/ for full documentation.
Usage
licensemanager_create_grant(
ClientToken,
GrantName,
LicenseArn,
Principals,
HomeRegion,
AllowedOperations
)
Arguments
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
GrantName |
[required] Grant name. |
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. |
Principals |
[required] The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):
|
HomeRegion |
[required] Home Region of the grant. |
AllowedOperations |
[required] Allowed operations for the grant. |
Creates a new version of the specified grant
Description
Creates a new version of the specified grant. For more information, see Granted licenses in License Manager in the License Manager User Guide.
See https://www.paws-r-sdk.com/docs/licensemanager_create_grant_version/ for full documentation.
Usage
licensemanager_create_grant_version(
ClientToken,
GrantArn,
GrantName = NULL,
AllowedOperations = NULL,
Status = NULL,
StatusReason = NULL,
SourceVersion = NULL,
Options = NULL
)
Arguments
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
GrantArn |
[required] Amazon Resource Name (ARN) of the grant. |
GrantName |
Grant name. |
AllowedOperations |
Allowed operations for the grant. |
Status |
Grant status. |
StatusReason |
Grant status reason. |
SourceVersion |
Current version of the grant. |
Options |
The options specified for the grant. |
Creates a license
Description
Creates a license.
See https://www.paws-r-sdk.com/docs/licensemanager_create_license/ for full documentation.
Usage
licensemanager_create_license(
LicenseName,
ProductName,
ProductSKU,
Issuer,
HomeRegion,
Validity,
Entitlements,
Beneficiary,
ConsumptionConfiguration,
LicenseMetadata = NULL,
ClientToken
)
Arguments
LicenseName |
[required] License name. |
ProductName |
[required] Product name. |
ProductSKU |
[required] Product SKU. |
Issuer |
[required] License issuer. |
HomeRegion |
[required] Home Region for the license. |
Validity |
[required] Date and time range during which the license is valid, in ISO8601-UTC format. |
Entitlements |
[required] License entitlements. |
Beneficiary |
[required] License beneficiary. |
ConsumptionConfiguration |
[required] Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage. |
LicenseMetadata |
Information about the license. |
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
Creates a license configuration
Description
Creates a license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_create_license_configuration/ for full documentation.
Usage
licensemanager_create_license_configuration(
Name,
Description = NULL,
LicenseCountingType,
LicenseCount = NULL,
LicenseCountHardLimit = NULL,
LicenseRules = NULL,
Tags = NULL,
DisassociateWhenNotFound = NULL,
ProductInformationList = NULL
)
Arguments
Name |
[required] Name of the license configuration. |
Description |
Description of the license configuration. |
LicenseCountingType |
[required] Dimension used to track the license inventory. |
LicenseCount |
Number of licenses managed by the license configuration. |
LicenseCountHardLimit |
Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances. |
LicenseRules |
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
The unit for |
Tags |
Tags to add to the license configuration. |
DisassociateWhenNotFound |
When true, disassociates a resource when software is uninstalled. |
ProductInformationList |
Product information. |
Creates a new license conversion task
Description
Creates a new license conversion task.
See https://www.paws-r-sdk.com/docs/licensemanager_create_license_conversion_task_for_resource/ for full documentation.
Usage
licensemanager_create_license_conversion_task_for_resource(
ResourceArn,
SourceLicenseContext,
DestinationLicenseContext
)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the resource you are converting the license type for. |
SourceLicenseContext |
[required] Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the CLI in the License Manager User Guide. |
DestinationLicenseContext |
[required] Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the CLI in the License Manager User Guide. |
Creates a report generator
Description
Creates a report generator.
See https://www.paws-r-sdk.com/docs/licensemanager_create_license_manager_report_generator/ for full documentation.
Usage
licensemanager_create_license_manager_report_generator(
ReportGeneratorName,
Type,
ReportContext,
ReportFrequency,
ClientToken,
Description = NULL,
Tags = NULL
)
Arguments
ReportGeneratorName |
[required] Name of the report generator. |
Type |
[required] Type of reports to generate. The following report types an be generated:
|
ReportContext |
[required] Defines the type of license configuration the report generator tracks. |
ReportFrequency |
[required] Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly. |
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
Description |
Description of the report generator. |
Tags |
Tags to add to the report generator. |
Creates a new version of the specified license
Description
Creates a new version of the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_create_license_version/ for full documentation.
Usage
licensemanager_create_license_version(
LicenseArn,
LicenseName,
ProductName,
Issuer,
HomeRegion,
Validity,
LicenseMetadata = NULL,
Entitlements,
ConsumptionConfiguration,
Status,
ClientToken,
SourceVersion = NULL
)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. |
LicenseName |
[required] License name. |
ProductName |
[required] Product name. |
Issuer |
[required] License issuer. |
HomeRegion |
[required] Home Region of the license. |
Validity |
[required] Date and time range during which the license is valid, in ISO8601-UTC format. |
LicenseMetadata |
Information about the license. |
Entitlements |
[required] License entitlements. |
ConsumptionConfiguration |
[required] Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage. |
Status |
[required] License status. |
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
SourceVersion |
Current version of the license. |
Creates a long-lived token
Description
Creates a long-lived token.
See https://www.paws-r-sdk.com/docs/licensemanager_create_token/ for full documentation.
Usage
licensemanager_create_token(
LicenseArn,
RoleArns = NULL,
ExpirationInDays = NULL,
TokenProperties = NULL,
ClientToken
)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token. |
RoleArns |
Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use. |
ExpirationInDays |
Token expiration, in days, counted from token creation. The default is 365 days. |
TokenProperties |
Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token. |
ClientToken |
[required] Idempotency token, valid for 10 minutes. |
Deletes the specified grant
Description
Deletes the specified grant.
See https://www.paws-r-sdk.com/docs/licensemanager_delete_grant/ for full documentation.
Usage
licensemanager_delete_grant(GrantArn, StatusReason = NULL, Version)
Arguments
GrantArn |
[required] Amazon Resource Name (ARN) of the grant. |
StatusReason |
The Status reason for the delete request. |
Version |
[required] Current version of the grant. |
Deletes the specified license
Description
Deletes the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_delete_license/ for full documentation.
Usage
licensemanager_delete_license(LicenseArn, SourceVersion)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. |
SourceVersion |
[required] Current version of the license. |
Deletes the specified license configuration
Description
Deletes the specified license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_delete_license_configuration/ for full documentation.
Usage
licensemanager_delete_license_configuration(LicenseConfigurationArn)
Arguments
LicenseConfigurationArn |
[required] ID of the license configuration. |
Deletes the specified report generator
Description
Deletes the specified report generator.
See https://www.paws-r-sdk.com/docs/licensemanager_delete_license_manager_report_generator/ for full documentation.
Usage
licensemanager_delete_license_manager_report_generator(
LicenseManagerReportGeneratorArn
)
Arguments
LicenseManagerReportGeneratorArn |
[required] Amazon Resource Name (ARN) of the report generator to be deleted. |
Deletes the specified token
Description
Deletes the specified token. Must be called in the license home Region.
See https://www.paws-r-sdk.com/docs/licensemanager_delete_token/ for full documentation.
Usage
licensemanager_delete_token(TokenId)
Arguments
TokenId |
[required] Token ID. |
Extends the expiration date for license consumption
Description
Extends the expiration date for license consumption.
See https://www.paws-r-sdk.com/docs/licensemanager_extend_license_consumption/ for full documentation.
Usage
licensemanager_extend_license_consumption(
LicenseConsumptionToken,
DryRun = NULL
)
Arguments
LicenseConsumptionToken |
[required] License consumption token. |
DryRun |
Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions. |
Gets a temporary access token to use with AssumeRoleWithWebIdentity
Description
Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.
See https://www.paws-r-sdk.com/docs/licensemanager_get_access_token/ for full documentation.
Usage
licensemanager_get_access_token(Token, TokenProperties = NULL)
Arguments
Token |
[required] Refresh token, encoded as a JWT token. |
TokenProperties |
Token properties to validate against those present in the JWT token. |
Gets detailed information about the specified grant
Description
Gets detailed information about the specified grant.
See https://www.paws-r-sdk.com/docs/licensemanager_get_grant/ for full documentation.
Usage
licensemanager_get_grant(GrantArn, Version = NULL)
Arguments
GrantArn |
[required] Amazon Resource Name (ARN) of the grant. |
Version |
Grant version. |
Gets detailed information about the specified license
Description
Gets detailed information about the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_get_license/ for full documentation.
Usage
licensemanager_get_license(LicenseArn, Version = NULL)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. |
Version |
License version. |
Gets detailed information about the specified license configuration
Description
Gets detailed information about the specified license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_get_license_configuration/ for full documentation.
Usage
licensemanager_get_license_configuration(LicenseConfigurationArn)
Arguments
LicenseConfigurationArn |
[required] Amazon Resource Name (ARN) of the license configuration. |
Gets information about the specified license type conversion task
Description
Gets information about the specified license type conversion task.
See https://www.paws-r-sdk.com/docs/licensemanager_get_license_conversion_task/ for full documentation.
Usage
licensemanager_get_license_conversion_task(LicenseConversionTaskId)
Arguments
LicenseConversionTaskId |
[required] ID of the license type conversion task to retrieve information on. |
Gets information about the specified report generator
Description
Gets information about the specified report generator.
See https://www.paws-r-sdk.com/docs/licensemanager_get_license_manager_report_generator/ for full documentation.
Usage
licensemanager_get_license_manager_report_generator(
LicenseManagerReportGeneratorArn
)
Arguments
LicenseManagerReportGeneratorArn |
[required] Amazon Resource Name (ARN) of the report generator. |
Gets detailed information about the usage of the specified license
Description
Gets detailed information about the usage of the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_get_license_usage/ for full documentation.
Usage
licensemanager_get_license_usage(LicenseArn)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. |
Gets the License Manager settings for the current Region
Description
Gets the License Manager settings for the current Region.
See https://www.paws-r-sdk.com/docs/licensemanager_get_service_settings/ for full documentation.
Usage
licensemanager_get_service_settings()
Lists the resource associations for the specified license configuration
Description
Lists the resource associations for the specified license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_list_associations_for_license_configuration/ for full documentation.
Usage
licensemanager_list_associations_for_license_configuration(
LicenseConfigurationArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
LicenseConfigurationArn |
[required] Amazon Resource Name (ARN) of a license configuration. |
MaxResults |
Maximum number of results to return in a single call. |
NextToken |
Token for the next set of results. |
Lists the grants distributed for the specified license
Description
Lists the grants distributed for the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_list_distributed_grants/ for full documentation.
Usage
licensemanager_list_distributed_grants(
GrantArns = NULL,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
GrantArns |
Amazon Resource Names (ARNs) of the grants. |
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists the license configuration operations that failed
Description
Lists the license configuration operations that failed.
See https://www.paws-r-sdk.com/docs/licensemanager_list_failures_for_license_configuration_operations/ for full documentation.
Usage
licensemanager_list_failures_for_license_configuration_operations(
LicenseConfigurationArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
LicenseConfigurationArn |
[required] Amazon Resource Name of the license configuration. |
MaxResults |
Maximum number of results to return in a single call. |
NextToken |
Token for the next set of results. |
Lists the license configurations for your account
Description
Lists the license configurations for your account.
See https://www.paws-r-sdk.com/docs/licensemanager_list_license_configurations/ for full documentation.
Usage
licensemanager_list_license_configurations(
LicenseConfigurationArns = NULL,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
LicenseConfigurationArns |
Amazon Resource Names (ARN) of the license configurations. |
MaxResults |
Maximum number of results to return in a single call. |
NextToken |
Token for the next set of results. |
Filters |
Filters to scope the results. The following filters and logical operators are supported:
|
Lists the license type conversion tasks for your account
Description
Lists the license type conversion tasks for your account.
See https://www.paws-r-sdk.com/docs/licensemanager_list_license_conversion_tasks/ for full documentation.
Usage
licensemanager_list_license_conversion_tasks(
NextToken = NULL,
MaxResults = NULL,
Filters = NULL
)
Arguments
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Filters |
Filters to scope the results. Valid filters are |
Lists the report generators for your account
Description
Lists the report generators for your account.
See https://www.paws-r-sdk.com/docs/licensemanager_list_license_manager_report_generators/ for full documentation.
Usage
licensemanager_list_license_manager_report_generators(
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Describes the license configurations for the specified resource
Description
Describes the license configurations for the specified resource.
See https://www.paws-r-sdk.com/docs/licensemanager_list_license_specifications_for_resource/ for full documentation.
Usage
licensemanager_list_license_specifications_for_resource(
ResourceArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of a resource that has an associated license configuration. |
MaxResults |
Maximum number of results to return in a single call. |
NextToken |
Token for the next set of results. |
Lists all versions of the specified license
Description
Lists all versions of the specified license.
See https://www.paws-r-sdk.com/docs/licensemanager_list_license_versions/ for full documentation.
Usage
licensemanager_list_license_versions(
LicenseArn,
NextToken = NULL,
MaxResults = NULL
)
Arguments
LicenseArn |
[required] Amazon Resource Name (ARN) of the license. |
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists the licenses for your account
Description
Lists the licenses for your account.
See https://www.paws-r-sdk.com/docs/licensemanager_list_licenses/ for full documentation.
Usage
licensemanager_list_licenses(
LicenseArns = NULL,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
LicenseArns |
Amazon Resource Names (ARNs) of the licenses. |
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists grants that are received
Description
Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.
See https://www.paws-r-sdk.com/docs/licensemanager_list_received_grants/ for full documentation.
Usage
licensemanager_list_received_grants(
GrantArns = NULL,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
GrantArns |
Amazon Resource Names (ARNs) of the grants. |
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists the grants received for all accounts in the organization
Description
Lists the grants received for all accounts in the organization.
See https://www.paws-r-sdk.com/docs/licensemanager_list_received_grants_for_organization/ for full documentation.
Usage
licensemanager_list_received_grants_for_organization(
LicenseArn,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
LicenseArn |
[required] The Amazon Resource Name (ARN) of the received license. |
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists received licenses
Description
Lists received licenses.
See https://www.paws-r-sdk.com/docs/licensemanager_list_received_licenses/ for full documentation.
Usage
licensemanager_list_received_licenses(
LicenseArns = NULL,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
LicenseArns |
Amazon Resource Names (ARNs) of the licenses. |
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists the licenses received for all accounts in the organization
Description
Lists the licenses received for all accounts in the organization.
See https://www.paws-r-sdk.com/docs/licensemanager_list_received_licenses_for_organization/ for full documentation.
Usage
licensemanager_list_received_licenses_for_organization(
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filters |
Filters to scope the results. The following filters are supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists resources managed using Systems Manager inventory
Description
Lists resources managed using Systems Manager inventory.
See https://www.paws-r-sdk.com/docs/licensemanager_list_resource_inventory/ for full documentation.
Usage
licensemanager_list_resource_inventory(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
MaxResults |
Maximum number of results to return in a single call. |
NextToken |
Token for the next set of results. |
Filters |
Filters to scope the results. The following filters and logical operators are supported:
|
Lists the tags for the specified license configuration
Description
Lists the tags for the specified license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_list_tags_for_resource/ for full documentation.
Usage
licensemanager_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the license configuration. |
Lists your tokens
Description
Lists your tokens.
See https://www.paws-r-sdk.com/docs/licensemanager_list_tokens/ for full documentation.
Usage
licensemanager_list_tokens(
TokenIds = NULL,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
TokenIds |
Token IDs. |
Filters |
Filters to scope the results. The following filter is supported:
|
NextToken |
Token for the next set of results. |
MaxResults |
Maximum number of results to return in a single call. |
Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time
Description
Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_list_usage_for_license_configuration/ for full documentation.
Usage
licensemanager_list_usage_for_license_configuration(
LicenseConfigurationArn,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
LicenseConfigurationArn |
[required] Amazon Resource Name (ARN) of the license configuration. |
MaxResults |
Maximum number of results to return in a single call. |
NextToken |
Token for the next set of results. |
Filters |
Filters to scope the results. The following filters and logical operators are supported:
|
Rejects the specified grant
Description
Rejects the specified grant.
See https://www.paws-r-sdk.com/docs/licensemanager_reject_grant/ for full documentation.
Usage
licensemanager_reject_grant(GrantArn)
Arguments
GrantArn |
[required] Amazon Resource Name (ARN) of the grant. |
Adds the specified tags to the specified license configuration
Description
Adds the specified tags to the specified license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_tag_resource/ for full documentation.
Usage
licensemanager_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the license configuration. |
Tags |
[required] One or more tags. |
Removes the specified tags from the specified license configuration
Description
Removes the specified tags from the specified license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_untag_resource/ for full documentation.
Usage
licensemanager_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the license configuration. |
TagKeys |
[required] Keys identifying the tags to remove. |
Modifies the attributes of an existing license configuration
Description
Modifies the attributes of an existing license configuration.
See https://www.paws-r-sdk.com/docs/licensemanager_update_license_configuration/ for full documentation.
Usage
licensemanager_update_license_configuration(
LicenseConfigurationArn,
LicenseConfigurationStatus = NULL,
LicenseRules = NULL,
LicenseCount = NULL,
LicenseCountHardLimit = NULL,
Name = NULL,
Description = NULL,
ProductInformationList = NULL,
DisassociateWhenNotFound = NULL
)
Arguments
LicenseConfigurationArn |
[required] Amazon Resource Name (ARN) of the license configuration. |
LicenseConfigurationStatus |
New status of the license configuration. |
LicenseRules |
New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost. |
LicenseCount |
New number of licenses managed by the license configuration. |
LicenseCountHardLimit |
New hard limit of the number of available licenses. |
Name |
New name of the license configuration. |
Description |
New description of the license configuration. |
ProductInformationList |
New product information. |
DisassociateWhenNotFound |
When true, disassociates a resource when software is uninstalled. |
Updates a report generator
Description
Updates a report generator.
See https://www.paws-r-sdk.com/docs/licensemanager_update_license_manager_report_generator/ for full documentation.
Usage
licensemanager_update_license_manager_report_generator(
LicenseManagerReportGeneratorArn,
ReportGeneratorName,
Type,
ReportContext,
ReportFrequency,
ClientToken,
Description = NULL
)
Arguments
LicenseManagerReportGeneratorArn |
[required] Amazon Resource Name (ARN) of the report generator to update. |
ReportGeneratorName |
[required] Name of the report generator. |
Type |
[required] Type of reports to generate. The following report types are supported:
|
ReportContext |
[required] The report context. |
ReportFrequency |
[required] Frequency by which reports are generated. |
ClientToken |
[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
Description |
Description of the report generator. |
Adds or removes the specified license configurations for the specified Amazon Web Services resource
Description
Adds or removes the specified license configurations for the specified Amazon Web Services resource.
See https://www.paws-r-sdk.com/docs/licensemanager_update_license_specifications_for_resource/ for full documentation.
Usage
licensemanager_update_license_specifications_for_resource(
ResourceArn,
AddLicenseSpecifications = NULL,
RemoveLicenseSpecifications = NULL
)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the Amazon Web Services resource. |
AddLicenseSpecifications |
ARNs of the license configurations to add. |
RemoveLicenseSpecifications |
ARNs of the license configurations to remove. |
Updates License Manager settings for the current Region
Description
Updates License Manager settings for the current Region.
See https://www.paws-r-sdk.com/docs/licensemanager_update_service_settings/ for full documentation.
Usage
licensemanager_update_service_settings(
S3BucketArn = NULL,
SnsTopicArn = NULL,
OrganizationConfiguration = NULL,
EnableCrossAccountsDiscovery = NULL
)
Arguments
S3BucketArn |
Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored. |
SnsTopicArn |
Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts. |
OrganizationConfiguration |
Enables integration with Organizations for cross-account discovery. |
EnableCrossAccountsDiscovery |
Activates cross-account discovery. |
AWS License Manager Linux Subscriptions
Description
With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances.
Usage
licensemanagerlinuxsubscriptions(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- licensemanagerlinuxsubscriptions(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| deregister_subscription_provider | Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account |
| get_registered_subscription_provider | Get details for a Bring Your Own License (BYOL) subscription that's registered to your account |
| get_service_settings | Lists the Linux subscriptions service settings for your account |
| list_linux_subscription_instances | Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions |
| list_linux_subscriptions | Lists the Linux subscriptions that have been discovered |
| list_registered_subscription_providers | List Bring Your Own License (BYOL) subscription registration resources for your account |
| list_tags_for_resource | List the metadata tags that are assigned to the specified Amazon Web Services resource |
| register_subscription_provider | Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription |
| tag_resource | Add metadata tags to the specified Amazon Web Services resource |
| untag_resource | Remove one or more metadata tag from the specified Amazon Web Services resource |
| update_service_settings | Updates the service settings for Linux subscriptions |
Examples
## Not run:
svc <- licensemanagerlinuxsubscriptions()
svc$deregister_subscription_provider(
Foo = 123
)
## End(Not run)
Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account
Description
Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_deregister_subscription_provider/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_deregister_subscription_provider(
SubscriptionProviderArn
)
Arguments
SubscriptionProviderArn |
[required] The Amazon Resource Name (ARN) of the subscription provider resource to deregister. |
Get details for a Bring Your Own License (BYOL) subscription that's registered to your account
Description
Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_get_registered_subscription_provider/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_get_registered_subscription_provider(
SubscriptionProviderArn
)
Arguments
SubscriptionProviderArn |
[required] The Amazon Resource Name (ARN) of the BYOL registration resource to get details for. |
Lists the Linux subscriptions service settings for your account
Description
Lists the Linux subscriptions service settings for your account.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_get_service_settings/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_get_service_settings()
Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions
Description
Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_list_linux_subscription_instances/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_list_linux_subscription_instances(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
An array of structures that you can use to filter the results by your
specified criteria. For example, you can specify For each filter, you can specify one of the following values for the
For each filter, you can use one of the following
|
MaxResults |
The maximum items to return in a request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
Lists the Linux subscriptions that have been discovered
Description
Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_list_linux_subscriptions/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_list_linux_subscriptions(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
An array of structures that you can use to filter the results to those
that match one or more sets of key-value pairs that you specify. For
example, you can filter by the name of The valid names for this filter are:
The valid Operators for this filter are:
|
MaxResults |
The maximum items to return in a request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
List Bring Your Own License (BYOL) subscription registration resources for your account
Description
List Bring Your Own License (BYOL) subscription registration resources for your account.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_list_registered_subscription_providers/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_list_registered_subscription_providers(
MaxResults = NULL,
NextToken = NULL,
SubscriptionProviderSources = NULL
)
Arguments
MaxResults |
The maximum items to return in a request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
SubscriptionProviderSources |
To filter your results, specify which subscription providers to return in the list. |
List the metadata tags that are assigned to the specified Amazon Web Services resource
Description
List the metadata tags that are assigned to the specified Amazon Web Services resource.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_list_tags_for_resource/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource for which to list metadata tags. |
Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription
Description
Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_register_subscription_provider/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_register_subscription_provider(
SecretArn,
SubscriptionProviderSource,
Tags = NULL
)
Arguments
SecretArn |
[required] The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token. |
SubscriptionProviderSource |
[required] The supported Linux subscription provider to register. |
Tags |
The metadata tags to assign to your registered Linux subscription provider resource. |
Add metadata tags to the specified Amazon Web Services resource
Description
Add metadata tags to the specified Amazon Web Services resource.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_tag_resource/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags. |
tags |
[required] The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs. |
Remove one or more metadata tag from the specified Amazon Web Services resource
Description
Remove one or more metadata tag from the specified Amazon Web Services resource.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_untag_resource/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from. |
tagKeys |
[required] A list of metadata tag keys to remove from the requested resource. |
Updates the service settings for Linux subscriptions
Description
Updates the service settings for Linux subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerlinuxsubscriptions_update_service_settings/ for full documentation.
Usage
licensemanagerlinuxsubscriptions_update_service_settings(
AllowUpdate = NULL,
LinuxSubscriptionsDiscovery,
LinuxSubscriptionsDiscoverySettings
)
Arguments
AllowUpdate |
Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region. |
LinuxSubscriptionsDiscovery |
[required] Describes if the discovery of Linux subscriptions is enabled. |
LinuxSubscriptionsDiscoverySettings |
[required] The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from. |
AWS License Manager User Subscriptions
Description
With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.
Usage
licensemanagerusersubscriptions(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- licensemanagerusersubscriptions(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_user | Associates the user to an EC2 instance to utilize user-based subscriptions |
| create_license_server_endpoint | Creates a network endpoint for the Remote Desktop Services (RDS) license server |
| delete_license_server_endpoint | Deletes a LicenseServerEndpoint resource |
| deregister_identity_provider | Deregisters the Active Directory identity provider from License Manager user-based subscriptions |
| disassociate_user | Disassociates the user from an EC2 instance providing user-based subscriptions |
| list_identity_providers | Lists the Active Directory identity providers for user-based subscriptions |
| list_instances | Lists the EC2 instances providing user-based subscriptions |
| list_license_server_endpoints | List the Remote Desktop Services (RDS) License Server endpoints |
| list_product_subscriptions | Lists the user-based subscription products available from an identity provider |
| list_tags_for_resource | Returns the list of tags for the specified resource |
| list_user_associations | Lists user associations for an identity provider |
| register_identity_provider | Registers an identity provider for user-based subscriptions |
| start_product_subscription | Starts a product subscription for a user with the specified identity provider |
| stop_product_subscription | Stops a product subscription for a user with the specified identity provider |
| tag_resource | Adds tags to a resource |
| untag_resource | Removes tags from a resource |
| update_identity_provider_settings | Updates additional product configuration settings for the registered identity provider |
Examples
## Not run:
svc <- licensemanagerusersubscriptions()
svc$associate_user(
Foo = 123
)
## End(Not run)
Associates the user to an EC2 instance to utilize user-based subscriptions
Description
Associates the user to an EC2 instance to utilize user-based subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_associate_user/ for full documentation.
Usage
licensemanagerusersubscriptions_associate_user(
Domain = NULL,
IdentityProvider,
InstanceId,
Tags = NULL,
Username
)
Arguments
Domain |
The domain name of the Active Directory that contains information for the user to associate. |
IdentityProvider |
[required] The identity provider for the user. |
InstanceId |
[required] The ID of the EC2 instance that provides the user-based subscription. |
Tags |
The tags that apply for the user association. |
Username |
[required] The user name from the identity provider. |
Creates a network endpoint for the Remote Desktop Services (RDS) license server
Description
Creates a network endpoint for the Remote Desktop Services (RDS) license server.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_create_license_server_endpoint/ for full documentation.
Usage
licensemanagerusersubscriptions_create_license_server_endpoint(
IdentityProviderArn,
LicenseServerSettings,
Tags = NULL
)
Arguments
IdentityProviderArn |
[required] The Amazon Resource Name (ARN) that identifies the |
LicenseServerSettings |
[required] The |
Tags |
The tags that apply for the license server endpoint. |
Deletes a LicenseServerEndpoint resource
Description
Deletes a LicenseServerEndpoint resource.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_delete_license_server_endpoint/ for full documentation.
Usage
licensemanagerusersubscriptions_delete_license_server_endpoint(
LicenseServerEndpointArn,
ServerType
)
Arguments
LicenseServerEndpointArn |
[required] The Amazon Resource Name (ARN) that identifies the
|
ServerType |
[required] The type of License Server that the delete request refers to. |
Deregisters the Active Directory identity provider from License Manager user-based subscriptions
Description
Deregisters the Active Directory identity provider from License Manager user-based subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_deregister_identity_provider/ for full documentation.
Usage
licensemanagerusersubscriptions_deregister_identity_provider(
IdentityProvider = NULL,
IdentityProviderArn = NULL,
Product = NULL
)
Arguments
IdentityProvider |
An object that specifies details for the Active Directory identity provider. |
IdentityProviderArn |
The Amazon Resource Name (ARN) that identifies the identity provider to deregister. |
Product |
The name of the user-based subscription product. Valid values: |
Disassociates the user from an EC2 instance providing user-based subscriptions
Description
Disassociates the user from an EC2 instance providing user-based subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_disassociate_user/ for full documentation.
Usage
licensemanagerusersubscriptions_disassociate_user(
Domain = NULL,
IdentityProvider = NULL,
InstanceId = NULL,
InstanceUserArn = NULL,
Username = NULL
)
Arguments
Domain |
The domain name of the Active Directory that contains information for the user to disassociate. |
IdentityProvider |
An object that specifies details for the Active Directory identity provider. |
InstanceId |
The ID of the EC2 instance which provides user-based subscriptions. |
InstanceUserArn |
The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance. |
Username |
The user name from the Active Directory identity provider for the user. |
Lists the Active Directory identity providers for user-based subscriptions
Description
Lists the Active Directory identity providers for user-based subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_list_identity_providers/ for full documentation.
Usage
licensemanagerusersubscriptions_list_identity_providers(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
You can use the following filters to streamline results:
|
MaxResults |
The maximum number of results to return from a single request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
Lists the EC2 instances providing user-based subscriptions
Description
Lists the EC2 instances providing user-based subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_list_instances/ for full documentation.
Usage
licensemanagerusersubscriptions_list_instances(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
You can use the following filters to streamline results:
|
MaxResults |
The maximum number of results to return from a single request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
List the Remote Desktop Services (RDS) License Server endpoints
Description
List the Remote Desktop Services (RDS) License Server endpoints
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_list_license_server_endpoints/ for full documentation.
Usage
licensemanagerusersubscriptions_list_license_server_endpoints(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
You can use the following filters to streamline results:
|
MaxResults |
The maximum number of results to return from a single request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
Lists the user-based subscription products available from an identity provider
Description
Lists the user-based subscription products available from an identity provider.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_list_product_subscriptions/ for full documentation.
Usage
licensemanagerusersubscriptions_list_product_subscriptions(
Filters = NULL,
IdentityProvider,
MaxResults = NULL,
NextToken = NULL,
Product = NULL
)
Arguments
Filters |
You can use the following filters to streamline results:
|
IdentityProvider |
[required] An object that specifies details for the identity provider. |
MaxResults |
The maximum number of results to return from a single request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
Product |
The name of the user-based subscription product. Valid values: |
Returns the list of tags for the specified resource
Description
Returns the list of tags for the specified resource.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_list_tags_for_resource/ for full documentation.
Usage
licensemanagerusersubscriptions_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. |
Lists user associations for an identity provider
Description
Lists user associations for an identity provider.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_list_user_associations/ for full documentation.
Usage
licensemanagerusersubscriptions_list_user_associations(
Filters = NULL,
IdentityProvider,
InstanceId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
You can use the following filters to streamline results:
|
IdentityProvider |
[required] An object that specifies details for the identity provider. |
InstanceId |
[required] The ID of the EC2 instance, which provides user-based subscriptions. |
MaxResults |
The maximum number of results to return from a single request. |
NextToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
Registers an identity provider for user-based subscriptions
Description
Registers an identity provider for user-based subscriptions.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_register_identity_provider/ for full documentation.
Usage
licensemanagerusersubscriptions_register_identity_provider(
IdentityProvider,
Product,
Settings = NULL,
Tags = NULL
)
Arguments
IdentityProvider |
[required] An object that specifies details for the identity provider to register. |
Product |
[required] The name of the user-based subscription product. Valid values: |
Settings |
The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints. |
Tags |
The tags that apply to the identity provider's registration. |
Starts a product subscription for a user with the specified identity provider
Description
Starts a product subscription for a user with the specified identity provider.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_start_product_subscription/ for full documentation.
Usage
licensemanagerusersubscriptions_start_product_subscription(
Domain = NULL,
IdentityProvider,
Product,
Tags = NULL,
Username
)
Arguments
Domain |
The domain name of the Active Directory that contains the user for whom to start the product subscription. |
IdentityProvider |
[required] An object that specifies details for the identity provider. |
Product |
[required] The name of the user-based subscription product. Valid values: |
Tags |
The tags that apply to the product subscription. |
Username |
[required] The user name from the identity provider of the user. |
Stops a product subscription for a user with the specified identity provider
Description
Stops a product subscription for a user with the specified identity provider.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_stop_product_subscription/ for full documentation.
Usage
licensemanagerusersubscriptions_stop_product_subscription(
Domain = NULL,
IdentityProvider = NULL,
Product = NULL,
ProductUserArn = NULL,
Username = NULL
)
Arguments
Domain |
The domain name of the Active Directory that contains the user for whom to stop the product subscription. |
IdentityProvider |
An object that specifies details for the identity provider. |
Product |
The name of the user-based subscription product. Valid values: |
ProductUserArn |
The Amazon Resource Name (ARN) of the product user. |
Username |
The user name from the identity provider for the user. |
Adds tags to a resource
Description
Adds tags to a resource.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_tag_resource/ for full documentation.
Usage
licensemanagerusersubscriptions_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource that you want to tag. |
Tags |
[required] The tags to apply to the specified resource. |
Removes tags from a resource
Description
Removes tags from a resource.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_untag_resource/ for full documentation.
Usage
licensemanagerusersubscriptions_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource that you want to remove tags from. |
TagKeys |
[required] The tag keys to remove from the resource. |
Updates additional product configuration settings for the registered identity provider
Description
Updates additional product configuration settings for the registered identity provider.
See https://www.paws-r-sdk.com/docs/licensemanagerusersubscriptions_update_identity_provider_settings/ for full documentation.
Usage
licensemanagerusersubscriptions_update_identity_provider_settings(
IdentityProvider = NULL,
IdentityProviderArn = NULL,
Product = NULL,
UpdateSettings
)
Arguments
IdentityProvider |
|
IdentityProviderArn |
The Amazon Resource Name (ARN) of the identity provider to update. |
Product |
The name of the user-based subscription product. Valid values: |
UpdateSettings |
[required] Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:
|
Amazon Managed Grafana
Description
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.
With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
Usage
managedgrafana(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- managedgrafana(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_license | Assigns a Grafana Enterprise license to a workspace |
| create_workspace | Creates a workspace |
| create_workspace_api_key | Creates a Grafana API key for the workspace |
| create_workspace_service_account | Creates a service account for the workspace |
| create_workspace_service_account_token | Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account |
| delete_workspace | Deletes an Amazon Managed Grafana workspace |
| delete_workspace_api_key | Deletes a Grafana API key for the workspace |
| delete_workspace_service_account | Deletes a workspace service account from the workspace |
| delete_workspace_service_account_token | Deletes a token for the workspace service account |
| describe_workspace | Displays information about one Amazon Managed Grafana workspace |
| describe_workspace_authentication | Displays information about the authentication methods used in one Amazon Managed Grafana workspace |
| describe_workspace_configuration | Gets the current configuration string for the given workspace |
| disassociate_license | Removes the Grafana Enterprise license from a workspace |
| list_permissions | Lists the users and groups who have the Grafana Admin and Editor roles in this workspace |
| list_tags_for_resource | The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn |
| list_versions | Lists available versions of Grafana |
| list_workspaces | Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace |
| list_workspace_service_accounts | Returns a list of service accounts for a workspace |
| list_workspace_service_account_tokens | Returns a list of tokens for a workspace service account |
| tag_resource | The TagResource operation associates tags with an Amazon Managed Grafana resource |
| untag_resource | The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource |
| update_permissions | Updates which users in a workspace have the Grafana Admin or Editor roles |
| update_workspace | Modifies an existing Amazon Managed Grafana workspace |
| update_workspace_authentication | Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML |
| update_workspace_configuration | Updates the configuration string for the given workspace |
Examples
## Not run:
svc <- managedgrafana()
svc$associate_license(
Foo = 123
)
## End(Not run)
Assigns a Grafana Enterprise license to a workspace
Description
Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE for the licenseType, and pass in a valid Grafana Labs token for the grafanaToken. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
See https://www.paws-r-sdk.com/docs/managedgrafana_associate_license/ for full documentation.
Usage
managedgrafana_associate_license(grafanaToken = NULL, licenseType, workspaceId)
Arguments
grafanaToken |
A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see Link your account with Grafana Labs. |
licenseType |
[required] The type of license to associate with the workspace. Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. |
workspaceId |
[required] The ID of the workspace to associate the license with. |
Creates a workspace
Description
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
See https://www.paws-r-sdk.com/docs/managedgrafana_create_workspace/ for full documentation.
Usage
managedgrafana_create_workspace(
accountAccessType,
authenticationProviders,
clientToken = NULL,
configuration = NULL,
grafanaVersion = NULL,
networkAccessControl = NULL,
organizationRoleName = NULL,
permissionType,
stackSetName = NULL,
tags = NULL,
vpcConfiguration = NULL,
workspaceDataSources = NULL,
workspaceDescription = NULL,
workspaceName = NULL,
workspaceNotificationDestinations = NULL,
workspaceOrganizationalUnits = NULL,
workspaceRoleArn = NULL
)
Arguments
accountAccessType |
[required] Specifies whether the workspace can access Amazon Web Services resources
in this Amazon Web Services account only, or whether it can also access
Amazon Web Services resources in other accounts in the same
organization. If you specify |
authenticationProviders |
[required] Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana. |
clientToken |
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
configuration |
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace. |
grafanaVersion |
Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4). To get a list of supported versions, use the
|
networkAccessControl |
Configuration for network access to your workspace. When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required. If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required. |
organizationRoleName |
The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization. |
permissionType |
[required] When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels. You must also specify a The ability for Amazon Managed Grafana to create and update IAM roles on
behalf of the user is supported only in the Amazon Managed Grafana
console, where this value may be set to Use only the For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels. |
stackSetName |
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace. |
tags |
The list of tags associated with the workspace. |
vpcConfiguration |
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2). |
workspaceDataSources |
This parameter is for internal use only, and should not be used. |
workspaceDescription |
A description for the workspace. This is used only to help you identify this workspace. Pattern: |
workspaceName |
The name for the workspace. It does not have to be unique. |
workspaceNotificationDestinations |
Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels. |
workspaceOrganizationalUnits |
Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization. |
workspaceRoleArn |
Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added. |
Creates a Grafana API key for the workspace
Description
Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.
See https://www.paws-r-sdk.com/docs/managedgrafana_create_workspace_api_key/ for full documentation.
Usage
managedgrafana_create_workspace_api_key(
keyName,
keyRole,
secondsToLive,
workspaceId
)
Arguments
keyName |
[required] Specifies the name of the key. Keynames must be unique to the workspace. |
keyRole |
[required] Specifies the permission level of the key. Valid values: |
secondsToLive |
[required] Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days. |
workspaceId |
[required] The ID of the workspace to create an API key. |
Creates a service account for the workspace
Description
Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct GrafanaRole for your use case, use create_workspace_service_account_token to create a token that can be used to authenticate and authorize Grafana HTTP API calls.
See https://www.paws-r-sdk.com/docs/managedgrafana_create_workspace_service_account/ for full documentation.
Usage
managedgrafana_create_workspace_service_account(grafanaRole, name, workspaceId)
Arguments
grafanaRole |
[required] The permission level to use for this service account. For more information about the roles and the permissions each has, see User roles in the Amazon Managed Grafana User Guide. |
name |
[required] A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account. |
workspaceId |
[required] The ID of the workspace within which to create the service account. |
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account
Description
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.
See https://www.paws-r-sdk.com/docs/managedgrafana_create_workspace_service_account_token/ for full documentation.
Usage
managedgrafana_create_workspace_service_account_token(
name,
secondsToLive,
serviceAccountId,
workspaceId
)
Arguments
name |
[required] A name for the token to create. |
secondsToLive |
[required] Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future. |
serviceAccountId |
[required] The ID of the service account for which to create a token. |
workspaceId |
[required] The ID of the workspace the service account resides within. |
Deletes an Amazon Managed Grafana workspace
Description
Deletes an Amazon Managed Grafana workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_delete_workspace/ for full documentation.
Usage
managedgrafana_delete_workspace(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to delete. |
Deletes a Grafana API key for the workspace
Description
Deletes a Grafana API key for the workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_delete_workspace_api_key/ for full documentation.
Usage
managedgrafana_delete_workspace_api_key(keyName, workspaceId)
Arguments
keyName |
[required] The name of the API key to delete. |
workspaceId |
[required] The ID of the workspace to delete. |
Deletes a workspace service account from the workspace
Description
Deletes a workspace service account from the workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_delete_workspace_service_account/ for full documentation.
Usage
managedgrafana_delete_workspace_service_account(serviceAccountId, workspaceId)
Arguments
serviceAccountId |
[required] The ID of the service account to delete. |
workspaceId |
[required] The ID of the workspace where the service account resides. |
Deletes a token for the workspace service account
Description
Deletes a token for the workspace service account.
See https://www.paws-r-sdk.com/docs/managedgrafana_delete_workspace_service_account_token/ for full documentation.
Usage
managedgrafana_delete_workspace_service_account_token(
serviceAccountId,
tokenId,
workspaceId
)
Arguments
serviceAccountId |
[required] The ID of the service account from which to delete the token. |
tokenId |
[required] The ID of the token to delete. |
workspaceId |
[required] The ID of the workspace from which to delete the token. |
Displays information about one Amazon Managed Grafana workspace
Description
Displays information about one Amazon Managed Grafana workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_describe_workspace/ for full documentation.
Usage
managedgrafana_describe_workspace(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to display information about. |
Displays information about the authentication methods used in one Amazon Managed Grafana workspace
Description
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_describe_workspace_authentication/ for full documentation.
Usage
managedgrafana_describe_workspace_authentication(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to return authentication information about. |
Gets the current configuration string for the given workspace
Description
Gets the current configuration string for the given workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_describe_workspace_configuration/ for full documentation.
Usage
managedgrafana_describe_workspace_configuration(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to get configuration information for. |
Removes the Grafana Enterprise license from a workspace
Description
Removes the Grafana Enterprise license from a workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_disassociate_license/ for full documentation.
Usage
managedgrafana_disassociate_license(licenseType, workspaceId)
Arguments
licenseType |
[required] The type of license to remove from the workspace. |
workspaceId |
[required] The ID of the workspace to remove the Grafana Enterprise license from. |
Lists the users and groups who have the Grafana Admin and Editor roles in this workspace
Description
Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId.
See https://www.paws-r-sdk.com/docs/managedgrafana_list_permissions/ for full documentation.
Usage
managedgrafana_list_permissions(
groupId = NULL,
maxResults = NULL,
nextToken = NULL,
userId = NULL,
userType = NULL,
workspaceId
)
Arguments
groupId |
(Optional) Limits the results to only the group that matches this ID. |
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token to use when requesting the next set of results. You received
this token from a previous
|
userId |
(Optional) Limits the results to only the user that matches this ID. |
userType |
(Optional) If you specify |
workspaceId |
[required] The ID of the workspace to list permissions for. This parameter is required. |
The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn
Description
The list_tags_for_resource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be tagged is a workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_list_tags_for_resource/ for full documentation.
Usage
managedgrafana_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The ARN of the resource the list of tags are associated with. |
Lists available versions of Grafana
Description
Lists available versions of Grafana. These are available when calling create_workspace. Optionally, include a workspace to list the versions to which it can be upgraded.
See https://www.paws-r-sdk.com/docs/managedgrafana_list_versions/ for full documentation.
Usage
managedgrafana_list_versions(
maxResults = NULL,
nextToken = NULL,
workspaceId = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token to use when requesting the next set of results. You receive
this token from a previous
|
workspaceId |
The ID of the workspace to list the available upgrade versions. If not
included, lists all versions of Grafana that are supported for
|
Returns a list of tokens for a workspace service account
Description
Returns a list of tokens for a workspace service account.
See https://www.paws-r-sdk.com/docs/managedgrafana_list_workspace_service_account_tokens/ for full documentation.
Usage
managedgrafana_list_workspace_service_account_tokens(
maxResults = NULL,
nextToken = NULL,
serviceAccountId,
workspaceId
)
Arguments
maxResults |
The maximum number of tokens to include in the results. |
nextToken |
The token for the next set of service accounts to return. (You receive
this token from a previous
|
serviceAccountId |
[required] The ID of the service account for which to return tokens. |
workspaceId |
[required] The ID of the workspace for which to return tokens. |
Returns a list of service accounts for a workspace
Description
Returns a list of service accounts for a workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_list_workspace_service_accounts/ for full documentation.
Usage
managedgrafana_list_workspace_service_accounts(
maxResults = NULL,
nextToken = NULL,
workspaceId
)
Arguments
maxResults |
The maximum number of service accounts to include in the results. |
nextToken |
The token for the next set of service accounts to return. (You receive
this token from a previous
|
workspaceId |
[required] The workspace for which to list service accounts. |
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace
Description
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use describe_workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_list_workspaces/ for full documentation.
Usage
managedgrafana_list_workspaces(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of workspaces to include in the results. |
nextToken |
The token for the next set of workspaces to return. (You receive this
token from a previous
|
The TagResource operation associates tags with an Amazon Managed Grafana resource
Description
The tag_resource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces.
See https://www.paws-r-sdk.com/docs/managedgrafana_tag_resource/ for full documentation.
Usage
managedgrafana_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The ARN of the resource the tag is associated with. |
tags |
[required] The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags. |
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource
Description
The untag_resource operation removes the association of the tag with the Amazon Managed Grafana resource.
See https://www.paws-r-sdk.com/docs/managedgrafana_untag_resource/ for full documentation.
Usage
managedgrafana_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The ARN of the resource the tag association is removed from. |
tagKeys |
[required] The key values of the tag to be removed from the resource. |
Updates which users in a workspace have the Grafana Admin or Editor roles
Description
Updates which users in a workspace have the Grafana Admin or Editor roles.
See https://www.paws-r-sdk.com/docs/managedgrafana_update_permissions/ for full documentation.
Usage
managedgrafana_update_permissions(updateInstructionBatch, workspaceId)
Arguments
updateInstructionBatch |
[required] An array of structures that contain the permission updates to make. |
workspaceId |
[required] The ID of the workspace to update. |
Modifies an existing Amazon Managed Grafana workspace
Description
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
See https://www.paws-r-sdk.com/docs/managedgrafana_update_workspace/ for full documentation.
Usage
managedgrafana_update_workspace(
accountAccessType = NULL,
networkAccessControl = NULL,
organizationRoleName = NULL,
permissionType = NULL,
removeNetworkAccessConfiguration = NULL,
removeVpcConfiguration = NULL,
stackSetName = NULL,
vpcConfiguration = NULL,
workspaceDataSources = NULL,
workspaceDescription = NULL,
workspaceId,
workspaceName = NULL,
workspaceNotificationDestinations = NULL,
workspaceOrganizationalUnits = NULL,
workspaceRoleArn = NULL
)
Arguments
accountAccessType |
Specifies whether the workspace can access Amazon Web Services resources
in this Amazon Web Services account only, or whether it can also access
Amazon Web Services resources in other accounts in the same
organization. If you specify |
networkAccessControl |
The configuration settings for network access to your workspace. When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required. If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required. |
organizationRoleName |
The name of an IAM role that already exists to use to access resources
through Organizations. This can only be used with a workspace that has
the |
permissionType |
Use this parameter if you want to change a workspace from
If you specify this as For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels Do not use this to convert a You can convert a |
removeNetworkAccessConfiguration |
Whether to remove the network access configuration from the workspace. Setting this to If you remove this configuration by setting this to |
removeVpcConfiguration |
Whether to remove the VPC configuration from the workspace. Setting this to |
stackSetName |
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace. |
vpcConfiguration |
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
workspaceDataSources |
This parameter is for internal use only, and should not be used. |
workspaceDescription |
A description for the workspace. This is used only to help you identify this workspace. |
workspaceId |
[required] The ID of the workspace to update. |
workspaceName |
A new name for the workspace to update. |
workspaceNotificationDestinations |
Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels. |
workspaceOrganizationalUnits |
Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization. |
workspaceRoleArn |
Specifies an IAM role that grants permissions to Amazon Web Services
resources that the workspace accesses, such as data sources and
notification channels. If this workspace has |
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML
Description
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.
See https://www.paws-r-sdk.com/docs/managedgrafana_update_workspace_authentication/ for full documentation.
Usage
managedgrafana_update_workspace_authentication(
authenticationProviders,
samlConfiguration = NULL,
workspaceId
)
Arguments
authenticationProviders |
[required] Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana. |
samlConfiguration |
If the workspace uses SAML, use this structure to map SAML assertion
attributes to workspace user information and define which groups in the
assertion attribute are to have the |
workspaceId |
[required] The ID of the workspace to update the authentication for. |
Updates the configuration string for the given workspace
Description
Updates the configuration string for the given workspace
See https://www.paws-r-sdk.com/docs/managedgrafana_update_workspace_configuration/ for full documentation.
Usage
managedgrafana_update_workspace_configuration(
configuration,
grafanaVersion = NULL,
workspaceId
)
Arguments
configuration |
[required] The new configuration string for the workspace. For more information about the format and configuration options available, see Working in your Grafana workspace. |
grafanaVersion |
Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace. Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4). To know what versions are available to upgrade to for a specific
workspace, see the |
workspaceId |
[required] The ID of the workspace to update. |
AWS OpsWorks
Description
OpsWorks
Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes.
OpsWorks Stacks is an application management service that provides an integrated experience for managing the complete application lifecycle. For information about OpsWorks, see the OpsWorks information page.
SDKs and CLI
Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:
Endpoints
OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-west-3.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call create_stack,
clone_stack, or
update_stack we recommend you use the
ConfigurationManager parameter to specify the Chef version. The
recommended and default value for Linux stacks is currently 12. Windows
stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
Usage
opsworks(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- opsworks(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| assign_instance | Assign a registered instance to a layer |
| assign_volume | Assigns one of the stack's registered Amazon EBS volumes to a specified instance |
| associate_elastic_ip | Associates one of the stack's registered Elastic IP addresses with a specified instance |
| attach_elastic_load_balancer | Attaches an Elastic Load Balancing load balancer to a specified layer |
| clone_stack | Creates a clone of a specified stack |
| create_app | Creates an app for a specified stack |
| create_deployment | Runs deployment or stack commands |
| create_instance | Creates an instance in a specified stack |
| create_layer | Creates a layer |
| create_stack | Creates a new stack |
| create_user_profile | Creates a new user profile |
| delete_app | Deletes a specified app |
| delete_instance | Deletes a specified instance, which terminates the associated Amazon EC2 instance |
| delete_layer | Deletes a specified layer |
| delete_stack | Deletes a specified stack |
| delete_user_profile | Deletes a user profile |
| deregister_ecs_cluster | Deregisters a specified Amazon ECS cluster from a stack |
| deregister_elastic_ip | Deregisters a specified Elastic IP address |
| deregister_instance | Deregister an instance from OpsWorks Stacks |
| deregister_rds_db_instance | Deregisters an Amazon RDS instance |
| deregister_volume | Deregisters an Amazon EBS volume |
| describe_agent_versions | Describes the available OpsWorks Stacks agent versions |
| describe_apps | Requests a description of a specified set of apps |
| describe_commands | Describes the results of specified commands |
| describe_deployments | Requests a description of a specified set of deployments |
| describe_ecs_clusters | Describes Amazon ECS clusters that are registered with a stack |
| describe_elastic_ips | Describes Elastic IP addresses |
| describe_elastic_load_balancers | Describes a stack's Elastic Load Balancing instances |
| describe_instances | Requests a description of a set of instances |
| describe_layers | Requests a description of one or more layers in a specified stack |
| describe_load_based_auto_scaling | Describes load-based auto scaling configurations for specified layers |
| describe_my_user_profile | Describes a user's SSH information |
| describe_operating_systems | Describes the operating systems that are supported by OpsWorks Stacks |
| describe_permissions | Describes the permissions for a specified stack |
| describe_raid_arrays | Describe an instance's RAID arrays |
| describe_rds_db_instances | Describes Amazon RDS instances |
| describe_service_errors | Describes OpsWorks Stacks service errors |
| describe_stack_provisioning_parameters | Requests a description of a stack's provisioning parameters |
| describe_stacks | Requests a description of one or more stacks |
| describe_stack_summary | Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online |
| describe_time_based_auto_scaling | Describes time-based auto scaling configurations for specified instances |
| describe_user_profiles | Describe specified users |
| describe_volumes | Describes an instance's Amazon EBS volumes |
| detach_elastic_load_balancer | Detaches a specified Elastic Load Balancing instance from its layer |
| disassociate_elastic_ip | Disassociates an Elastic IP address from its instance |
| get_hostname_suggestion | Gets a generated host name for the specified layer, based on the current host name theme |
| grant_access | This action can be used only with Windows stacks |
| list_tags | Returns a list of tags that are applied to the specified stack or layer |
| reboot_instance | Reboots a specified instance |
| register_ecs_cluster | Registers a specified Amazon ECS cluster with a stack |
| register_elastic_ip | Registers an Elastic IP address with a specified stack |
| register_instance | Registers instances that were created outside of OpsWorks Stacks with a specified stack |
| register_rds_db_instance | Registers an Amazon RDS instance with a stack |
| register_volume | Registers an Amazon EBS volume with a specified stack |
| set_load_based_auto_scaling | Specify the load-based auto scaling configuration for a specified layer |
| set_permission | Specifies a user's permissions |
| set_time_based_auto_scaling | Specify the time-based auto scaling configuration for a specified instance |
| start_instance | Starts a specified instance |
| start_stack | Starts a stack's instances |
| stop_instance | Stops a specified instance |
| stop_stack | Stops a specified stack |
| tag_resource | Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks |
| unassign_instance | Unassigns a registered instance from all layers that are using the instance |
| unassign_volume | Unassigns an assigned Amazon EBS volume |
| untag_resource | Removes tags from a specified stack or layer |
| update_app | Updates a specified app |
| update_elastic_ip | Updates a registered Elastic IP address's name |
| update_instance | Updates a specified instance |
| update_layer | Updates a specified layer |
| update_my_user_profile | Updates a user's SSH public key |
| update_rds_db_instance | Updates an Amazon RDS instance |
| update_stack | Updates a specified stack |
| update_user_profile | Updates a specified user profile |
| update_volume | Updates an Amazon EBS volume's name or mount point |
Examples
## Not run:
svc <- opsworks()
svc$assign_instance(
Foo = 123
)
## End(Not run)
Assign a registered instance to a layer
Description
Assign a registered instance to a layer.
See https://www.paws-r-sdk.com/docs/opsworks_assign_instance/ for full documentation.
Usage
opsworks_assign_instance(InstanceId, LayerIds)
Arguments
InstanceId |
[required] The instance ID. |
LayerIds |
[required] The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer. |
Assigns one of the stack's registered Amazon EBS volumes to a specified instance
Description
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling register_volume. After you register the volume, you must call update_volume to specify a mount point before calling assign_volume. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_assign_volume/ for full documentation.
Usage
opsworks_assign_volume(VolumeId, InstanceId = NULL)
Arguments
VolumeId |
[required] The volume ID. |
InstanceId |
The instance ID. |
Associates one of the stack's registered Elastic IP addresses with a specified instance
Description
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling register_elastic_ip. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_associate_elastic_ip/ for full documentation.
Usage
opsworks_associate_elastic_ip(ElasticIp, InstanceId = NULL)
Arguments
ElasticIp |
[required] The Elastic IP address. |
InstanceId |
The instance ID. |
Attaches an Elastic Load Balancing load balancer to a specified layer
Description
Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see Elastic Load Balancing.
See https://www.paws-r-sdk.com/docs/opsworks_attach_elastic_load_balancer/ for full documentation.
Usage
opsworks_attach_elastic_load_balancer(ElasticLoadBalancerName, LayerId)
Arguments
ElasticLoadBalancerName |
[required] The Elastic Load Balancing instance's name. |
LayerId |
[required] The ID of the layer to which the Elastic Load Balancing instance is to be attached. |
Creates a clone of a specified stack
Description
Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
See https://www.paws-r-sdk.com/docs/opsworks_clone_stack/ for full documentation.
Usage
opsworks_clone_stack(
SourceStackId,
Name = NULL,
Region = NULL,
VpcId = NULL,
Attributes = NULL,
ServiceRoleArn,
DefaultInstanceProfileArn = NULL,
DefaultOs = NULL,
HostnameTheme = NULL,
DefaultAvailabilityZone = NULL,
DefaultSubnetId = NULL,
CustomJson = NULL,
ConfigurationManager = NULL,
ChefConfiguration = NULL,
UseCustomCookbooks = NULL,
UseOpsworksSecurityGroups = NULL,
CustomCookbooksSource = NULL,
DefaultSshKeyName = NULL,
ClonePermissions = NULL,
CloneAppIds = NULL,
DefaultRootDeviceType = NULL,
AgentVersion = NULL
)
Arguments
SourceStackId |
[required] The source stack ID. |
Name |
The cloned stack name. Stack names can be a maximum of 64 characters. |
Region |
The cloned stack Amazon Web Services Region, such as |
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 the VPC ID corresponds to a default VPC and you have specified either
the If you specify a nondefault VPC ID, note the following:
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms. |
Attributes |
A list of stack attributes and values as key/value pairs to be added to the cloned stack. |
ServiceRoleArn |
[required] The stack Identity and Access Management (IAM) role, which allows
OpsWorks Stacks to work with Amazon Web Services resources on your
behalf. You must set this parameter to the Amazon Resource Name (ARN)
for an existing IAM role. If you create a stack by using the OpsWorkss
Stacks console, it creates the role for you. You can obtain an existing
stack's IAM ARN programmatically by calling
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. |
DefaultInstanceProfileArn |
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. |
DefaultOs |
The stack's operating system, which must be set to one of the following.
The default option is the parent stack's operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux. |
HostnameTheme |
The stack's host name theme, with spaces are replaced by underscores.
The theme is used to generate host names for the stack's instances. By
default,
To obtain a generated host name, call |
DefaultAvailabilityZone |
The cloned stack's default Availability Zone, which must be in the
specified region. For more information, see Regions and Endpoints. If
you also specify a value for |
DefaultSubnetId |
The stack's default VPC subnet ID. This parameter is required if you
specify a value for the |
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:
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes |
ConfigurationManager |
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. |
ChefConfiguration |
A |
UseCustomCookbooks |
Whether to use custom cookbooks. |
UseOpsworksSecurityGroups |
Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of security groups, one for each
layer, which are associated with layers by default. With
For more information, see Create a New Stack. |
CustomCookbooksSource |
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. |
DefaultSshKeyName |
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. |
ClonePermissions |
Whether to clone the source stack's permissions. |
CloneAppIds |
A list of source stack app IDs to be included in the cloned stack. |
DefaultRootDeviceType |
The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. |
AgentVersion |
The default OpsWorks Stacks agent version. You have the following options:
The default setting is You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. |
Creates an app for a specified stack
Description
Creates an app for a specified stack. For more information, see Creating Apps.
See https://www.paws-r-sdk.com/docs/opsworks_create_app/ for full documentation.
Usage
opsworks_create_app(
StackId,
Shortname = NULL,
Name,
Description = NULL,
DataSources = NULL,
Type,
AppSource = NULL,
Domains = NULL,
EnableSsl = NULL,
SslConfiguration = NULL,
Attributes = NULL,
Environment = NULL
)
Arguments
StackId |
[required] The stack ID. |
Shortname |
The app's short name. |
Name |
[required] The app name. |
Description |
A description of the app. |
DataSources |
The app's data source. |
Type |
[required] The app type. Each supported type is associated with a particular layer.
For example, PHP applications are associated with a PHP layer. OpsWorks
Stacks deploys an application to those instances that are members of the
corresponding layer. If your app isn't one of the standard types, or you
prefer to implement your own Deploy recipes, specify |
AppSource |
A |
Domains |
The app virtual host settings, with multiple domains separated by
commas. For example: |
EnableSsl |
Whether to enable SSL for the app. |
SslConfiguration |
An |
Attributes |
One or more user-defined key/value pairs to be added to the stack attributes. |
Environment |
An array of 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. |
Runs deployment or stack commands
Description
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
See https://www.paws-r-sdk.com/docs/opsworks_create_deployment/ for full documentation.
Usage
opsworks_create_deployment(
StackId,
AppId = NULL,
InstanceIds = NULL,
LayerIds = NULL,
Command,
Comment = NULL,
CustomJson = NULL
)
Arguments
StackId |
[required] The stack ID. |
AppId |
The app ID. This parameter is required for app deployments, but not for other deployment commands. |
InstanceIds |
The instance IDs for the deployment targets. |
LayerIds |
The layer IDs for the deployment targets. |
Command |
[required] A |
Comment |
A user-defined comment. |
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:
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON. |
Creates an instance in a specified stack
Description
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
See https://www.paws-r-sdk.com/docs/opsworks_create_instance/ for full documentation.
Usage
opsworks_create_instance(
StackId,
LayerIds,
InstanceType,
AutoScalingType = NULL,
Hostname = NULL,
Os = NULL,
AmiId = NULL,
SshKeyName = NULL,
AvailabilityZone = NULL,
VirtualizationType = NULL,
SubnetId = NULL,
Architecture = NULL,
RootDeviceType = NULL,
BlockDeviceMappings = NULL,
InstallUpdatesOnBoot = NULL,
EbsOptimized = NULL,
AgentVersion = NULL,
Tenancy = NULL
)
Arguments
StackId |
[required] The stack ID. |
LayerIds |
[required] An array that contains the instance's layer IDs. |
InstanceType |
[required] The instance type, such as |
AutoScalingType |
For load-based or time-based instances, the type. Windows stacks can use only time-based instances. |
Hostname |
The instance host name. The following are character limits for instance host names.
|
Os |
The instance's operating system, which must be set to one of the following.
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see OpsWorks Stacks Operating Systems. The default option is the current Amazon Linux version. If you set this
parameter to |
AmiId |
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs. If you specify a custom AMI, you must set |
SshKeyName |
The instance's Amazon EC2 key-pair name. |
AvailabilityZone |
The instance Availability Zone. For more information, see Regions and Endpoints. |
VirtualizationType |
The instance's virtualization type, |
SubnetId |
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet. |
Architecture |
The instance architecture. The default option is |
RootDeviceType |
The instance root device type. For more information, see Storage for the Root Device. |
BlockDeviceMappings |
An array of |
InstallUpdatesOnBoot |
Whether to install operating system and package updates when the
instance boots. The default value is We strongly recommend using the default value of |
EbsOptimized |
Whether to create an Amazon EBS-optimized instance. |
AgentVersion |
The default OpsWorks Stacks agent version. You have the following options:
The default setting is |
Tenancy |
The instance's tenancy option. The default option is no tenancy, or if
the instance is running in a VPC, inherit tenancy settings from the VPC.
The following are valid values for this parameter: |
Creates a layer
Description
Creates a layer. For more information, see How to Create a Layer.
See https://www.paws-r-sdk.com/docs/opsworks_create_layer/ for full documentation.
Usage
opsworks_create_layer(
StackId,
Type,
Name,
Shortname,
Attributes = NULL,
CloudWatchLogsConfiguration = NULL,
CustomInstanceProfileArn = NULL,
CustomJson = NULL,
CustomSecurityGroupIds = NULL,
Packages = NULL,
VolumeConfigurations = NULL,
EnableAutoHealing = NULL,
AutoAssignElasticIps = NULL,
AutoAssignPublicIps = NULL,
CustomRecipes = NULL,
InstallUpdatesOnBoot = NULL,
UseEbsOptimizedInstances = NULL,
LifecycleEventConfiguration = NULL
)
Arguments
StackId |
[required] The layer stack ID. |
Type |
[required] The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. |
Name |
[required] The layer name, which is used by the console. Layer names can be a maximum of 32 characters. |
Shortname |
[required] For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef 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 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer Reference. |
Attributes |
One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the |
CloudWatchLogsConfiguration |
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. |
CustomInstanceProfileArn |
The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. |
CustomJson |
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. |
CustomSecurityGroupIds |
An array containing the layer custom security group IDs. |
Packages |
An array of |
VolumeConfigurations |
A |
EnableAutoHealing |
Whether to disable auto healing for the layer. |
AutoAssignElasticIps |
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. |
AutoAssignPublicIps |
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. |
CustomRecipes |
A |
InstallUpdatesOnBoot |
Whether to install operating system and package updates when the
instance boots. The default value is To ensure that your instances have the latest security updates, we
strongly recommend using the default value of |
UseEbsOptimizedInstances |
Whether to use Amazon EBS-optimized instances. |
LifecycleEventConfiguration |
A |
Creates a new stack
Description
Creates a new stack. For more information, see Create a New Stack.
See https://www.paws-r-sdk.com/docs/opsworks_create_stack/ for full documentation.
Usage
opsworks_create_stack(
Name,
Region,
VpcId = NULL,
Attributes = NULL,
ServiceRoleArn,
DefaultInstanceProfileArn,
DefaultOs = NULL,
HostnameTheme = NULL,
DefaultAvailabilityZone = NULL,
DefaultSubnetId = NULL,
CustomJson = NULL,
ConfigurationManager = NULL,
ChefConfiguration = NULL,
UseCustomCookbooks = NULL,
UseOpsworksSecurityGroups = NULL,
CustomCookbooksSource = NULL,
DefaultSshKeyName = NULL,
DefaultRootDeviceType = NULL,
AgentVersion = NULL
)
Arguments
Name |
[required] The stack name. Stack names can be a maximum of 64 characters. |
Region |
[required] The stack's Amazon Web Services Region, such as In the CLI, this API maps to the |
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 the VPC ID corresponds to a default VPC and you have specified either
the If you specify a nondefault VPC ID, note the following:
For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms. |
Attributes |
One or more user-defined key-value pairs to be added to the stack attributes. |
ServiceRoleArn |
[required] The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers. |
DefaultInstanceProfileArn |
[required] The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. |
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.
The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. |
HostnameTheme |
The stack's host name theme, with spaces replaced by underscores. The
theme is used to generate host names for the stack's instances. By
default,
To obtain a generated host name, call |
DefaultAvailabilityZone |
The stack's default Availability Zone, which must be in the specified
region. For more information, see Regions and Endpoints. If
you also specify a value for |
DefaultSubnetId |
The stack's default VPC subnet ID. This parameter is required if you
specify a value for the |
CustomJson |
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. |
ConfigurationManager |
The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. |
ChefConfiguration |
A |
UseCustomCookbooks |
Whether the stack uses custom cookbooks. |
UseOpsworksSecurityGroups |
Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in security groups, one
for each layer, which are associated with layers by default. With
For more information, see Create a New Stack. |
CustomCookbooksSource |
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. |
DefaultSshKeyName |
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. |
DefaultRootDeviceType |
The default root device type. This value is the default for all
instances in the stack, but you can override it when you create an
instance. The default option is |
AgentVersion |
The default OpsWorks Stacks agent version. You have the following options:
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
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. |
Creates a new user profile
Description
Creates a new user profile.
See https://www.paws-r-sdk.com/docs/opsworks_create_user_profile/ for full documentation.
Usage
opsworks_create_user_profile(
IamUserArn,
SshUsername = NULL,
SshPublicKey = NULL,
AllowSelfManagement = NULL
)
Arguments
IamUserArn |
[required] The user's IAM ARN; this can also be a federated user's ARN. |
SshUsername |
The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other punctuation
marks, OpsWorks Stacks removes them. For example, |
SshPublicKey |
The user's public SSH key. |
AllowSelfManagement |
Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key. |
Deletes a specified app
Description
Deletes a specified app.
See https://www.paws-r-sdk.com/docs/opsworks_delete_app/ for full documentation.
Usage
opsworks_delete_app(AppId)
Arguments
AppId |
[required] The app ID. |
Deletes a specified instance, which terminates the associated Amazon EC2 instance
Description
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
See https://www.paws-r-sdk.com/docs/opsworks_delete_instance/ for full documentation.
Usage
opsworks_delete_instance(
InstanceId,
DeleteElasticIp = NULL,
DeleteVolumes = NULL
)
Arguments
InstanceId |
[required] The instance ID. |
DeleteElasticIp |
Whether to delete the instance Elastic IP address. |
DeleteVolumes |
Whether to delete the instance's Amazon EBS volumes. |
Deletes a specified layer
Description
Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
See https://www.paws-r-sdk.com/docs/opsworks_delete_layer/ for full documentation.
Usage
opsworks_delete_layer(LayerId)
Arguments
LayerId |
[required] The layer ID. |
Deletes a specified stack
Description
Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
See https://www.paws-r-sdk.com/docs/opsworks_delete_stack/ for full documentation.
Usage
opsworks_delete_stack(StackId)
Arguments
StackId |
[required] The stack ID. |
Deletes a user profile
Description
Deletes a user profile.
See https://www.paws-r-sdk.com/docs/opsworks_delete_user_profile/ for full documentation.
Usage
opsworks_delete_user_profile(IamUserArn)
Arguments
IamUserArn |
[required] The user's IAM ARN. This can also be a federated user's ARN. |
Deregisters a specified Amazon ECS cluster from a stack
Description
Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_deregister_ecs_cluster/ for full documentation.
Usage
opsworks_deregister_ecs_cluster(EcsClusterArn)
Arguments
EcsClusterArn |
[required] The cluster's Amazon Resource Number (ARN). |
Deregisters a specified Elastic IP address
Description
Deregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_deregister_elastic_ip/ for full documentation.
Usage
opsworks_deregister_elastic_ip(ElasticIp)
Arguments
ElasticIp |
[required] The Elastic IP address. |
Deregister an instance from OpsWorks Stacks
Description
Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.
See https://www.paws-r-sdk.com/docs/opsworks_deregister_instance/ for full documentation.
Usage
opsworks_deregister_instance(InstanceId)
Arguments
InstanceId |
[required] The instance ID. |
Deregisters an Amazon RDS instance
Description
Deregisters an Amazon RDS instance.
See https://www.paws-r-sdk.com/docs/opsworks_deregister_rds_db_instance/ for full documentation.
Usage
opsworks_deregister_rds_db_instance(RdsDbInstanceArn)
Arguments
RdsDbInstanceArn |
[required] The Amazon RDS instance's ARN. |
Deregisters an Amazon EBS volume
Description
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_deregister_volume/ for full documentation.
Usage
opsworks_deregister_volume(VolumeId)
Arguments
VolumeId |
[required] The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID. |
Describes the available OpsWorks Stacks agent versions
Description
Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. describe_agent_versions returns a list of available agent versions for the specified stack or configuration manager.
See https://www.paws-r-sdk.com/docs/opsworks_describe_agent_versions/ for full documentation.
Usage
opsworks_describe_agent_versions(StackId = NULL, ConfigurationManager = NULL)
Arguments
StackId |
The stack ID. |
ConfigurationManager |
The configuration manager. |
Requests a description of a specified set of apps
Description
Requests a description of a specified set of apps.
See https://www.paws-r-sdk.com/docs/opsworks_describe_apps/ for full documentation.
Usage
opsworks_describe_apps(StackId = NULL, AppIds = NULL)
Arguments
StackId |
The app stack ID. If you use this parameter,
|
AppIds |
An array of app IDs for the apps to be described. If you use this
parameter, |
Describes the results of specified commands
Description
Describes the results of specified commands.
See https://www.paws-r-sdk.com/docs/opsworks_describe_commands/ for full documentation.
Usage
opsworks_describe_commands(
DeploymentId = NULL,
InstanceId = NULL,
CommandIds = NULL
)
Arguments
DeploymentId |
The deployment ID. If you include this parameter,
|
InstanceId |
The instance ID. If you include this parameter,
|
CommandIds |
An array of command IDs. If you include this parameter,
|
Requests a description of a specified set of deployments
Description
Requests a description of a specified set of deployments.
See https://www.paws-r-sdk.com/docs/opsworks_describe_deployments/ for full documentation.
Usage
opsworks_describe_deployments(
StackId = NULL,
AppId = NULL,
DeploymentIds = NULL
)
Arguments
StackId |
The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack. |
AppId |
The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app. |
DeploymentIds |
An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment. |
Describes Amazon ECS clusters that are registered with a stack
Description
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
See https://www.paws-r-sdk.com/docs/opsworks_describe_ecs_clusters/ for full documentation.
Usage
opsworks_describe_ecs_clusters(
EcsClusterArns = NULL,
StackId = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
EcsClusterArns |
A list of ARNs, one for each cluster to be described. |
StackId |
A stack ID. |
NextToken |
If the previous paginated request did not return all of the remaining
results, the response object's |
MaxResults |
To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Describes Elastic IP addresses
Description
Describes Elastic IP addresses.
See https://www.paws-r-sdk.com/docs/opsworks_describe_elastic_ips/ for full documentation.
Usage
opsworks_describe_elastic_ips(InstanceId = NULL, StackId = NULL, Ips = NULL)
Arguments
InstanceId |
The instance ID. If you include this parameter,
|
StackId |
A stack ID. If you include this parameter,
|
Ips |
An array of Elastic IP addresses to be described. If you include this
parameter, |
Describes a stack's Elastic Load Balancing instances
Description
Describes a stack's Elastic Load Balancing instances.
See https://www.paws-r-sdk.com/docs/opsworks_describe_elastic_load_balancers/ for full documentation.
Usage
opsworks_describe_elastic_load_balancers(StackId = NULL, LayerIds = NULL)
Arguments
StackId |
A stack ID. The action describes the stack's Elastic Load Balancing instances. |
LayerIds |
A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers. |
Requests a description of a set of instances
Description
Requests a description of a set of instances.
See https://www.paws-r-sdk.com/docs/opsworks_describe_instances/ for full documentation.
Usage
opsworks_describe_instances(StackId = NULL, LayerId = NULL, InstanceIds = NULL)
Arguments
StackId |
A stack ID. If you use this parameter,
|
LayerId |
A layer ID. If you use this parameter,
|
InstanceIds |
An array of instance IDs to be described. If you use this parameter,
|
Requests a description of one or more layers in a specified stack
Description
Requests a description of one or more layers in a specified stack.
See https://www.paws-r-sdk.com/docs/opsworks_describe_layers/ for full documentation.
Usage
opsworks_describe_layers(StackId = NULL, LayerIds = NULL)
Arguments
StackId |
The stack ID. |
LayerIds |
An array of layer IDs that specify the layers to be described. If you
omit this parameter, |
Describes load-based auto scaling configurations for specified layers
Description
Describes load-based auto scaling configurations for specified layers.
See https://www.paws-r-sdk.com/docs/opsworks_describe_load_based_auto_scaling/ for full documentation.
Usage
opsworks_describe_load_based_auto_scaling(LayerIds)
Arguments
LayerIds |
[required] An array of layer IDs. |
Describes a user's SSH information
Description
Describes a user's SSH information.
See https://www.paws-r-sdk.com/docs/opsworks_describe_my_user_profile/ for full documentation.
Usage
opsworks_describe_my_user_profile()
Describes the operating systems that are supported by OpsWorks Stacks
Description
Describes the operating systems that are supported by OpsWorks Stacks.
See https://www.paws-r-sdk.com/docs/opsworks_describe_operating_systems/ for full documentation.
Usage
opsworks_describe_operating_systems()
Describes the permissions for a specified stack
Description
Describes the permissions for a specified stack.
See https://www.paws-r-sdk.com/docs/opsworks_describe_permissions/ for full documentation.
Usage
opsworks_describe_permissions(IamUserArn = NULL, StackId = NULL)
Arguments
IamUserArn |
The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers. |
StackId |
The stack ID. |
Describe an instance's RAID arrays
Description
Describe an instance's RAID arrays.
See https://www.paws-r-sdk.com/docs/opsworks_describe_raid_arrays/ for full documentation.
Usage
opsworks_describe_raid_arrays(
InstanceId = NULL,
StackId = NULL,
RaidArrayIds = NULL
)
Arguments
InstanceId |
The instance ID. If you use this parameter,
|
StackId |
The stack ID. |
RaidArrayIds |
An array of RAID array IDs. If you use this parameter,
|
Describes Amazon RDS instances
Description
Describes Amazon RDS instances.
See https://www.paws-r-sdk.com/docs/opsworks_describe_rds_db_instances/ for full documentation.
Usage
opsworks_describe_rds_db_instances(StackId, RdsDbInstanceArns = NULL)
Arguments
StackId |
[required] The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances. |
RdsDbInstanceArns |
An array containing the ARNs of the instances to be described. |
Describes OpsWorks Stacks service errors
Description
Describes OpsWorks Stacks service errors.
See https://www.paws-r-sdk.com/docs/opsworks_describe_service_errors/ for full documentation.
Usage
opsworks_describe_service_errors(
StackId = NULL,
InstanceId = NULL,
ServiceErrorIds = NULL
)
Arguments
StackId |
The stack ID. If you use this parameter,
|
InstanceId |
The instance ID. If you use this parameter,
|
ServiceErrorIds |
An array of service error IDs. If you use this parameter,
|
Requests a description of a stack's provisioning parameters
Description
Requests a description of a stack's provisioning parameters.
See https://www.paws-r-sdk.com/docs/opsworks_describe_stack_provisioning_parameters/ for full documentation.
Usage
opsworks_describe_stack_provisioning_parameters(StackId)
Arguments
StackId |
[required] The stack ID. |
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online
Description
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.
See https://www.paws-r-sdk.com/docs/opsworks_describe_stack_summary/ for full documentation.
Usage
opsworks_describe_stack_summary(StackId)
Arguments
StackId |
[required] The stack ID. |
Requests a description of one or more stacks
Description
Requests a description of one or more stacks.
See https://www.paws-r-sdk.com/docs/opsworks_describe_stacks/ for full documentation.
Usage
opsworks_describe_stacks(StackIds = NULL)
Arguments
StackIds |
An array of stack IDs that specify the stacks to be described. If you
omit this parameter, and have permissions to get information about all
stacks, |
Describes time-based auto scaling configurations for specified instances
Description
Describes time-based auto scaling configurations for specified instances.
See https://www.paws-r-sdk.com/docs/opsworks_describe_time_based_auto_scaling/ for full documentation.
Usage
opsworks_describe_time_based_auto_scaling(InstanceIds)
Arguments
InstanceIds |
[required] An array of instance IDs. |
Describe specified users
Description
Describe specified users.
See https://www.paws-r-sdk.com/docs/opsworks_describe_user_profiles/ for full documentation.
Usage
opsworks_describe_user_profiles(IamUserArns = NULL)
Arguments
IamUserArns |
An array of IAM or federated user ARNs that identify the users to be described. |
Describes an instance's Amazon EBS volumes
Description
Describes an instance's Amazon EBS volumes.
See https://www.paws-r-sdk.com/docs/opsworks_describe_volumes/ for full documentation.
Usage
opsworks_describe_volumes(
InstanceId = NULL,
StackId = NULL,
RaidArrayId = NULL,
VolumeIds = NULL
)
Arguments
InstanceId |
The instance ID. If you use this parameter,
|
StackId |
A stack ID. The action describes the stack's registered Amazon EBS volumes. |
RaidArrayId |
The RAID array ID. If you use this parameter,
|
VolumeIds |
Am array of volume IDs. If you use this parameter,
|
Detaches a specified Elastic Load Balancing instance from its layer
Description
Detaches a specified Elastic Load Balancing instance from its layer.
See https://www.paws-r-sdk.com/docs/opsworks_detach_elastic_load_balancer/ for full documentation.
Usage
opsworks_detach_elastic_load_balancer(ElasticLoadBalancerName, LayerId)
Arguments
ElasticLoadBalancerName |
[required] The Elastic Load Balancing instance's name. |
LayerId |
[required] The ID of the layer that the Elastic Load Balancing instance is attached to. |
Disassociates an Elastic IP address from its instance
Description
Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_disassociate_elastic_ip/ for full documentation.
Usage
opsworks_disassociate_elastic_ip(ElasticIp)
Arguments
ElasticIp |
[required] The Elastic IP address. |
Gets a generated host name for the specified layer, based on the current host name theme
Description
Gets a generated host name for the specified layer, based on the current host name theme.
See https://www.paws-r-sdk.com/docs/opsworks_get_hostname_suggestion/ for full documentation.
Usage
opsworks_get_hostname_suggestion(LayerId)
Arguments
LayerId |
[required] The layer ID. |
This action can be used only with Windows stacks
Description
This action can be used only with Windows stacks.
See https://www.paws-r-sdk.com/docs/opsworks_grant_access/ for full documentation.
Usage
opsworks_grant_access(InstanceId, ValidForInMinutes = NULL)
Arguments
InstanceId |
[required] The instance's OpsWorks Stacks ID. |
ValidForInMinutes |
The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, they are logged out. |
Returns a list of tags that are applied to the specified stack or layer
Description
Returns a list of tags that are applied to the specified stack or layer.
See https://www.paws-r-sdk.com/docs/opsworks_list_tags/ for full documentation.
Usage
opsworks_list_tags(ResourceArn, MaxResults = NULL, NextToken = NULL)
Arguments
ResourceArn |
[required] The stack or layer's Amazon Resource Number (ARN). |
MaxResults |
Do not use. A validation exception occurs if you add a |
NextToken |
Do not use. A validation exception occurs if you add a |
Reboots a specified instance
Description
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
See https://www.paws-r-sdk.com/docs/opsworks_reboot_instance/ for full documentation.
Usage
opsworks_reboot_instance(InstanceId)
Arguments
InstanceId |
[required] The instance ID. |
Registers a specified Amazon ECS cluster with a stack
Description
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_register_ecs_cluster/ for full documentation.
Usage
opsworks_register_ecs_cluster(EcsClusterArn, StackId)
Arguments
EcsClusterArn |
[required] The cluster's ARN. |
StackId |
[required] The stack ID. |
Registers an Elastic IP address with a specified stack
Description
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling deregister_elastic_ip. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_register_elastic_ip/ for full documentation.
Usage
opsworks_register_elastic_ip(ElasticIp, StackId)
Arguments
ElasticIp |
[required] The Elastic IP address. |
StackId |
[required] The stack ID. |
Registers instances that were created outside of OpsWorks Stacks with a specified stack
Description
Registers instances that were created outside of OpsWorks Stacks with a specified stack.
See https://www.paws-r-sdk.com/docs/opsworks_register_instance/ for full documentation.
Usage
opsworks_register_instance(
StackId,
Hostname = NULL,
PublicIp = NULL,
PrivateIp = NULL,
RsaPublicKey = NULL,
RsaPublicKeyFingerprint = NULL,
InstanceIdentity = NULL
)
Arguments
StackId |
[required] The ID of the stack that the instance is to be registered with. |
Hostname |
The instance's host name. The following are character limits for instance host names.
|
PublicIp |
The instance's public IP address. |
PrivateIp |
The instance's private IP address. |
RsaPublicKey |
The instances public RSA key. This key is used to encrypt communication between the instance and the service. |
RsaPublicKeyFingerprint |
The instances public RSA key fingerprint. |
InstanceIdentity |
An InstanceIdentity object that contains the instance's identity. |
Registers an Amazon RDS instance with a stack
Description
Registers an Amazon RDS instance with a stack.
See https://www.paws-r-sdk.com/docs/opsworks_register_rds_db_instance/ for full documentation.
Usage
opsworks_register_rds_db_instance(
StackId,
RdsDbInstanceArn,
DbUser,
DbPassword
)
Arguments
StackId |
[required] The stack ID. |
RdsDbInstanceArn |
[required] The Amazon RDS instance's ARN. |
DbUser |
[required] The database's master user name. |
DbPassword |
[required] The database password. |
Registers an Amazon EBS volume with a specified stack
Description
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling deregister_volume. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_register_volume/ for full documentation.
Usage
opsworks_register_volume(Ec2VolumeId = NULL, StackId)
Arguments
Ec2VolumeId |
The Amazon EBS volume ID. |
StackId |
[required] The stack ID. |
Specify the load-based auto scaling configuration for a specified layer
Description
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
See https://www.paws-r-sdk.com/docs/opsworks_set_load_based_auto_scaling/ for full documentation.
Usage
opsworks_set_load_based_auto_scaling(
LayerId,
Enable = NULL,
UpScaling = NULL,
DownScaling = NULL
)
Arguments
LayerId |
[required] The layer ID. |
Enable |
Enables load-based auto scaling for the layer. |
UpScaling |
An |
DownScaling |
An |
Specifies a user's permissions
Description
Specifies a user's permissions. For more information, see Security and Permissions.
See https://www.paws-r-sdk.com/docs/opsworks_set_permission/ for full documentation.
Usage
opsworks_set_permission(
StackId,
IamUserArn,
AllowSsh = NULL,
AllowSudo = NULL,
Level = NULL
)
Arguments
StackId |
[required] The stack ID. |
IamUserArn |
[required] The user's IAM ARN. This can also be a federated user's ARN. |
AllowSsh |
The user is allowed to use SSH to communicate with the instance. |
AllowSudo |
The user is allowed to use sudo to elevate privileges. |
Level |
The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
For more information about the permissions associated with these levels, see Managing User Permissions. |
Specify the time-based auto scaling configuration for a specified instance
Description
Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
See https://www.paws-r-sdk.com/docs/opsworks_set_time_based_auto_scaling/ for full documentation.
Usage
opsworks_set_time_based_auto_scaling(InstanceId, AutoScalingSchedule = NULL)
Arguments
InstanceId |
[required] The instance ID. |
AutoScalingSchedule |
An |
Starts a specified instance
Description
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
See https://www.paws-r-sdk.com/docs/opsworks_start_instance/ for full documentation.
Usage
opsworks_start_instance(InstanceId)
Arguments
InstanceId |
[required] The instance ID. |
Starts a stack's instances
Description
Starts a stack's instances.
See https://www.paws-r-sdk.com/docs/opsworks_start_stack/ for full documentation.
Usage
opsworks_start_stack(StackId)
Arguments
StackId |
[required] The stack ID. |
Stops a specified instance
Description
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
See https://www.paws-r-sdk.com/docs/opsworks_stop_instance/ for full documentation.
Usage
opsworks_stop_instance(InstanceId, Force = NULL)
Arguments
InstanceId |
[required] The instance ID. |
Force |
Specifies whether to force an instance to stop. If the instance's root
device type is |
Stops a specified stack
Description
Stops a specified stack.
See https://www.paws-r-sdk.com/docs/opsworks_stop_stack/ for full documentation.
Usage
opsworks_stop_stack(StackId)
Arguments
StackId |
[required] The stack ID. |
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks
Description
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide.
See https://www.paws-r-sdk.com/docs/opsworks_tag_resource/ for full documentation.
Usage
opsworks_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The stack or layer's Amazon Resource Number (ARN). |
Tags |
[required] A map that contains tag keys and tag values that are attached to a stack or layer.
|
Unassigns a registered instance from all layers that are using the instance
Description
Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with OpsWorks Stacks.
See https://www.paws-r-sdk.com/docs/opsworks_unassign_instance/ for full documentation.
Usage
opsworks_unassign_instance(InstanceId)
Arguments
InstanceId |
[required] The instance ID. |
Unassigns an assigned Amazon EBS volume
Description
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_unassign_volume/ for full documentation.
Usage
opsworks_unassign_volume(VolumeId)
Arguments
VolumeId |
[required] The volume ID. |
Removes tags from a specified stack or layer
Description
Removes tags from a specified stack or layer.
See https://www.paws-r-sdk.com/docs/opsworks_untag_resource/ for full documentation.
Usage
opsworks_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The stack or layer's Amazon Resource Number (ARN). |
TagKeys |
[required] A list of the keys of tags to be removed from a stack or layer. |
Updates a specified app
Description
Updates a specified app.
See https://www.paws-r-sdk.com/docs/opsworks_update_app/ for full documentation.
Usage
opsworks_update_app(
AppId,
Name = NULL,
Description = NULL,
DataSources = NULL,
Type = NULL,
AppSource = NULL,
Domains = NULL,
EnableSsl = NULL,
SslConfiguration = NULL,
Attributes = NULL,
Environment = NULL
)
Arguments
AppId |
[required] The app ID. |
Name |
The app name. |
Description |
A description of the app. |
DataSources |
The app's data sources. |
Type |
The app type. |
AppSource |
A |
Domains |
The app's virtual host settings, with multiple domains separated by
commas. For example: |
EnableSsl |
Whether SSL is enabled for the app. |
SslConfiguration |
An |
Attributes |
One or more user-defined key/value pairs to be added to the stack attributes. |
Environment |
An array of 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. |
Updates a registered Elastic IP address's name
Description
Updates a registered Elastic IP address's name. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_update_elastic_ip/ for full documentation.
Usage
opsworks_update_elastic_ip(ElasticIp, Name = NULL)
Arguments
ElasticIp |
[required] The IP address for which you want to update the name. |
Name |
The new name, which can be a maximum of 32 characters. |
Updates a specified instance
Description
Updates a specified instance.
See https://www.paws-r-sdk.com/docs/opsworks_update_instance/ for full documentation.
Usage
opsworks_update_instance(
InstanceId,
LayerIds = NULL,
InstanceType = NULL,
AutoScalingType = NULL,
Hostname = NULL,
Os = NULL,
AmiId = NULL,
SshKeyName = NULL,
Architecture = NULL,
InstallUpdatesOnBoot = NULL,
EbsOptimized = NULL,
AgentVersion = NULL
)
Arguments
InstanceId |
[required] The instance ID. |
LayerIds |
The instance's layer IDs. |
InstanceType |
The instance type, such as |
AutoScalingType |
For load-based or time-based instances, the type. Windows stacks can use only time-based instances. |
Hostname |
The instance host name. The following are character limits for instance host names.
|
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.
Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. The default option is the current Amazon Linux version. If you set this
parameter to You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. |
AmiId |
The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. |
SshKeyName |
The instance's Amazon EC2 key name. |
Architecture |
The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types. |
InstallUpdatesOnBoot |
Whether to install operating system and package updates when the
instance boots. The default value is We strongly recommend using the default value of |
EbsOptimized |
This property cannot be updated. |
AgentVersion |
The default OpsWorks Stacks agent version. You have the following options:
The default setting is AgentVersion cannot be set to Chef 12.2. |
Updates a specified layer
Description
Updates a specified layer.
See https://www.paws-r-sdk.com/docs/opsworks_update_layer/ for full documentation.
Usage
opsworks_update_layer(
LayerId,
Name = NULL,
Shortname = NULL,
Attributes = NULL,
CloudWatchLogsConfiguration = NULL,
CustomInstanceProfileArn = NULL,
CustomJson = NULL,
CustomSecurityGroupIds = NULL,
Packages = NULL,
VolumeConfigurations = NULL,
EnableAutoHealing = NULL,
AutoAssignElasticIps = NULL,
AutoAssignPublicIps = NULL,
CustomRecipes = NULL,
InstallUpdatesOnBoot = NULL,
UseEbsOptimizedInstances = NULL,
LifecycleEventConfiguration = NULL
)
Arguments
LayerId |
[required] The layer ID. |
Name |
The layer name, which is used by the console. Layer names can be a maximum of 32 characters. |
Shortname |
For custom layers only, use this parameter to specify the layer's short name, which is used internally by 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 32 characters and must be in the following format: /\A[a-z0-9\-_\.]+\Z/. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer reference in the OpsWorks User Guide. |
Attributes |
One or more user-defined key/value pairs to be added to the stack attributes. |
CloudWatchLogsConfiguration |
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. |
CustomInstanceProfileArn |
The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. |
CustomJson |
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. |
CustomSecurityGroupIds |
An array containing the layer's custom security group IDs. |
Packages |
An array of |
VolumeConfigurations |
A |
EnableAutoHealing |
Whether to disable auto healing for the layer. |
AutoAssignElasticIps |
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. |
AutoAssignPublicIps |
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. |
CustomRecipes |
A |
InstallUpdatesOnBoot |
Whether to install operating system and package updates when the
instance boots. The default value is We strongly recommend using the default value of |
UseEbsOptimizedInstances |
Whether to use Amazon EBS-optimized instances. |
LifecycleEventConfiguration |
Updates a user's SSH public key
Description
Updates a user's SSH public key.
See https://www.paws-r-sdk.com/docs/opsworks_update_my_user_profile/ for full documentation.
Usage
opsworks_update_my_user_profile(SshPublicKey = NULL)
Arguments
SshPublicKey |
The user's SSH public key. |
Updates an Amazon RDS instance
Description
Updates an Amazon RDS instance.
See https://www.paws-r-sdk.com/docs/opsworks_update_rds_db_instance/ for full documentation.
Usage
opsworks_update_rds_db_instance(
RdsDbInstanceArn,
DbUser = NULL,
DbPassword = NULL
)
Arguments
RdsDbInstanceArn |
[required] The Amazon RDS instance's ARN. |
DbUser |
The master user name. |
DbPassword |
The database password. |
Updates a specified stack
Description
Updates a specified stack.
See https://www.paws-r-sdk.com/docs/opsworks_update_stack/ for full documentation.
Usage
opsworks_update_stack(
StackId,
Name = NULL,
Attributes = NULL,
ServiceRoleArn = NULL,
DefaultInstanceProfileArn = NULL,
DefaultOs = NULL,
HostnameTheme = NULL,
DefaultAvailabilityZone = NULL,
DefaultSubnetId = NULL,
CustomJson = NULL,
ConfigurationManager = NULL,
ChefConfiguration = NULL,
UseCustomCookbooks = NULL,
CustomCookbooksSource = NULL,
DefaultSshKeyName = NULL,
DefaultRootDeviceType = NULL,
UseOpsworksSecurityGroups = NULL,
AgentVersion = NULL
)
Arguments
StackId |
[required] The stack ID. |
Name |
The stack's new name. Stack names can be a maximum of 64 characters. |
Attributes |
One or more user-defined key-value pairs to be added to the stack attributes. |
ServiceRoleArn |
Do not use this parameter. You cannot update a stack's service role. |
DefaultInstanceProfileArn |
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. |
DefaultOs |
The stack's operating system, which must be set to one of the following:
The default option is the stack's current operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. |
HostnameTheme |
The stack's new host name theme, with spaces replaced by underscores.
The theme is used to generate host names for the stack's instances. By
default,
To obtain a generated host name, call |
DefaultAvailabilityZone |
The stack's default Availability Zone, which must be in the stack's
region. For more information, see Regions and Endpoints. If
you also specify a value for |
DefaultSubnetId |
The stack's default VPC subnet ID. This parameter is required if you
specify a value for the |
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:
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. |
ConfigurationManager |
The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. |
ChefConfiguration |
A |
UseCustomCookbooks |
Whether the stack uses custom cookbooks. |
CustomCookbooksSource |
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. |
DefaultSshKeyName |
A default Amazon EC2 key-pair name. The default value is |
DefaultRootDeviceType |
The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. |
UseOpsworksSecurityGroups |
Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in security groups, one
for each layer, which are associated with layers by default.
For more information, see Create a New Stack. |
AgentVersion |
The default OpsWorks Stacks agent version. You have the following options:
The default setting is You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. |
Updates a specified user profile
Description
Updates a specified user profile.
See https://www.paws-r-sdk.com/docs/opsworks_update_user_profile/ for full documentation.
Usage
opsworks_update_user_profile(
IamUserArn,
SshUsername = NULL,
SshPublicKey = NULL,
AllowSelfManagement = NULL
)
Arguments
IamUserArn |
[required] The user IAM ARN. This can also be a federated user's ARN. |
SshUsername |
The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other punctuation
marks, OpsWorks Stacks removes them. For example, |
SshPublicKey |
The user's new SSH public key. |
AllowSelfManagement |
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions. |
Updates an Amazon EBS volume's name or mount point
Description
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
See https://www.paws-r-sdk.com/docs/opsworks_update_volume/ for full documentation.
Usage
opsworks_update_volume(VolumeId, Name = NULL, MountPoint = NULL)
Arguments
VolumeId |
[required] The volume ID. |
Name |
The new name. Volume names can be a maximum of 128 characters. |
MountPoint |
The new mount point. |
AWS OpsWorks CM
Description
AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.
Glossary of terms
-
Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.
-
Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include
ChefAutomateandPuppet. -
Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.
-
Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.
-
Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.
Endpoints
AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.
opsworks-cm.us-east-1.amazonaws.com
opsworks-cm.us-east-2.amazonaws.com
opsworks-cm.us-west-1.amazonaws.com
opsworks-cm.us-west-2.amazonaws.com
opsworks-cm.ap-northeast-1.amazonaws.com
opsworks-cm.ap-southeast-1.amazonaws.com
opsworks-cm.ap-southeast-2.amazonaws.com
opsworks-cm.eu-central-1.amazonaws.com
opsworks-cm.eu-west-1.amazonaws.com
For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
Usage
opsworkscm(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- opsworkscm(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_node | Associates a new node with the server |
| create_backup | Creates an application-level backup of a server |
| create_server | Creates and immedately starts a new server |
| delete_backup | Deletes a backup |
| delete_server | Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance) |
| describe_account_attributes | Describes your OpsWorks-CM account attributes |
| describe_backups | Describes backups |
| describe_events | Describes events for a specified server |
| describe_node_association_status | Returns the current status of an existing association or disassociation request |
| describe_servers | Lists all configuration management servers that are identified with your account |
| disassociate_node | Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes |
| export_server_engine_attribute | Exports a specified server engine attribute as a base64-encoded string |
| list_tags_for_resource | Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups |
| restore_server | Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state |
| start_maintenance | Manually starts server maintenance |
| tag_resource | Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups |
| untag_resource | Removes specified tags from an AWS OpsWorks-CM server or backup |
| update_server | Updates settings for a server |
| update_server_engine_attributes | Updates engine-specific attributes on a specified server |
Examples
## Not run:
svc <- opsworkscm()
svc$associate_node(
Foo = 123
)
## End(Not run)
Associates a new node with the server
Description
Associates a new node with the server. For more information about how to disassociate a node, see disassociate_node.
See https://www.paws-r-sdk.com/docs/opsworkscm_associate_node/ for full documentation.
Usage
opsworkscm_associate_node(ServerName, NodeName, EngineAttributes)
Arguments
ServerName |
[required] The name of the server with which to associate the node. |
NodeName |
[required] The name of the node. |
EngineAttributes |
[required] Engine attributes used for associating the node. Attributes accepted in a AssociateNode request for Chef
Attributes accepted in a AssociateNode request for Puppet
|
Creates an application-level backup of a server
Description
Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.
See https://www.paws-r-sdk.com/docs/opsworkscm_create_backup/ for full documentation.
Usage
opsworkscm_create_backup(ServerName, Description = NULL, Tags = NULL)
Arguments
ServerName |
[required] The name of the server that you want to back up. |
Description |
A user-defined description of the backup. |
Tags |
A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.
|
Creates and immedately starts a new server
Description
Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.
See https://www.paws-r-sdk.com/docs/opsworkscm_create_server/ for full documentation.
Usage
opsworkscm_create_server(
AssociatePublicIpAddress = NULL,
CustomDomain = NULL,
CustomCertificate = NULL,
CustomPrivateKey = NULL,
DisableAutomatedBackup = NULL,
Engine,
EngineModel = NULL,
EngineVersion = NULL,
EngineAttributes = NULL,
BackupRetentionCount = NULL,
ServerName,
InstanceProfileArn,
InstanceType,
KeyPair = NULL,
PreferredMaintenanceWindow = NULL,
PreferredBackupWindow = NULL,
SecurityGroupIds = NULL,
ServiceRoleArn,
SubnetIds = NULL,
Tags = NULL,
BackupId = NULL
)
Arguments
AssociatePublicIpAddress |
Associate a public IP address with a server that you are launching.
Valid values are |
CustomDomain |
An optional public endpoint of a server, such as
|
CustomCertificate |
A PEM-formatted HTTPS certificate. The value can be be a single,
self-signed certificate, or a certificate chain. If you specify a custom
certificate, you must also specify values for
|
CustomPrivateKey |
A private key in PEM format for connecting to the server by using HTTPS.
The private key must not be encrypted; it cannot be protected by a
password or passphrase. If you specify a custom private key, you must
also specify values for |
DisableAutomatedBackup |
Enable or disable scheduled backups. Valid values are |
Engine |
[required] The configuration management engine to use. Valid values include
|
EngineModel |
The engine model of the server. Valid values in this release include
|
EngineVersion |
The major release version of the engine that you want to use. For a Chef
server, the valid value for EngineVersion is currently |
EngineAttributes |
Optional engine attributes on a specified server. Attributes accepted in a Chef createServer request:
Attributes accepted in a Puppet createServer request:
|
BackupRetentionCount |
The number of automated backups that you want to keep. Whenever a new
backup is created, AWS OpsWorks CM deletes the oldest backups if this
number is exceeded. The default value is |
ServerName |
[required] The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. |
InstanceProfileArn |
[required] The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need. |
InstanceType |
[required] The Amazon EC2 instance type to use. For example, |
KeyPair |
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH. |
PreferredMaintenanceWindow |
The start time for a one-hour period each week during which AWS OpsWorks
CM performs maintenance on the instance. Valid values must be specified
in the following format: Example: |
PreferredBackupWindow |
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
Example: Example: |
SecurityGroupIds |
A list of security group IDs to attach to the Amazon EC2 instance. If
you add this parameter, the specified security groups must be within the
VPC that is specified by If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone). |
ServiceRoleArn |
[required] The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need. |
SubnetIds |
The IDs of subnets in which to launch the server EC2 instance. Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more information about supported Amazon EC2 platforms, see Supported Platforms. |
Tags |
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
|
BackupId |
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. |
Deletes a backup
Description
Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
See https://www.paws-r-sdk.com/docs/opsworkscm_delete_backup/ for full documentation.
Usage
opsworkscm_delete_backup(BackupId)
Arguments
BackupId |
[required] The ID of the backup to delete. Run the DescribeBackups command to get a
list of backup IDs. Backup IDs are in the format
|
Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance)
Description
Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.
See https://www.paws-r-sdk.com/docs/opsworkscm_delete_server/ for full documentation.
Usage
opsworkscm_delete_server(ServerName)
Arguments
ServerName |
[required] The ID of the server to delete. |
Describes your OpsWorks-CM account attributes
Description
Describes your OpsWorks-CM account attributes.
See https://www.paws-r-sdk.com/docs/opsworkscm_describe_account_attributes/ for full documentation.
Usage
opsworkscm_describe_account_attributes()
Describes backups
Description
Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.
See https://www.paws-r-sdk.com/docs/opsworkscm_describe_backups/ for full documentation.
Usage
opsworkscm_describe_backups(
BackupId = NULL,
ServerName = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
BackupId |
Describes a single backup. |
ServerName |
Returns backups for the server with the specified ServerName. |
NextToken |
This is not currently implemented for
|
MaxResults |
This is not currently implemented for
|
Describes events for a specified server
Description
Describes events for a specified server. Results are ordered by time, with newest events first.
See https://www.paws-r-sdk.com/docs/opsworkscm_describe_events/ for full documentation.
Usage
opsworkscm_describe_events(ServerName, NextToken = NULL, MaxResults = NULL)
Arguments
ServerName |
[required] The name of the server for which you want to view events. |
NextToken |
NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call |
MaxResults |
To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Returns the current status of an existing association or disassociation request
Description
Returns the current status of an existing association or disassociation request.
See https://www.paws-r-sdk.com/docs/opsworkscm_describe_node_association_status/ for full documentation.
Usage
opsworkscm_describe_node_association_status(
NodeAssociationStatusToken,
ServerName
)
Arguments
NodeAssociationStatusToken |
[required] The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse. |
ServerName |
[required] The name of the server from which to disassociate the node. |
Lists all configuration management servers that are identified with your account
Description
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.
See https://www.paws-r-sdk.com/docs/opsworkscm_describe_servers/ for full documentation.
Usage
opsworkscm_describe_servers(
ServerName = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServerName |
Describes the server with the specified ServerName. |
NextToken |
This is not currently implemented for
|
MaxResults |
This is not currently implemented for
|
Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes
Description
Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see associate_node.
See https://www.paws-r-sdk.com/docs/opsworkscm_disassociate_node/ for full documentation.
Usage
opsworkscm_disassociate_node(ServerName, NodeName, EngineAttributes = NULL)
Arguments
ServerName |
[required] The name of the server from which to disassociate the node. |
NodeName |
[required] The name of the client node. |
EngineAttributes |
Engine attributes that are used for disassociating the node. No attributes are required for Puppet. Attributes required in a DisassociateNode request for Chef
|
Exports a specified server engine attribute as a base64-encoded string
Description
Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.
See https://www.paws-r-sdk.com/docs/opsworkscm_export_server_engine_attribute/ for full documentation.
Usage
opsworkscm_export_server_engine_attribute(
ExportAttributeName,
ServerName,
InputAttributes = NULL
)
Arguments
ExportAttributeName |
[required] The name of the export attribute. Currently, the supported export
attribute is |
ServerName |
[required] The name of the server from which you are exporting the attribute. |
InputAttributes |
The list of engine attributes. The list type is
|
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups
Description
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
See https://www.paws-r-sdk.com/docs/opsworkscm_list_tags_for_resource/ for full documentation.
Usage
opsworkscm_list_tags_for_resource(
ResourceArn,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ResourceArn |
[required] The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or
AWS OpsWorks for Puppet Enterprise server for which you want to show
applied tags. For example,
|
NextToken |
NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call
|
MaxResults |
To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a |
Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state
Description
Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.
See https://www.paws-r-sdk.com/docs/opsworkscm_restore_server/ for full documentation.
Usage
opsworkscm_restore_server(
BackupId,
ServerName,
InstanceType = NULL,
KeyPair = NULL
)
Arguments
BackupId |
[required] The ID of the backup that you want to use to restore a server. |
ServerName |
[required] The name of the server that you want to restore. |
InstanceType |
The type of instance to restore. Valid values must be specified in the
following format: |
KeyPair |
The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key. |
Manually starts server maintenance
Description
Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.
See https://www.paws-r-sdk.com/docs/opsworkscm_start_maintenance/ for full documentation.
Usage
opsworkscm_start_maintenance(ServerName, EngineAttributes = NULL)
Arguments
ServerName |
[required] The name of the server on which to run maintenance. |
EngineAttributes |
Engine attributes that are specific to the server on which you want to run maintenance. Attributes accepted in a StartMaintenance request for Chef
|
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups
Description
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
See https://www.paws-r-sdk.com/docs/opsworkscm_tag_resource/ for full documentation.
Usage
opsworkscm_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Number (ARN) of a resource to which you want to
apply tags. For example,
|
Tags |
[required] A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.
|
Removes specified tags from an AWS OpsWorks-CM server or backup
Description
Removes specified tags from an AWS OpsWorks-CM server or backup.
See https://www.paws-r-sdk.com/docs/opsworkscm_untag_resource/ for full documentation.
Usage
opsworkscm_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Number (ARN) of a resource from which you want to
remove tags. For example,
|
TagKeys |
[required] The keys of tags that you want to remove. |
Updates settings for a server
Description
Updates settings for a server.
See https://www.paws-r-sdk.com/docs/opsworkscm_update_server/ for full documentation.
Usage
opsworkscm_update_server(
DisableAutomatedBackup = NULL,
BackupRetentionCount = NULL,
ServerName,
PreferredMaintenanceWindow = NULL,
PreferredBackupWindow = NULL
)
Arguments
DisableAutomatedBackup |
Setting DisableAutomatedBackup to |
BackupRetentionCount |
Sets the number of automated backups that you want to keep. |
ServerName |
[required] The name of the server to update. |
PreferredMaintenanceWindow |
|
PreferredBackupWindow |
Updates engine-specific attributes on a specified server
Description
Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).
See https://www.paws-r-sdk.com/docs/opsworkscm_update_server_engine_attributes/ for full documentation.
Usage
opsworkscm_update_server_engine_attributes(
ServerName,
AttributeName,
AttributeValue = NULL
)
Arguments
ServerName |
[required] The name of the server to update. |
AttributeName |
[required] The name of the engine attribute to update. |
AttributeValue |
The value to set for the attribute. |
AWS Organizations
Description
Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations operations. For more information about using this service, see the Organizations User Guide.
Support and feedback for Organizations
We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in the Organizations support forum. For more information about the Amazon Web Services support forums, see Forums Help.
Endpoint to call When using the CLI or the Amazon Web Services SDK
For the current release of Organizations, specify the us-east-1 region
for all Amazon Web Services API and CLI calls made from the commercial
Amazon Web Services Regions outside of China. If calling from one of the
Amazon Web Services Regions in China, then specify cn-northwest-1. You
can do this in the CLI by using these parameters and commands:
Use the following parameter with each command to specify both the endpoint and its region:
--endpoint-url https://organizations.us-east-1.amazonaws.com(from commercial Amazon Web Services Regions outside of China)or
--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn(from Amazon Web Services Regions in China)Use the default endpoint, but configure your default region with this command:
aws configure set default.region us-east-1(from commercial Amazon Web Services Regions outside of China)or
aws configure set default.region cn-northwest-1(from Amazon Web Services Regions in China)Use the following parameter with each command to specify the endpoint:
--region us-east-1(from commercial Amazon Web Services Regions outside of China)or
--region cn-northwest-1(from Amazon Web Services Regions in China)
Recording API Requests
Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about Organizations and its support for CloudTrail, see Logging Organizations API calls with CloudTrail in the Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
Usage
organizations(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- organizations(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| accept_handshake | Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request |
| attach_policy | Attaches a policy to a root, an organizational unit (OU), or an individual account |
| cancel_handshake | Cancels a handshake |
| close_account | Closes an Amazon Web Services member account within an organization |
| create_account | Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request |
| create_gov_cloud_account | This action is available if all of the following are true: |
| create_organization | Creates an Amazon Web Services organization |
| create_organizational_unit | Creates an organizational unit (OU) within a root or parent OU |
| create_policy | Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account |
| decline_handshake | Declines a handshake request |
| delete_organization | Deletes the organization |
| delete_organizational_unit | Deletes an organizational unit (OU) from a root or another OU |
| delete_policy | Deletes the specified policy from your organization |
| delete_resource_policy | Deletes the resource policy from your organization |
| deregister_delegated_administrator | Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service |
| describe_account | Retrieves Organizations-related information about the specified account |
| describe_create_account_status | Retrieves the current status of an asynchronous request to create an account |
| describe_effective_policy | Returns the contents of the effective policy for specified policy type and account |
| describe_handshake | Retrieves information about a previously requested handshake |
| describe_organization | Retrieves information about the organization that the user's account belongs to |
| describe_organizational_unit | Retrieves information about an organizational unit (OU) |
| describe_policy | Retrieves information about a policy |
| describe_resource_policy | Retrieves information about a resource policy |
| detach_policy | Detaches a policy from a target root, organizational unit (OU), or account |
| disable_aws_service_access | Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with Organizations |
| disable_policy_type | Disables an organizational policy type in a root |
| enable_all_features | Enables all features in an organization |
| enable_aws_service_access | Provides an Amazon Web Services service (the service that is specified by ServicePrincipal) with permissions to view the structure of an organization, create a service-linked role in all the accounts in the organization, and allow the service to perform operations on behalf of the organization and its accounts |
| enable_policy_type | Enables a policy type in a root |
| invite_account_to_organization | Sends an invitation to another account to join your organization as a member account |
| leave_organization | Removes a member account from its parent organization |
| list_accounts | Lists all the accounts in the organization |
| list_accounts_for_parent | Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU) |
| list_aws_service_access_for_organization | Returns a list of the Amazon Web Services services that you enabled to integrate with your organization |
| list_children | Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root |
| list_create_account_status | Lists the account creation requests that match the specified status that is currently being tracked for the organization |
| list_delegated_administrators | Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization |
| list_delegated_services_for_account | List the Amazon Web Services services for which the specified account is a delegated administrator |
| list_handshakes_for_account | Lists the current handshakes that are associated with the account of the requesting user |
| list_handshakes_for_organization | Lists the handshakes that are associated with the organization that the requesting user is part of |
| list_organizational_units_for_parent | Lists the organizational units (OUs) in a parent organizational unit or root |
| list_parents | Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account |
| list_policies | Retrieves the list of all policies in an organization of a specified type |
| list_policies_for_target | Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account |
| list_roots | Lists the roots that are defined in the current organization |
| list_tags_for_resource | Lists tags that are attached to the specified resource |
| list_targets_for_policy | Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to |
| move_account | Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU |
| put_resource_policy | Creates or updates a resource policy |
| register_delegated_administrator | Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service |
| remove_account_from_organization | Removes the specified account from the organization |
| tag_resource | Adds one or more tags to the specified resource |
| untag_resource | Removes any tags with the specified keys from the specified resource |
| update_organizational_unit | Renames the specified organizational unit (OU) |
| update_policy | Updates an existing policy with a new name, description, or content |
Examples
## Not run:
svc <- organizations()
# Bill is the owner of an organization, and he invites Juan's account
# (222222222222) to join his organization. The following example shows
# Juan's account accepting the handshake and thus agreeing to the
# invitation.
svc$accept_handshake(
HandshakeId = "h-examplehandshakeid111"
)
## End(Not run)
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request
Description
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
See https://www.paws-r-sdk.com/docs/organizations_accept_handshake/ for full documentation.
Usage
organizations_accept_handshake(HandshakeId)
Arguments
HandshakeId |
[required] The unique identifier (ID) of the handshake that you want to accept. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. |
Attaches a policy to a root, an organizational unit (OU), or an individual account
Description
Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the Organizations User Guide for information about each policy type:
See https://www.paws-r-sdk.com/docs/organizations_attach_policy/ for full documentation.
Usage
organizations_attach_policy(PolicyId, TargetId)
Arguments
PolicyId |
[required] The unique identifier (ID) of the policy that you want to attach to the
target. You can get the ID for the policy by calling the
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). |
TargetId |
[required] The unique identifier (ID) of the root, OU, or account that you want to
attach the policy to. You can get the ID by calling the
The regex pattern for a target ID string requires one of the following:
|
Cancels a handshake
Description
Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED.
See https://www.paws-r-sdk.com/docs/organizations_cancel_handshake/ for full documentation.
Usage
organizations_cancel_handshake(HandshakeId)
Arguments
HandshakeId |
[required] The unique identifier (ID) of the handshake that you want to cancel. You
can get the ID from the
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. |
Closes an Amazon Web Services member account within an organization
Description
Closes an Amazon Web Services member account within an organization. You can close an account when all features are enabled . You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because close_account operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following:
See https://www.paws-r-sdk.com/docs/organizations_close_account/ for full documentation.
Usage
organizations_close_account(AccountId)
Arguments
AccountId |
[required] Retrieves the Amazon Web Services account Id for the current
|
Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request
Description
Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because create_account operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
See https://www.paws-r-sdk.com/docs/organizations_create_account/ for full documentation.
Usage
organizations_create_account(
Email,
AccountName,
RoleName = NULL,
IamUserAccessToBilling = NULL,
Tags = NULL
)
Arguments
Email |
[required] The email address of the owner to assign to the new member account. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation. The rules for a valid email address:
You can't access the root user of the account or remove an account that was created with an invalid email address. |
AccountName |
[required] The friendly name of the member account. |
RoleName |
The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account. If you don't specify this parameter, the role name defaults to
For more information about how to use this role to access the member account, see the following links:
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- |
IamUserAccessToBilling |
If set to If you don't specify this parameter, the value defaults to |
Tags |
A list of tags that you want to attach to the newly created account. For
each tag in the list, you must specify both a tag key and a value. You
can set the value to an empty string, but you can't set it to If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created. |
This action is available if all of the following are true:
Description
This action is available if all of the following are true:
See https://www.paws-r-sdk.com/docs/organizations_create_gov_cloud_account/ for full documentation.
Usage
organizations_create_gov_cloud_account(
Email,
AccountName,
RoleName = NULL,
IamUserAccessToBilling = NULL,
Tags = NULL
)
Arguments
Email |
[required] Specifies the email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation. The rules for a valid email address:
You can't access the root user of the account or remove an account that
was created with an invalid email address. Like all request parameters
for
|
AccountName |
[required] The friendly name of the member account. The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters with a dash (–). |
RoleName |
(Optional) The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account. If you don't specify this parameter, the role name defaults to
For more information about how to use this role to access the member account, see the following links:
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- |
IamUserAccessToBilling |
If set to If you don't specify this parameter, the value defaults to |
Tags |
A list of tags that you want to attach to the newly created account.
These tags are attached to the commercial account associated with the
GovCloud account, and not to the GovCloud account itself. To add tags to
the actual GovCloud account, call the
For each tag in the list, you must specify both a tag key and a value.
You can set the value to an empty string, but you can't set it to
If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created. |
Creates an Amazon Web Services organization
Description
Creates an Amazon Web Services organization. The account whose user is calling the create_organization operation automatically becomes the management account of the new organization.
See https://www.paws-r-sdk.com/docs/organizations_create_organization/ for full documentation.
Usage
organizations_create_organization(FeatureSet = NULL)
Arguments
FeatureSet |
Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
|
Creates an organizational unit (OU) within a root or parent OU
Description
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.
See https://www.paws-r-sdk.com/docs/organizations_create_organizational_unit/ for full documentation.
Usage
organizations_create_organizational_unit(ParentId, Name, Tags = NULL)
Arguments
ParentId |
[required] The unique identifier (ID) of the parent root or OU that you want to create the new OU in. The regex pattern for a parent ID string requires one of the following:
|
Name |
[required] The friendly name to assign to the new OU. |
Tags |
A list of tags that you want to attach to the newly created OU. For each
tag in the list, you must specify both a tag key and a value. You can
set the value to an empty string, but you can't set it to If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created. |
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account
Description
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/organizations_create_policy/ for full documentation.
Usage
organizations_create_policy(Content, Description, Name, Type, Tags = NULL)
Arguments
Content |
[required] The policy text content to add to the new policy. The text that you
supply must adhere to the rules of the policy type you specify in the
The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide. |
Description |
[required] An optional description to assign to the policy. |
Name |
[required] The friendly name to assign to the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. |
Type |
[required] The type of policy to create. You can specify one of the following values: |
Tags |
A list of tags that you want to attach to the newly created policy. For
each tag in the list, you must specify both a tag key and a value. You
can set the value to an empty string, but you can't set it to If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created. |
Declines a handshake request
Description
Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.
See https://www.paws-r-sdk.com/docs/organizations_decline_handshake/ for full documentation.
Usage
organizations_decline_handshake(HandshakeId)
Arguments
HandshakeId |
[required] The unique identifier (ID) of the handshake that you want to decline.
You can get the ID from the
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. |
Deletes the organization
Description
Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts.
See https://www.paws-r-sdk.com/docs/organizations_delete_organization/ for full documentation.
Usage
organizations_delete_organization()
Deletes an organizational unit (OU) from a root or another OU
Description
Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.
See https://www.paws-r-sdk.com/docs/organizations_delete_organizational_unit/ for full documentation.
Usage
organizations_delete_organizational_unit(OrganizationalUnitId)
Arguments
OrganizationalUnitId |
[required] The unique identifier (ID) of the organizational unit that you want to
delete. You can get the ID from the
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. |
Deletes the specified policy from your organization
Description
Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.
See https://www.paws-r-sdk.com/docs/organizations_delete_policy/ for full documentation.
Usage
organizations_delete_policy(PolicyId)
Arguments
PolicyId |
[required] The unique identifier (ID) of the policy that you want to delete. You
can get the ID from the The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). |
Deletes the resource policy from your organization
Description
Deletes the resource policy from your organization.
See https://www.paws-r-sdk.com/docs/organizations_delete_resource_policy/ for full documentation.
Usage
organizations_delete_resource_policy()
Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service
Description
Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.
See https://www.paws-r-sdk.com/docs/organizations_deregister_delegated_administrator/ for full documentation.
Usage
organizations_deregister_delegated_administrator(AccountId, ServicePrincipal)
Arguments
AccountId |
[required] The account ID number of the member account in the organization that you want to deregister as a delegated administrator. |
ServicePrincipal |
[required] The service principal name of an Amazon Web Services service for which the account is a delegated administrator. Delegated administrator privileges are revoked for only the specified Amazon Web Services service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions. |
Retrieves Organizations-related information about the specified account
Description
Retrieves Organizations-related information about the specified account.
See https://www.paws-r-sdk.com/docs/organizations_describe_account/ for full documentation.
Usage
organizations_describe_account(AccountId)
Arguments
AccountId |
[required] The unique identifier (ID) of the Amazon Web Services account that you
want information about. You can get the ID from the
The regex pattern for an account ID string requires exactly 12 digits. |
Retrieves the current status of an asynchronous request to create an account
Description
Retrieves the current status of an asynchronous request to create an account.
See https://www.paws-r-sdk.com/docs/organizations_describe_create_account_status/ for full documentation.
Usage
organizations_describe_create_account_status(CreateAccountRequestId)
Arguments
CreateAccountRequestId |
[required] Specifies the The regex pattern for a create account request ID string requires "car-" followed by from 8 to 32 lowercase letters or digits. |
Returns the contents of the effective policy for specified policy type and account
Description
Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.
See https://www.paws-r-sdk.com/docs/organizations_describe_effective_policy/ for full documentation.
Usage
organizations_describe_effective_policy(PolicyType, TargetId = NULL)
Arguments
PolicyType |
[required] The type of policy that you want information about. You can specify one of the following values: |
TargetId |
When you're signed in as the management account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported. |
Retrieves information about a previously requested handshake
Description
Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original invite_account_to_organization operation that generated the handshake.
See https://www.paws-r-sdk.com/docs/organizations_describe_handshake/ for full documentation.
Usage
organizations_describe_handshake(HandshakeId)
Arguments
HandshakeId |
[required] The unique identifier (ID) of the handshake that you want information
about. You can get the ID from the original call to
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. |
Retrieves information about the organization that the user's account belongs to
Description
Retrieves information about the organization that the user's account belongs to.
See https://www.paws-r-sdk.com/docs/organizations_describe_organization/ for full documentation.
Usage
organizations_describe_organization()
Retrieves information about an organizational unit (OU)
Description
Retrieves information about an organizational unit (OU).
See https://www.paws-r-sdk.com/docs/organizations_describe_organizational_unit/ for full documentation.
Usage
organizations_describe_organizational_unit(OrganizationalUnitId)
Arguments
OrganizationalUnitId |
[required] The unique identifier (ID) of the organizational unit that you want
details about. You can get the ID from the
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. |
Retrieves information about a policy
Description
Retrieves information about a policy.
See https://www.paws-r-sdk.com/docs/organizations_describe_policy/ for full documentation.
Usage
organizations_describe_policy(PolicyId)
Arguments
PolicyId |
[required] The unique identifier (ID) of the policy that you want details about.
You can get the ID from the
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). |
Retrieves information about a resource policy
Description
Retrieves information about a resource policy.
See https://www.paws-r-sdk.com/docs/organizations_describe_resource_policy/ for full documentation.
Usage
organizations_describe_resource_policy()
Detaches a policy from a target root, organizational unit (OU), or account
Description
Detaches a policy from a target root, organizational unit (OU), or account.
See https://www.paws-r-sdk.com/docs/organizations_detach_policy/ for full documentation.
Usage
organizations_detach_policy(PolicyId, TargetId)
Arguments
PolicyId |
[required] The unique identifier (ID) of the policy you want to detach. You can get
the ID from the The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). |
TargetId |
[required] The unique identifier (ID) of the root, OU, or account that you want to
detach the policy from. You can get the ID from the
The regex pattern for a target ID string requires one of the following:
|
Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with Organizations
Description
Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations.
See https://www.paws-r-sdk.com/docs/organizations_disable_aws_service_access/ for full documentation.
Usage
organizations_disable_aws_service_access(ServicePrincipal)
Arguments
ServicePrincipal |
[required] The service principal name of the Amazon Web Services service for which
you want to disable integration with your organization. This is
typically in the form of a URL, such as
|
Disables an organizational policy type in a root
Description
Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the enable_policy_type operation.
See https://www.paws-r-sdk.com/docs/organizations_disable_policy_type/ for full documentation.
Usage
organizations_disable_policy_type(RootId, PolicyType)
Arguments
RootId |
[required] The unique identifier (ID) of the root in which you want to disable a
policy type. You can get the ID from the
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits. |
PolicyType |
[required] The policy type that you want to disable in this root. You can specify one of the following values: |
Enables all features in an organization
Description
Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that Organizations supports. For more information, see Enabling all features in your organization in the Organizations User Guide.
See https://www.paws-r-sdk.com/docs/organizations_enable_all_features/ for full documentation.
Usage
organizations_enable_all_features()
Provides an Amazon Web Services service (the service that is specified by ServicePrincipal) with permissions to view the structure of an organization, create a service-linked role in all the accounts in the organization, and allow the service to perform operations on behalf of the organization and its accounts
Description
Provides an Amazon Web Services service (the service that is specified by ServicePrincipal) with permissions to view the structure of an organization, create a service-linked role in all the accounts in the organization, and allow the service to perform operations on behalf of the organization and its accounts. Establishing these permissions can be a first step in enabling the integration of an Amazon Web Services service with Organizations.
See https://www.paws-r-sdk.com/docs/organizations_enable_aws_service_access/ for full documentation.
Usage
organizations_enable_aws_service_access(ServicePrincipal)
Arguments
ServicePrincipal |
[required] The service principal name of the Amazon Web Services service for which
you want to enable integration with your organization. This is typically
in the form of a URL, such as |
Enables a policy type in a root
Description
Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the disable_policy_type operation.
See https://www.paws-r-sdk.com/docs/organizations_enable_policy_type/ for full documentation.
Usage
organizations_enable_policy_type(RootId, PolicyType)
Arguments
RootId |
[required] The unique identifier (ID) of the root in which you want to enable a
policy type. You can get the ID from the
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits. |
PolicyType |
[required] The policy type that you want to enable. You can specify one of the following values: |
Sends an invitation to another account to join your organization as a member account
Description
Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.
See https://www.paws-r-sdk.com/docs/organizations_invite_account_to_organization/ for full documentation.
Usage
organizations_invite_account_to_organization(Target, Notes = NULL, Tags = NULL)
Arguments
Target |
[required] The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:
If you use the CLI, you can submit this as a single string, similar to the following example:
If you specify
|
Notes |
Additional information that you want to include in the generated email to the recipient account owner. |
Tags |
A list of tags that you want to attach to the account when it becomes a
member of the organization. For each tag in the list, you must specify
both a tag key and a value. You can set the value to an empty string,
but you can't set it to Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant. If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent. |
Removes a member account from its parent organization
Description
Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use remove_account_from_organization instead.
See https://www.paws-r-sdk.com/docs/organizations_leave_organization/ for full documentation.
Usage
organizations_leave_organization()
Lists all the accounts in the organization
Description
Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the list_accounts_for_parent operation instead.
See https://www.paws-r-sdk.com/docs/organizations_list_accounts/ for full documentation.
Usage
organizations_list_accounts(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU)
Description
Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the list_accounts operation.
See https://www.paws-r-sdk.com/docs/organizations_list_accounts_for_parent/ for full documentation.
Usage
organizations_list_accounts_for_parent(
ParentId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ParentId |
[required] The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list. |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Returns a list of the Amazon Web Services services that you enabled to integrate with your organization
Description
Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.
See https://www.paws-r-sdk.com/docs/organizations_list_aws_service_access_for_organization/ for full documentation.
Usage
organizations_list_aws_service_access_for_organization(
NextToken = NULL,
MaxResults = NULL
)
Arguments
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root
Description
Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with list_parents enables you to traverse the tree structure that makes up this root.
See https://www.paws-r-sdk.com/docs/organizations_list_children/ for full documentation.
Usage
organizations_list_children(
ParentId,
ChildType,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ParentId |
[required] The unique identifier (ID) for the parent root or OU whose children you want to list. The regex pattern for a parent ID string requires one of the following:
|
ChildType |
[required] Filters the output to include only the specified child type. |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the account creation requests that match the specified status that is currently being tracked for the organization
Description
Lists the account creation requests that match the specified status that is currently being tracked for the organization.
See https://www.paws-r-sdk.com/docs/organizations_list_create_account_status/ for full documentation.
Usage
organizations_list_create_account_status(
States = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
States |
A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response. |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization
Description
Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.
See https://www.paws-r-sdk.com/docs/organizations_list_delegated_administrators/ for full documentation.
Usage
organizations_list_delegated_administrators(
ServicePrincipal = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServicePrincipal |
Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service. If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization. |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
List the Amazon Web Services services for which the specified account is a delegated administrator
Description
List the Amazon Web Services services for which the specified account is a delegated administrator.
See https://www.paws-r-sdk.com/docs/organizations_list_delegated_services_for_account/ for full documentation.
Usage
organizations_list_delegated_services_for_account(
AccountId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
AccountId |
[required] The account ID number of a delegated administrator account in the organization. |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the current handshakes that are associated with the account of the requesting user
Description
Lists the current handshakes that are associated with the account of the requesting user.
See https://www.paws-r-sdk.com/docs/organizations_list_handshakes_for_account/ for full documentation.
Usage
organizations_list_handshakes_for_account(
Filter = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filter |
Filters the handshakes that you want included in the response. The
default is all types. Use the |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the handshakes that are associated with the organization that the requesting user is part of
Description
Lists the handshakes that are associated with the organization that the requesting user is part of. The list_handshakes_for_organization operation returns a list of handshake structures. Each structure contains details and status about a handshake.
See https://www.paws-r-sdk.com/docs/organizations_list_handshakes_for_organization/ for full documentation.
Usage
organizations_list_handshakes_for_organization(
Filter = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filter |
A filter of the handshakes that you want included in the response. The
default is all types. Use the |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the organizational units (OUs) in a parent organizational unit or root
Description
Lists the organizational units (OUs) in a parent organizational unit or root.
See https://www.paws-r-sdk.com/docs/organizations_list_organizational_units_for_parent/ for full documentation.
Usage
organizations_list_organizational_units_for_parent(
ParentId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ParentId |
[required] The unique identifier (ID) of the root or OU whose child OUs you want to list. The regex pattern for a parent ID string requires one of the following:
|
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account
Description
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with list_children enables you to traverse the tree structure that makes up this root.
See https://www.paws-r-sdk.com/docs/organizations_list_parents/ for full documentation.
Usage
organizations_list_parents(ChildId, NextToken = NULL, MaxResults = NULL)
Arguments
ChildId |
[required] The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root. The regex pattern for a child ID string requires one of the following:
|
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Retrieves the list of all policies in an organization of a specified type
Description
Retrieves the list of all policies in an organization of a specified type.
See https://www.paws-r-sdk.com/docs/organizations_list_policies/ for full documentation.
Usage
organizations_list_policies(Filter, NextToken = NULL, MaxResults = NULL)
Arguments
Filter |
[required] Specifies the type of policy that you want to include in the response. You must specify one of the following values: |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account
Description
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
See https://www.paws-r-sdk.com/docs/organizations_list_policies_for_target/ for full documentation.
Usage
organizations_list_policies_for_target(
TargetId,
Filter,
NextToken = NULL,
MaxResults = NULL
)
Arguments
TargetId |
[required] The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list. The regex pattern for a target ID string requires one of the following:
|
Filter |
[required] The type of policy that you want to include in the returned list. You must specify one of the following values: |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists the roots that are defined in the current organization
Description
Lists the roots that are defined in the current organization.
See https://www.paws-r-sdk.com/docs/organizations_list_roots/ for full documentation.
Usage
organizations_list_roots(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Lists tags that are attached to the specified resource
Description
Lists tags that are attached to the specified resource.
See https://www.paws-r-sdk.com/docs/organizations_list_tags_for_resource/ for full documentation.
Usage
organizations_list_tags_for_resource(ResourceId, NextToken = NULL)
Arguments
ResourceId |
[required] The ID of the resource with the tags to list. You can specify any of the following taggable resources.
|
NextToken |
The parameter for receiving additional results if you receive a
|
Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to
Description
Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
See https://www.paws-r-sdk.com/docs/organizations_list_targets_for_policy/ for full documentation.
Usage
organizations_list_targets_for_policy(
PolicyId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
PolicyId |
[required] The unique identifier (ID) of the policy whose attachments you want to know. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). |
NextToken |
The parameter for receiving additional results if you receive a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU
Description
Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
See https://www.paws-r-sdk.com/docs/organizations_move_account/ for full documentation.
Usage
organizations_move_account(AccountId, SourceParentId, DestinationParentId)
Arguments
AccountId |
[required] The unique identifier (ID) of the account that you want to move. The regex pattern for an account ID string requires exactly 12 digits. |
SourceParentId |
[required] The unique identifier (ID) of the root or organizational unit that you want to move the account from. The regex pattern for a parent ID string requires one of the following:
|
DestinationParentId |
[required] The unique identifier (ID) of the root or organizational unit that you want to move the account to. The regex pattern for a parent ID string requires one of the following:
|
Creates or updates a resource policy
Description
Creates or updates a resource policy.
See https://www.paws-r-sdk.com/docs/organizations_put_resource_policy/ for full documentation.
Usage
organizations_put_resource_policy(Content, Tags = NULL)
Arguments
Content |
[required] If provided, the new content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy's type. For more information, see SCP syntax in the Organizations User Guide. |
Tags |
A list of tags that you want to attach to the newly created resource
policy. For each tag in the list, you must specify both a tag key and a
value. You can set the value to an empty string, but you can't set it to
Calls with tags apply to the initial creation of the resource policy, otherwise an exception is thrown. If any one of the tags is not valid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created. |
Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service
Description
Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the Amazon Web Services service.
See https://www.paws-r-sdk.com/docs/organizations_register_delegated_administrator/ for full documentation.
Usage
organizations_register_delegated_administrator(AccountId, ServicePrincipal)
Arguments
AccountId |
[required] The account ID number of the member account in the organization to register as a delegated administrator. |
ServicePrincipal |
[required] The service principal of the Amazon Web Services service for which you want to make the member account a delegated administrator. |
Removes the specified account from the organization
Description
Removes the specified account from the organization.
See https://www.paws-r-sdk.com/docs/organizations_remove_account_from_organization/ for full documentation.
Usage
organizations_remove_account_from_organization(AccountId)
Arguments
AccountId |
[required] The unique identifier (ID) of the member account that you want to remove from the organization. The regex pattern for an account ID string requires exactly 12 digits. |
Adds one or more tags to the specified resource
Description
Adds one or more tags to the specified resource.
See https://www.paws-r-sdk.com/docs/organizations_tag_resource/ for full documentation.
Usage
organizations_tag_resource(ResourceId, Tags)
Arguments
ResourceId |
[required] The ID of the resource to add a tag to. You can specify any of the following taggable resources.
|
Tags |
[required] A list of tags to add to the specified resource. For each tag in the list, you must specify both a tag key and a value.
The value can be an empty string, but you can't set it to If any one of the tags is not valid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails. |
Removes any tags with the specified keys from the specified resource
Description
Removes any tags with the specified keys from the specified resource.
See https://www.paws-r-sdk.com/docs/organizations_untag_resource/ for full documentation.
Usage
organizations_untag_resource(ResourceId, TagKeys)
Arguments
ResourceId |
[required] The ID of the resource to remove a tag from. You can specify any of the following taggable resources.
|
TagKeys |
[required] The list of keys for tags to remove from the specified resource. |
Renames the specified organizational unit (OU)
Description
Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.
See https://www.paws-r-sdk.com/docs/organizations_update_organizational_unit/ for full documentation.
Usage
organizations_update_organizational_unit(OrganizationalUnitId, Name = NULL)
Arguments
OrganizationalUnitId |
[required] The unique identifier (ID) of the OU that you want to rename. You can
get the ID from the
The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. |
Name |
The new name that you want to assign to the OU. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. |
Updates an existing policy with a new name, description, or content
Description
Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.
See https://www.paws-r-sdk.com/docs/organizations_update_policy/ for full documentation.
Usage
organizations_update_policy(
PolicyId,
Name = NULL,
Description = NULL,
Content = NULL
)
Arguments
PolicyId |
[required] The unique identifier (ID) of the policy that you want to update. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). |
Name |
If provided, the new name for the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. |
Description |
If provided, the new description for the policy. |
Content |
If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see SCP syntax in the Organizations User Guide. The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide. |
AWS Performance Insights
Description
Amazon RDS Performance Insights
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide .
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
Usage
pi(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- pi(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_performance_analysis_report | Creates a new performance analysis report for a specific time period for the DB instance |
| delete_performance_analysis_report | Deletes a performance analysis report |
| describe_dimension_keys | For a specific time period, retrieve the top N dimension keys for a metric |
| get_dimension_key_details | Get the attributes of the specified dimension group for a DB instance or data source |
| get_performance_analysis_report | Retrieves the report including the report ID, status, time details, and the insights with recommendations |
| get_resource_metadata | Retrieve the metadata for different features |
| get_resource_metrics | Retrieve Performance Insights metrics for a set of data sources over a time period |
| list_available_resource_dimensions | Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance |
| list_available_resource_metrics | Retrieve metrics of the specified types that can be queried for a specified DB instance |
| list_performance_analysis_reports | Lists all the analysis reports created for the DB instance |
| list_tags_for_resource | Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource |
| tag_resource | Adds metadata tags to the Amazon RDS Performance Insights resource |
| untag_resource | Deletes the metadata tags from the Amazon RDS Performance Insights resource |
Examples
## Not run:
svc <- pi()
svc$create_performance_analysis_report(
Foo = 123
)
## End(Not run)
Creates a new performance analysis report for a specific time period for the DB instance
Description
Creates a new performance analysis report for a specific time period for the DB instance.
See https://www.paws-r-sdk.com/docs/pi_create_performance_analysis_report/ for full documentation.
Usage
pi_create_performance_analysis_report(
ServiceType,
Identifier,
StartTime,
EndTime,
Tags = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights will
return metrics. Valid value is |
Identifier |
[required] An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its
|
StartTime |
[required] The start time defined for the analysis report. |
EndTime |
[required] The end time defined for the analysis report. |
Tags |
The metadata assigned to the analysis report consisting of a key-value pair. |
Deletes a performance analysis report
Description
Deletes a performance analysis report.
See https://www.paws-r-sdk.com/docs/pi_delete_performance_analysis_report/ for full documentation.
Usage
pi_delete_performance_analysis_report(
ServiceType,
Identifier,
AnalysisReportId
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights will
return metrics. Valid value is |
Identifier |
[required] An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. In the console, the identifier is shown as ResourceID. When
you call To use a DB instance as a data source, specify its |
AnalysisReportId |
[required] The unique identifier of the analysis report for deletion. |
For a specific time period, retrieve the top N dimension keys for a metric
Description
For a specific time period, retrieve the top N dimension keys for a metric.
See https://www.paws-r-sdk.com/docs/pi_describe_dimension_keys/ for full documentation.
Usage
pi_describe_dimension_keys(
ServiceType,
Identifier,
StartTime,
EndTime,
Metric,
PeriodInSeconds = NULL,
GroupBy,
AdditionalMetrics = NULL,
PartitionBy = NULL,
Filter = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
|
Identifier |
[required] An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its
|
StartTime |
[required] The date and time specifying the beginning of the requested time series
data. You must specify a The value for |
EndTime |
[required] The date and time specifying the end of the requested time series data.
The value specified is exclusive, which means that data points less
than (but not equal to) The value for |
Metric |
[required] The name of a Performance Insights metric to be measured. Valid values for
If the number of active sessions is less than an internal Performance
Insights threshold, |
PeriodInSeconds |
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
If you don't specify |
GroupBy |
[required] A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension. |
AdditionalMetrics |
Additional metrics for the top The only supported statistic function is |
PartitionBy |
For each dimension specified in |
Filter |
One or more filters to apply in the request. Restrictions:
The |
MaxResults |
The maximum number of items to return in the response. If more items
exist than the specified |
NextToken |
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by |
Get the attributes of the specified dimension group for a DB instance or data source
Description
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, get_dimension_key_details retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because get_resource_metrics and describe_dimension_keys don't support retrieval of large SQL statement text, lock snapshots, and execution plans.
See https://www.paws-r-sdk.com/docs/pi_get_dimension_key_details/ for full documentation.
Usage
pi_get_dimension_key_details(
ServiceType,
Identifier,
Group,
GroupIdentifier,
RequestedDimensions = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns
data. The only valid value is |
Identifier |
[required] The ID for a data source from which to gather dimension data. This ID
must be immutable and unique within an Amazon Web Services Region. When
a DB instance is the data source, specify its |
Group |
[required] The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:
|
GroupIdentifier |
[required] The ID of the dimension group from which to retrieve dimension details.
For dimension group
|
RequestedDimensions |
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
|
Retrieves the report including the report ID, status, time details, and the insights with recommendations
Description
Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.
See https://www.paws-r-sdk.com/docs/pi_get_performance_analysis_report/ for full documentation.
Usage
pi_get_performance_analysis_report(
ServiceType,
Identifier,
AnalysisReportId,
TextFormat = NULL,
AcceptLanguage = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights will
return metrics. Valid value is |
Identifier |
[required] An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. In the console, the identifier is shown as ResourceID. When
you call To use a DB instance as a data source, specify its |
AnalysisReportId |
[required] A unique identifier of the created analysis report. For example,
|
TextFormat |
Indicates the text format in the report. The options are |
AcceptLanguage |
The text language in the report. The default language is |
Retrieve the metadata for different features
Description
Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
See https://www.paws-r-sdk.com/docs/pi_get_resource_metadata/ for full documentation.
Usage
pi_get_resource_metadata(ServiceType, Identifier)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns metrics. |
Identifier |
[required] An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. To use a DB instance as a data source, specify its
|
Retrieve Performance Insights metrics for a set of data sources over a time period
Description
Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.
See https://www.paws-r-sdk.com/docs/pi_get_resource_metrics/ for full documentation.
Usage
pi_get_resource_metrics(
ServiceType,
Identifier,
MetricQueries,
StartTime,
EndTime,
PeriodInSeconds = NULL,
MaxResults = NULL,
NextToken = NULL,
PeriodAlignment = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
|
Identifier |
[required] An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. In the console, the identifier is shown as ResourceID. When
you call To use a DB instance as a data source, specify its |
MetricQueries |
[required] An array of one or more queries to perform. Each query must specify a
Performance Insights metric and specify an aggregate function, and you
can provide filtering criteria. You must append the aggregate function
to the metric. For example, to find the average for the metric |
StartTime |
[required] The date and time specifying the beginning of the requested time series
query range. You can't specify a The value for |
EndTime |
[required] The date and time specifying the end of the requested time series query
range. The value specified is exclusive. Thus, the command returns
data points less than (but not equal to) The value for |
PeriodInSeconds |
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
If you don't specify |
MaxResults |
The maximum number of items to return in the response. |
NextToken |
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by |
PeriodAlignment |
The returned timestamp which is the start or end time of the time
periods. The default value is |
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance
Description
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
See https://www.paws-r-sdk.com/docs/pi_list_available_resource_dimensions/ for full documentation.
Usage
pi_list_available_resource_dimensions(
ServiceType,
Identifier,
Metrics,
MaxResults = NULL,
NextToken = NULL,
AuthorizedActions = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns metrics. |
Identifier |
[required] An immutable identifier for a data source that is unique within an
Amazon Web Services Region. Performance Insights gathers metrics from
this data source. To use an Amazon RDS DB instance as a data source,
specify its |
Metrics |
[required] The types of metrics for which to retrieve dimensions. Valid values
include |
MaxResults |
The maximum number of items to return in the response. If more items
exist than the specified |
NextToken |
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by |
AuthorizedActions |
The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions. When you don't specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them. |
Retrieve metrics of the specified types that can be queried for a specified DB instance
Description
Retrieve metrics of the specified types that can be queried for a specified DB instance.
See https://www.paws-r-sdk.com/docs/pi_list_available_resource_metrics/ for full documentation.
Usage
pi_list_available_resource_metrics(
ServiceType,
Identifier,
MetricTypes,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns metrics. |
Identifier |
[required] An immutable identifier for a data source that is unique within an
Amazon Web Services Region. Performance Insights gathers metrics from
this data source. To use an Amazon RDS DB instance as a data source,
specify its |
MetricTypes |
[required] The types of metrics to return in the response. Valid values in the array include the following:
|
NextToken |
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by |
MaxResults |
The maximum number of items to return. If the |
Lists all the analysis reports created for the DB instance
Description
Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
See https://www.paws-r-sdk.com/docs/pi_list_performance_analysis_reports/ for full documentation.
Usage
pi_list_performance_analysis_reports(
ServiceType,
Identifier,
NextToken = NULL,
MaxResults = NULL,
ListTags = NULL
)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns
metrics. Valid value is |
Identifier |
[required] An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. In the console, the identifier is shown as ResourceID. When
you call To use a DB instance as a data source, specify its |
NextToken |
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by |
MaxResults |
The maximum number of items to return in the response. If more items
exist than the specified |
ListTags |
Specifies whether or not to include the list of tags in the response. |
Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource
Description
Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
See https://www.paws-r-sdk.com/docs/pi_list_tags_for_resource/ for full documentation.
Usage
pi_list_tags_for_resource(ServiceType, ResourceARN)
Arguments
ServiceType |
[required] List the tags for the Amazon Web Services service for which Performance
Insights returns metrics. Valid value is |
ResourceARN |
[required] Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). |
Adds metadata tags to the Amazon RDS Performance Insights resource
Description
Adds metadata tags to the Amazon RDS Performance Insights resource.
See https://www.paws-r-sdk.com/docs/pi_tag_resource/ for full documentation.
Usage
pi_tag_resource(ServiceType, ResourceARN, Tags)
Arguments
ServiceType |
[required] The Amazon Web Services service for which Performance Insights returns
metrics. Valid value is |
ResourceARN |
[required] The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). |
Tags |
[required] The metadata assigned to an Amazon RDS resource consisting of a key-value pair. |
Deletes the metadata tags from the Amazon RDS Performance Insights resource
Description
Deletes the metadata tags from the Amazon RDS Performance Insights resource.
See https://www.paws-r-sdk.com/docs/pi_untag_resource/ for full documentation.
Usage
pi_untag_resource(ServiceType, ResourceARN, TagKeys)
Arguments
ServiceType |
[required] List the tags for the Amazon Web Services service for which Performance
Insights returns metrics. Valid value is |
ResourceARN |
[required] The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). |
TagKeys |
[required] The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair. |
Amazon Prometheus Service
Description
Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.
For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
Amazon Managed Service for Prometheus includes two APIs.
Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.
Use the Prometheus-compatible API to work within your Prometheus workspace.
Usage
prometheusservice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- prometheusservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_alert_manager_definition | The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace |
| create_logging_configuration | The CreateLoggingConfiguration operation creates a logging configuration for the workspace |
| create_rule_groups_namespace | The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace |
| create_scraper | The CreateScraper operation creates a scraper to collect metrics |
| create_workspace | Creates a Prometheus workspace |
| delete_alert_manager_definition | Deletes the alert manager definition from a workspace |
| delete_logging_configuration | Deletes the logging configuration for a workspace |
| delete_rule_groups_namespace | Deletes one rule groups namespace and its associated rule groups definition |
| delete_scraper | The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs |
| delete_workspace | Deletes an existing workspace |
| describe_alert_manager_definition | Retrieves the full information about the alert manager definition for a workspace |
| describe_logging_configuration | Returns complete information about the current logging configuration of the workspace |
| describe_rule_groups_namespace | Returns complete information about one rule groups namespace |
| describe_scraper | The DescribeScraper operation displays information about an existing scraper |
| describe_workspace | Returns information about an existing workspace |
| get_default_scraper_configuration | The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you |
| list_rule_groups_namespaces | Returns a list of rule groups namespaces in a workspace |
| list_scrapers | The ListScrapers operation lists all of the scrapers in your account |
| list_tags_for_resource | The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource |
| list_workspaces | Lists all of the Amazon Managed Service for Prometheus workspaces in your account |
| put_alert_manager_definition | Updates an existing alert manager definition in a workspace |
| put_rule_groups_namespace | Updates an existing rule groups namespace within a workspace |
| tag_resource | The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource |
| untag_resource | Removes the specified tags from an Amazon Managed Service for Prometheus resource |
| update_logging_configuration | Updates the log group ARN or the workspace ID of the current logging configuration |
| update_scraper | Updates an existing scraper |
| update_workspace_alias | Updates the alias of an existing workspace |
Examples
## Not run:
svc <- prometheusservice()
svc$create_alert_manager_definition(
Foo = 123
)
## End(Not run)
The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace
Description
The create_alert_manager_definition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use put_alert_manager_definition.
See https://www.paws-r-sdk.com/docs/prometheusservice_create_alert_manager_definition/ for full documentation.
Usage
prometheusservice_create_alert_manager_definition(
clientToken = NULL,
data,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
data |
[required] The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file. For details about the alert manager definition, see AlertManagedDefinitionData. |
workspaceId |
[required] The ID of the workspace to add the alert manager definition to. |
The CreateLoggingConfiguration operation creates a logging configuration for the workspace
Description
The create_logging_configuration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
See https://www.paws-r-sdk.com/docs/prometheusservice_create_logging_configuration/ for full documentation.
Usage
prometheusservice_create_logging_configuration(
clientToken = NULL,
logGroupArn,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
logGroupArn |
[required] The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation. |
workspaceId |
[required] The ID of the workspace to create the logging configuration for. |
The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace
Description
The create_rule_groups_namespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
See https://www.paws-r-sdk.com/docs/prometheusservice_create_rule_groups_namespace/ for full documentation.
Usage
prometheusservice_create_rule_groups_namespace(
clientToken = NULL,
data,
name,
tags = NULL,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
data |
[required] The rules file to use in the new namespace. Contains the base64-encoded version of the YAML rules file. For details about the rule groups namespace structure, see RuleGroupsNamespaceData. |
name |
[required] The name for the new rule groups namespace. |
tags |
The list of tag keys and values to associate with the rule groups namespace. |
workspaceId |
[required] The ID of the workspace to add the rule groups namespace. |
The CreateScraper operation creates a scraper to collect metrics
Description
The create_scraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
See https://www.paws-r-sdk.com/docs/prometheusservice_create_scraper/ for full documentation.
Usage
prometheusservice_create_scraper(
alias = NULL,
clientToken = NULL,
destination,
roleConfiguration = NULL,
scrapeConfiguration,
source,
tags = NULL
)
Arguments
alias |
(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique. |
clientToken |
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request. |
destination |
[required] The Amazon Managed Service for Prometheus workspace to send metrics to. |
roleConfiguration |
The scraper role configuration for the workspace. |
scrapeConfiguration |
[required] The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide. |
source |
[required] The Amazon EKS cluster from which the scraper will collect metrics. |
tags |
(Optional) The list of tag keys and values to associate with the scraper. |
Creates a Prometheus workspace
Description
Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
See https://www.paws-r-sdk.com/docs/prometheusservice_create_workspace/ for full documentation.
Usage
prometheusservice_create_workspace(
alias = NULL,
clientToken = NULL,
kmsKeyArn = NULL,
tags = NULL
)
Arguments
alias |
An alias that you assign to this workspace to help you identify it. It does not need to be unique. Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used. |
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
kmsKeyArn |
(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide. |
tags |
The list of tag keys and values to associate with the workspace. |
Deletes the alert manager definition from a workspace
Description
Deletes the alert manager definition from a workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_delete_alert_manager_definition/ for full documentation.
Usage
prometheusservice_delete_alert_manager_definition(
clientToken = NULL,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
workspaceId |
[required] The ID of the workspace to delete the alert manager definition from. |
Deletes the logging configuration for a workspace
Description
Deletes the logging configuration for a workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_delete_logging_configuration/ for full documentation.
Usage
prometheusservice_delete_logging_configuration(clientToken = NULL, workspaceId)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
workspaceId |
[required] The ID of the workspace containing the logging configuration to delete. |
Deletes one rule groups namespace and its associated rule groups definition
Description
Deletes one rule groups namespace and its associated rule groups definition.
See https://www.paws-r-sdk.com/docs/prometheusservice_delete_rule_groups_namespace/ for full documentation.
Usage
prometheusservice_delete_rule_groups_namespace(
clientToken = NULL,
name,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
name |
[required] The name of the rule groups namespace to delete. |
workspaceId |
[required] The ID of the workspace containing the rule groups namespace and definition to delete. |
The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs
Description
The delete_scraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
See https://www.paws-r-sdk.com/docs/prometheusservice_delete_scraper/ for full documentation.
Usage
prometheusservice_delete_scraper(clientToken = NULL, scraperId)
Arguments
clientToken |
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request. |
scraperId |
[required] The ID of the scraper to delete. |
Deletes an existing workspace
Description
Deletes an existing workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_delete_workspace/ for full documentation.
Usage
prometheusservice_delete_workspace(clientToken = NULL, workspaceId)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
workspaceId |
[required] The ID of the workspace to delete. |
Retrieves the full information about the alert manager definition for a workspace
Description
Retrieves the full information about the alert manager definition for a workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_describe_alert_manager_definition/ for full documentation.
Usage
prometheusservice_describe_alert_manager_definition(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to retrieve the alert manager definition from. |
Returns complete information about the current logging configuration of the workspace
Description
Returns complete information about the current logging configuration of the workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_describe_logging_configuration/ for full documentation.
Usage
prometheusservice_describe_logging_configuration(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to describe the logging configuration for. |
Returns complete information about one rule groups namespace
Description
Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use list_rule_groups_namespaces.
See https://www.paws-r-sdk.com/docs/prometheusservice_describe_rule_groups_namespace/ for full documentation.
Usage
prometheusservice_describe_rule_groups_namespace(name, workspaceId)
Arguments
name |
[required] The name of the rule groups namespace that you want information for. |
workspaceId |
[required] The ID of the workspace containing the rule groups namespace. |
The DescribeScraper operation displays information about an existing scraper
Description
The describe_scraper operation displays information about an existing scraper.
See https://www.paws-r-sdk.com/docs/prometheusservice_describe_scraper/ for full documentation.
Usage
prometheusservice_describe_scraper(scraperId)
Arguments
scraperId |
[required] The ID of the scraper to describe. |
Returns information about an existing workspace
Description
Returns information about an existing workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_describe_workspace/ for full documentation.
Usage
prometheusservice_describe_workspace(workspaceId)
Arguments
workspaceId |
[required] The ID of the workspace to describe. |
The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you
Description
The get_default_scraper_configuration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
See https://www.paws-r-sdk.com/docs/prometheusservice_get_default_scraper_configuration/ for full documentation.
Usage
prometheusservice_get_default_scraper_configuration()
Returns a list of rule groups namespaces in a workspace
Description
Returns a list of rule groups namespaces in a workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_list_rule_groups_namespaces/ for full documentation.
Usage
prometheusservice_list_rule_groups_namespaces(
maxResults = NULL,
name = NULL,
nextToken = NULL,
workspaceId
)
Arguments
maxResults |
The maximum number of results to return. The default is 100. |
name |
Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned. |
nextToken |
The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call. For example, if your initial request has |
workspaceId |
[required] The ID of the workspace containing the rule groups namespaces. |
The ListScrapers operation lists all of the scrapers in your account
Description
The list_scrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.
See https://www.paws-r-sdk.com/docs/prometheusservice_list_scrapers/ for full documentation.
Usage
prometheusservice_list_scrapers(
filters = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
filters |
(Optional) A list of key-value pairs to filter the list of scrapers
returned. Keys include Filters on the same key are To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:
If this is included, it filters the results to only the scrapers that match the filter. |
maxResults |
Optional) The maximum number of scrapers to return in one
If you omit this parameter, the default of 100 is used. |
nextToken |
(Optional) The token for the next set of items to return. (You received this token from a previous call.) |
The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource
Description
The list_tags_for_resource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.
See https://www.paws-r-sdk.com/docs/prometheusservice_list_tags_for_resource/ for full documentation.
Usage
prometheusservice_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups namespace resource. |
Lists all of the Amazon Managed Service for Prometheus workspaces in your account
Description
Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
See https://www.paws-r-sdk.com/docs/prometheusservice_list_workspaces/ for full documentation.
Usage
prometheusservice_list_workspaces(
alias = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
alias |
If this is included, it filters the results to only the workspaces with names that start with the value that you specify here. Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify. |
maxResults |
The maximum number of workspaces to return per request. The default is 100. |
nextToken |
The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call. For example, if your initial request has |
Updates an existing alert manager definition in a workspace
Description
Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use create_alert_manager_definition.
See https://www.paws-r-sdk.com/docs/prometheusservice_put_alert_manager_definition/ for full documentation.
Usage
prometheusservice_put_alert_manager_definition(
clientToken = NULL,
data,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
data |
[required] The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file. For details about the alert manager definition, see AlertManagedDefinitionData. |
workspaceId |
[required] The ID of the workspace to update the alert manager definition in. |
Updates an existing rule groups namespace within a workspace
Description
Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
See https://www.paws-r-sdk.com/docs/prometheusservice_put_rule_groups_namespace/ for full documentation.
Usage
prometheusservice_put_rule_groups_namespace(
clientToken = NULL,
data,
name,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
data |
[required] The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file. For details about the rule groups namespace structure, see RuleGroupsNamespaceData. |
name |
[required] The name of the rule groups namespace that you are updating. |
workspaceId |
[required] The ID of the workspace where you are updating the rule groups namespace. |
The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource
Description
The tag_resource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
See https://www.paws-r-sdk.com/docs/prometheusservice_tag_resource/ for full documentation.
Usage
prometheusservice_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The ARN of the resource to apply tags to. |
tags |
[required] The list of tag keys and values to associate with the resource. Keys must not begin with |
Removes the specified tags from an Amazon Managed Service for Prometheus resource
Description
Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
See https://www.paws-r-sdk.com/docs/prometheusservice_untag_resource/ for full documentation.
Usage
prometheusservice_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The ARN of the resource from which to remove a tag. |
tagKeys |
[required] The keys of the tags to remove. |
Updates the log group ARN or the workspace ID of the current logging configuration
Description
Updates the log group ARN or the workspace ID of the current logging configuration.
See https://www.paws-r-sdk.com/docs/prometheusservice_update_logging_configuration/ for full documentation.
Usage
prometheusservice_update_logging_configuration(
clientToken = NULL,
logGroupArn,
workspaceId
)
Arguments
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
logGroupArn |
[required] The ARN of the CloudWatch log group to which the vended log data will be published. |
workspaceId |
[required] The ID of the workspace to update the logging configuration for. |
Updates an existing scraper
Description
Updates an existing scraper.
See https://www.paws-r-sdk.com/docs/prometheusservice_update_scraper/ for full documentation.
Usage
prometheusservice_update_scraper(
alias = NULL,
clientToken = NULL,
destination = NULL,
roleConfiguration = NULL,
scrapeConfiguration = NULL,
scraperId
)
Arguments
alias |
The new alias of the scraper. |
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
destination |
The new Amazon Managed Service for Prometheus workspace to send metrics to. |
roleConfiguration |
The scraper role configuration for the workspace. |
scrapeConfiguration |
Contains the base-64 encoded YAML configuration for the scraper. For more information about configuring a scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide. |
scraperId |
[required] The ID of the scraper to update. |
Updates the alias of an existing workspace
Description
Updates the alias of an existing workspace.
See https://www.paws-r-sdk.com/docs/prometheusservice_update_workspace_alias/ for full documentation.
Usage
prometheusservice_update_workspace_alias(
alias = NULL,
clientToken = NULL,
workspaceId
)
Arguments
alias |
The new alias for the workspace. It does not need to be unique. Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify. |
clientToken |
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive. |
workspaceId |
[required] The ID of the workspace to update. |
Objects exported from other packages
Description
These objects are imported from other packages. Follow the links below to see their documentation.
- paws.common
config,credentials,creds,list_paginators,paginate,paginate_lapply,paginate_sapply,paws_stream_parser
AWS Resilience Hub
Description
Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
Usage
resiliencehub(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- resiliencehub(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| accept_resource_grouping_recommendations | Accepts the resource grouping recommendations suggested by Resilience Hub for your application |
| add_draft_app_version_resource_mappings | Adds the source of resource-maps to the draft version of an application |
| batch_update_recommendation_status | Enables you to include or exclude one or more operational recommendations |
| create_app | Creates an Resilience Hub application |
| create_app_version_app_component | Creates a new Application Component in the Resilience Hub application |
| create_app_version_resource | Adds a resource to the Resilience Hub application and assigns it to the specified Application Components |
| create_recommendation_template | Creates a new recommendation template for the Resilience Hub application |
| create_resiliency_policy | Creates a resiliency policy for an application |
| delete_app | Deletes an Resilience Hub application |
| delete_app_assessment | Deletes an Resilience Hub application assessment |
| delete_app_input_source | Deletes the input source and all of its imported resources from the Resilience Hub application |
| delete_app_version_app_component | Deletes an Application Component from the Resilience Hub application |
| delete_app_version_resource | Deletes a resource from the Resilience Hub application |
| delete_recommendation_template | Deletes a recommendation template |
| delete_resiliency_policy | Deletes a resiliency policy |
| describe_app | Describes an Resilience Hub application |
| describe_app_assessment | Describes an assessment for an Resilience Hub application |
| describe_app_version | Describes the Resilience Hub application version |
| describe_app_version_app_component | Describes an Application Component in the Resilience Hub application |
| describe_app_version_resource | Describes a resource of the Resilience Hub application |
| describe_app_version_resources_resolution_status | Returns the resolution status for the specified resolution identifier for an application version |
| describe_app_version_template | Describes details about an Resilience Hub application |
| describe_draft_app_version_resources_import_status | Describes the status of importing resources to an application version |
| describe_metrics_export | Describes the metrics of the application configuration being exported |
| describe_resiliency_policy | Describes a specified resiliency policy for an Resilience Hub application |
| describe_resource_grouping_recommendation_task | Describes the resource grouping recommendation tasks run by Resilience Hub for your application |
| import_resources_to_draft_app_version | Imports resources to Resilience Hub application draft version from different input sources |
| list_alarm_recommendations | Lists the alarm recommendations for an Resilience Hub application |
| list_app_assessment_compliance_drifts | List of compliance drifts that were detected while running an assessment |
| list_app_assessment_resource_drifts | List of resource drifts that were detected while running an assessment |
| list_app_assessments | Lists the assessments for an Resilience Hub application |
| list_app_component_compliances | Lists the compliances for an Resilience Hub Application Component |
| list_app_component_recommendations | Lists the recommendations for an Resilience Hub Application Component |
| list_app_input_sources | Lists all the input sources of the Resilience Hub application |
| list_apps | Lists your Resilience Hub applications |
| list_app_version_app_components | Lists all the Application Components in the Resilience Hub application |
| list_app_version_resource_mappings | Lists how the resources in an application version are mapped/sourced from |
| list_app_version_resources | Lists all the resources in an Resilience Hub application |
| list_app_versions | Lists the different versions for the Resilience Hub applications |
| list_metrics | Lists the metrics that can be exported |
| list_recommendation_templates | Lists the recommendation templates for the Resilience Hub applications |
| list_resiliency_policies | Lists the resiliency policies for the Resilience Hub applications |
| list_resource_grouping_recommendations | Lists the resource grouping recommendations suggested by Resilience Hub for your application |
| list_sop_recommendations | Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications |
| list_suggested_resiliency_policies | Lists the suggested resiliency policies for the Resilience Hub applications |
| list_tags_for_resource | Lists the tags for your resources in your Resilience Hub applications |
| list_test_recommendations | Lists the test recommendations for the Resilience Hub application |
| list_unsupported_app_version_resources | Lists the resources that are not currently supported in Resilience Hub |
| publish_app_version | Publishes a new version of a specific Resilience Hub application |
| put_draft_app_version_template | Adds or updates the app template for an Resilience Hub application draft version |
| reject_resource_grouping_recommendations | Rejects resource grouping recommendations |
| remove_draft_app_version_resource_mappings | Removes resource mappings from a draft application version |
| resolve_app_version_resources | Resolves the resources for an application version |
| start_app_assessment | Creates a new application assessment for an application |
| start_metrics_export | Initiates the export task of metrics |
| start_resource_grouping_recommendation_task | Starts grouping recommendation task |
| tag_resource | Applies one or more tags to a resource |
| untag_resource | Removes one or more tags from a resource |
| update_app | Updates an application |
| update_app_version | Updates the Resilience Hub application version |
| update_app_version_app_component | Updates an existing Application Component in the Resilience Hub application |
| update_app_version_resource | Updates the resource details in the Resilience Hub application |
| update_resiliency_policy | Updates a resiliency policy |
Examples
## Not run:
svc <- resiliencehub()
svc$accept_resource_grouping_recommendations(
Foo = 123
)
## End(Not run)
Accepts the resource grouping recommendations suggested by Resilience Hub for your application
Description
Accepts the resource grouping recommendations suggested by Resilience Hub for your application.
See https://www.paws-r-sdk.com/docs/resiliencehub_accept_resource_grouping_recommendations/ for full documentation.
Usage
resiliencehub_accept_resource_grouping_recommendations(appArn, entries)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
entries |
[required] List of resource grouping recommendations you want to include in your application. |
Adds the source of resource-maps to the draft version of an application
Description
Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources supported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide.
See https://www.paws-r-sdk.com/docs/resiliencehub_add_draft_app_version_resource_mappings/ for full documentation.
Usage
resiliencehub_add_draft_app_version_resource_mappings(appArn, resourceMappings)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
resourceMappings |
[required] Mappings used to map logical resources from the template to physical
resources. You can use the mapping type |
Enables you to include or exclude one or more operational recommendations
Description
Enables you to include or exclude one or more operational recommendations.
See https://www.paws-r-sdk.com/docs/resiliencehub_batch_update_recommendation_status/ for full documentation.
Usage
resiliencehub_batch_update_recommendation_status(appArn, requestEntries)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
requestEntries |
[required] Defines the list of operational recommendations that need to be included or excluded. |
Creates an Resilience Hub application
Description
Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.
See https://www.paws-r-sdk.com/docs/resiliencehub_create_app/ for full documentation.
Usage
resiliencehub_create_app(
assessmentSchedule = NULL,
awsApplicationArn = NULL,
clientToken = NULL,
description = NULL,
eventSubscriptions = NULL,
name,
permissionModel = NULL,
policyArn = NULL,
tags = NULL
)
Arguments
assessmentSchedule |
Assessment execution schedule with 'Daily' or 'Disabled' values. |
awsApplicationArn |
Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide. |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
description |
The optional description for an app. |
eventSubscriptions |
The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification. |
name |
[required] Name of the application. |
permissionModel |
Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment. |
policyArn |
Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is:
arn: |
tags |
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair. |
Creates a new Application Component in the Resilience Hub application
Description
Creates a new Application Component in the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_create_app_version_app_component/ for full documentation.
Usage
resiliencehub_create_app_version_app_component(
additionalInfo = NULL,
appArn,
clientToken = NULL,
id = NULL,
name,
type
)
Arguments
additionalInfo |
Currently, there is no supported additional information for Application Components. |
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
id |
Identifier of the Application Component. |
name |
[required] Name of the Application Component. |
type |
[required] Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. |
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components
Description
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.
See https://www.paws-r-sdk.com/docs/resiliencehub_create_app_version_resource/ for full documentation.
Usage
resiliencehub_create_app_version_resource(
additionalInfo = NULL,
appArn,
appComponents,
awsAccountId = NULL,
awsRegion = NULL,
clientToken = NULL,
logicalResourceId,
physicalResourceId,
resourceName = NULL,
resourceType
)
Arguments
additionalInfo |
Currently, there is no supported additional information for resources. |
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appComponents |
[required] List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added. |
awsAccountId |
Amazon Web Services account that owns the physical resource. |
awsRegion |
Amazon Web Services region that owns the physical resource. |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
logicalResourceId |
[required] Logical identifier of the resource. |
physicalResourceId |
[required] Physical identifier of the resource. |
resourceName |
Name of the resource. |
resourceType |
[required] Type of resource. |
Creates a new recommendation template for the Resilience Hub application
Description
Creates a new recommendation template for the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_create_recommendation_template/ for full documentation.
Usage
resiliencehub_create_recommendation_template(
assessmentArn,
bucketName = NULL,
clientToken = NULL,
format = NULL,
name,
recommendationIds = NULL,
recommendationTypes = NULL,
tags = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
bucketName |
The name of the Amazon S3 bucket that will contain the recommendation template. |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
format |
The format for the recommendation template. CfnJson The template is CloudFormation JSON. CfnYaml The template is CloudFormation YAML. |
name |
[required] The name for the recommendation template. |
recommendationIds |
Identifiers for the recommendations used to create a recommendation template. |
recommendationTypes |
An array of strings that specify the recommendation template type or types. Alarm The template is an AlarmRecommendation template. Sop The template is a SopRecommendation template. Test The template is a TestRecommendation template. |
tags |
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair. |
Creates a resiliency policy for an application
Description
Creates a resiliency policy for an application.
See https://www.paws-r-sdk.com/docs/resiliencehub_create_resiliency_policy/ for full documentation.
Usage
resiliencehub_create_resiliency_policy(
clientToken = NULL,
dataLocationConstraint = NULL,
policy,
policyDescription = NULL,
policyName,
tags = NULL,
tier
)
Arguments
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
dataLocationConstraint |
Specifies a high-level geographical location constraint for where your resilience policy data can be stored. |
policy |
[required] The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds. |
policyDescription |
Description of the resiliency policy. |
policyName |
[required] Name of the resiliency policy. |
tags |
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair. |
tier |
[required] The tier for this resiliency policy, ranging from the highest severity
( |
Deletes an Resilience Hub application
Description
Deletes an Resilience Hub application. This is a destructive action that can't be undone.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_app/ for full documentation.
Usage
resiliencehub_delete_app(appArn, clientToken = NULL, forceDelete = NULL)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
forceDelete |
A boolean option to force the deletion of an Resilience Hub application. |
Deletes an Resilience Hub application assessment
Description
Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_app_assessment/ for full documentation.
Usage
resiliencehub_delete_app_assessment(assessmentArn, clientToken = NULL)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
Deletes the input source and all of its imported resources from the Resilience Hub application
Description
Deletes the input source and all of its imported resources from the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_app_input_source/ for full documentation.
Usage
resiliencehub_delete_app_input_source(
appArn,
clientToken = NULL,
eksSourceClusterNamespace = NULL,
sourceArn = NULL,
terraformSource = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
eksSourceClusterNamespace |
The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application. |
sourceArn |
The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide. |
terraformSource |
The imported Terraform s3 state file you want to remove from the Resilience Hub application. |
Deletes an Application Component from the Resilience Hub application
Description
Deletes an Application Component from the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_app_version_app_component/ for full documentation.
Usage
resiliencehub_delete_app_version_app_component(appArn, clientToken = NULL, id)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
id |
[required] Identifier of the Application Component. |
Deletes a resource from the Resilience Hub application
Description
Deletes a resource from the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_app_version_resource/ for full documentation.
Usage
resiliencehub_delete_app_version_resource(
appArn,
awsAccountId = NULL,
awsRegion = NULL,
clientToken = NULL,
logicalResourceId = NULL,
physicalResourceId = NULL,
resourceName = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
awsAccountId |
Amazon Web Services account that owns the physical resource. |
awsRegion |
Amazon Web Services region that owns the physical resource. |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
logicalResourceId |
Logical identifier of the resource. |
physicalResourceId |
Physical identifier of the resource. |
resourceName |
Name of the resource. |
Deletes a recommendation template
Description
Deletes a recommendation template. This is a destructive action that can't be undone.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_recommendation_template/ for full documentation.
Usage
resiliencehub_delete_recommendation_template(
clientToken = NULL,
recommendationTemplateArn
)
Arguments
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
recommendationTemplateArn |
[required] The Amazon Resource Name (ARN) for a recommendation template. |
Deletes a resiliency policy
Description
Deletes a resiliency policy. This is a destructive action that can't be undone.
See https://www.paws-r-sdk.com/docs/resiliencehub_delete_resiliency_policy/ for full documentation.
Usage
resiliencehub_delete_resiliency_policy(clientToken = NULL, policyArn)
Arguments
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
policyArn |
[required] Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is:
arn: |
Describes an Resilience Hub application
Description
Describes an Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app/ for full documentation.
Usage
resiliencehub_describe_app(appArn)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
Describes an assessment for an Resilience Hub application
Description
Describes an assessment for an Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app_assessment/ for full documentation.
Usage
resiliencehub_describe_app_assessment(assessmentArn)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
Describes the Resilience Hub application version
Description
Describes the Resilience Hub application version.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app_version/ for full documentation.
Usage
resiliencehub_describe_app_version(appArn, appVersion)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] Resilience Hub application version. |
Describes an Application Component in the Resilience Hub application
Description
Describes an Application Component in the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app_version_app_component/ for full documentation.
Usage
resiliencehub_describe_app_version_app_component(appArn, appVersion, id)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] Resilience Hub application version. |
id |
[required] Identifier of the Application Component. |
Describes a resource of the Resilience Hub application
Description
Describes a resource of the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app_version_resource/ for full documentation.
Usage
resiliencehub_describe_app_version_resource(
appArn,
appVersion,
awsAccountId = NULL,
awsRegion = NULL,
logicalResourceId = NULL,
physicalResourceId = NULL,
resourceName = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] Resilience Hub application version. |
awsAccountId |
Amazon Web Services account that owns the physical resource. |
awsRegion |
Amazon Web Services region that owns the physical resource. |
logicalResourceId |
Logical identifier of the resource. |
physicalResourceId |
Physical identifier of the resource. |
resourceName |
Name of the resource. |
Returns the resolution status for the specified resolution identifier for an application version
Description
Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app_version_resources_resolution_status/ for full documentation.
Usage
resiliencehub_describe_app_version_resources_resolution_status(
appArn,
appVersion,
resolutionId = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
resolutionId |
The identifier for a specific resolution. |
Describes details about an Resilience Hub application
Description
Describes details about an Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_app_version_template/ for full documentation.
Usage
resiliencehub_describe_app_version_template(appArn, appVersion)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
Describes the status of importing resources to an application version
Description
Describes the status of importing resources to an application version.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_draft_app_version_resources_import_status/ for full documentation.
Usage
resiliencehub_describe_draft_app_version_resources_import_status(appArn)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
Describes the metrics of the application configuration being exported
Description
Describes the metrics of the application configuration being exported.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_metrics_export/ for full documentation.
Usage
resiliencehub_describe_metrics_export(metricsExportId)
Arguments
metricsExportId |
[required] Identifier of the metrics export task. |
Describes a specified resiliency policy for an Resilience Hub application
Description
Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_resiliency_policy/ for full documentation.
Usage
resiliencehub_describe_resiliency_policy(policyArn)
Arguments
policyArn |
[required] Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is:
arn: |
Describes the resource grouping recommendation tasks run by Resilience Hub for your application
Description
Describes the resource grouping recommendation tasks run by Resilience Hub for your application.
See https://www.paws-r-sdk.com/docs/resiliencehub_describe_resource_grouping_recommendation_task/ for full documentation.
Usage
resiliencehub_describe_resource_grouping_recommendation_task(
appArn,
groupingId = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
groupingId |
Identifier of the grouping recommendation task. |
Imports resources to Resilience Hub application draft version from different input sources
Description
Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_import_resources_to_draft_app_version/ for full documentation.
Usage
resiliencehub_import_resources_to_draft_app_version(
appArn,
eksSources = NULL,
importStrategy = NULL,
sourceArns = NULL,
terraformSources = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
eksSources |
The input sources of the Amazon Elastic Kubernetes Service resources you need to import. |
importStrategy |
The import strategy you would like to set to import resources into Resilience Hub application. |
sourceArns |
The Amazon Resource Names (ARNs) for the resources. |
terraformSources |
A list of terraform file s3 URLs you need to import. |
Lists the alarm recommendations for an Resilience Hub application
Description
Lists the alarm recommendations for an Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_alarm_recommendations/ for full documentation.
Usage
resiliencehub_list_alarm_recommendations(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
List of compliance drifts that were detected while running an assessment
Description
List of compliance drifts that were detected while running an assessment.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_assessment_compliance_drifts/ for full documentation.
Usage
resiliencehub_list_app_assessment_compliance_drifts(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of compliance drifts requested. |
nextToken |
Null, or the token from a previous call to get the next set of results. |
List of resource drifts that were detected while running an assessment
Description
List of resource drifts that were detected while running an assessment.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_assessment_resource_drifts/ for full documentation.
Usage
resiliencehub_list_app_assessment_resource_drifts(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of drift results to include in the response. If more
results exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists the assessments for an Resilience Hub application
Description
Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_assessments/ for full documentation.
Usage
resiliencehub_list_app_assessments(
appArn = NULL,
assessmentName = NULL,
assessmentStatus = NULL,
complianceStatus = NULL,
invoker = NULL,
maxResults = NULL,
nextToken = NULL,
reverseOrder = NULL
)
Arguments
appArn |
Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
assessmentName |
The name for the assessment. |
assessmentStatus |
The current status of the assessment for the resiliency policy. |
complianceStatus |
The current status of compliance for the resiliency policy. |
invoker |
Specifies the entity that invoked a specific assessment, either a |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
reverseOrder |
The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to |
Lists the compliances for an Resilience Hub Application Component
Description
Lists the compliances for an Resilience Hub Application Component.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_component_compliances/ for full documentation.
Usage
resiliencehub_list_app_component_compliances(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists the recommendations for an Resilience Hub Application Component
Description
Lists the recommendations for an Resilience Hub Application Component.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_component_recommendations/ for full documentation.
Usage
resiliencehub_list_app_component_recommendations(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists all the input sources of the Resilience Hub application
Description
Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_input_sources/ for full documentation.
Usage
resiliencehub_list_app_input_sources(
appArn,
appVersion,
maxResults = NULL,
nextToken = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] Resilience Hub application version. |
maxResults |
Maximum number of input sources to be displayed per Resilience Hub application. |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists all the Application Components in the Resilience Hub application
Description
Lists all the Application Components in the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_version_app_components/ for full documentation.
Usage
resiliencehub_list_app_version_app_components(
appArn,
appVersion,
maxResults = NULL,
nextToken = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] Version of the Application Component. |
maxResults |
Maximum number of Application Components to be displayed per Resilience Hub application version. |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists how the resources in an application version are mapped/sourced from
Description
Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_version_resource_mappings/ for full documentation.
Usage
resiliencehub_list_app_version_resource_mappings(
appArn,
appVersion,
maxResults = NULL,
nextToken = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists all the resources in an Resilience Hub application
Description
Lists all the resources in an Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_version_resources/ for full documentation.
Usage
resiliencehub_list_app_version_resources(
appArn,
appVersion,
maxResults = NULL,
nextToken = NULL,
resolutionId = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
resolutionId |
The identifier for a specific resolution. |
Lists the different versions for the Resilience Hub applications
Description
Lists the different versions for the Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_app_versions/ for full documentation.
Usage
resiliencehub_list_app_versions(
appArn,
endTime = NULL,
maxResults = NULL,
nextToken = NULL,
startTime = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
endTime |
Upper limit of the time range to filter the application versions. |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
startTime |
Lower limit of the time range to filter the application versions. |
Lists your Resilience Hub applications
Description
Lists your Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_apps/ for full documentation.
Usage
resiliencehub_list_apps(
appArn = NULL,
awsApplicationArn = NULL,
fromLastAssessmentTime = NULL,
maxResults = NULL,
name = NULL,
nextToken = NULL,
reverseOrder = NULL,
toLastAssessmentTime = NULL
)
Arguments
appArn |
Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
awsApplicationArn |
Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide. |
fromLastAssessmentTime |
Lower limit of the range that is used to filter applications based on their last assessment times. |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
name |
The name for the one of the listed applications. |
nextToken |
Null, or the token from a previous call to get the next set of results. |
reverseOrder |
The application list is sorted based on the values of
|
toLastAssessmentTime |
Upper limit of the range that is used to filter the applications based on their last assessment times. |
Lists the metrics that can be exported
Description
Lists the metrics that can be exported.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_metrics/ for full documentation.
Usage
resiliencehub_list_metrics(
conditions = NULL,
dataSource = NULL,
fields = NULL,
maxResults = NULL,
nextToken = NULL,
sorts = NULL
)
Arguments
conditions |
Indicates the list of all the conditions that were applied on the metrics. |
dataSource |
Indicates the data source of the metrics. |
fields |
Indicates the list of fields in the data source. |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
sorts |
(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order. |
Lists the recommendation templates for the Resilience Hub applications
Description
Lists the recommendation templates for the Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_recommendation_templates/ for full documentation.
Usage
resiliencehub_list_recommendation_templates(
assessmentArn = NULL,
maxResults = NULL,
name = NULL,
nextToken = NULL,
recommendationTemplateArn = NULL,
reverseOrder = NULL,
status = NULL
)
Arguments
assessmentArn |
Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
name |
The name for one of the listed recommendation templates. |
nextToken |
Null, or the token from a previous call to get the next set of results. |
recommendationTemplateArn |
The Amazon Resource Name (ARN) for a recommendation template. |
reverseOrder |
The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to |
status |
Status of the action. |
Lists the resiliency policies for the Resilience Hub applications
Description
Lists the resiliency policies for the Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_resiliency_policies/ for full documentation.
Usage
resiliencehub_list_resiliency_policies(
maxResults = NULL,
nextToken = NULL,
policyName = NULL
)
Arguments
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
policyName |
Name of the resiliency policy. |
Lists the resource grouping recommendations suggested by Resilience Hub for your application
Description
Lists the resource grouping recommendations suggested by Resilience Hub for your application.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_resource_grouping_recommendations/ for full documentation.
Usage
resiliencehub_list_resource_grouping_recommendations(
appArn = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
appArn |
Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
maxResults |
Maximum number of grouping recommendations to be displayed per Resilience Hub application. |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications
Description
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_sop_recommendations/ for full documentation.
Usage
resiliencehub_list_sop_recommendations(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists the suggested resiliency policies for the Resilience Hub applications
Description
Lists the suggested resiliency policies for the Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_suggested_resiliency_policies/ for full documentation.
Usage
resiliencehub_list_suggested_resiliency_policies(
maxResults = NULL,
nextToken = NULL
)
Arguments
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists the tags for your resources in your Resilience Hub applications
Description
Lists the tags for your resources in your Resilience Hub applications.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_tags_for_resource/ for full documentation.
Usage
resiliencehub_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application. |
Lists the test recommendations for the Resilience Hub application
Description
Lists the test recommendations for the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_test_recommendations/ for full documentation.
Usage
resiliencehub_list_test_recommendations(
assessmentArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
assessmentArn |
[required] Amazon Resource Name (ARN) of the assessment. The format for this ARN
is:
arn: |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
Lists the resources that are not currently supported in Resilience Hub
Description
Lists the resources that are not currently supported in Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.
See https://www.paws-r-sdk.com/docs/resiliencehub_list_unsupported_app_version_resources/ for full documentation.
Usage
resiliencehub_list_unsupported_app_version_resources(
appArn,
appVersion,
maxResults = NULL,
nextToken = NULL,
resolutionId = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
maxResults |
Maximum number of results to include in the response. If more results
exist than the specified |
nextToken |
Null, or the token from a previous call to get the next set of results. |
resolutionId |
The identifier for a specific resolution. |
Publishes a new version of a specific Resilience Hub application
Description
Publishes a new version of a specific Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_publish_app_version/ for full documentation.
Usage
resiliencehub_publish_app_version(appArn, versionName = NULL)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
versionName |
Name of the application version. |
Adds or updates the app template for an Resilience Hub application draft version
Description
Adds or updates the app template for an Resilience Hub application draft version.
See https://www.paws-r-sdk.com/docs/resiliencehub_put_draft_app_version_template/ for full documentation.
Usage
resiliencehub_put_draft_app_version_template(appArn, appTemplateBody)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appTemplateBody |
[required] A JSON string that provides information about your application
structure. To learn more about the The
|
Rejects resource grouping recommendations
Description
Rejects resource grouping recommendations.
See https://www.paws-r-sdk.com/docs/resiliencehub_reject_resource_grouping_recommendations/ for full documentation.
Usage
resiliencehub_reject_resource_grouping_recommendations(appArn, entries)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
entries |
[required] List of resource grouping recommendations you have selected to exclude from your application. |
Removes resource mappings from a draft application version
Description
Removes resource mappings from a draft application version.
See https://www.paws-r-sdk.com/docs/resiliencehub_remove_draft_app_version_resource_mappings/ for full documentation.
Usage
resiliencehub_remove_draft_app_version_resource_mappings(
appArn,
appRegistryAppNames = NULL,
eksSourceNames = NULL,
logicalStackNames = NULL,
resourceGroupNames = NULL,
resourceNames = NULL,
terraformSourceNames = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appRegistryAppNames |
The names of the registered applications you want to remove from the resource mappings. |
eksSourceNames |
The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings. This parameter accepts values in "eks-cluster/namespace" format. |
logicalStackNames |
The names of the CloudFormation stacks you want to remove from the resource mappings. |
resourceGroupNames |
The names of the resource groups you want to remove from the resource mappings. |
resourceNames |
The names of the resources you want to remove from the resource mappings. |
terraformSourceNames |
The names of the Terraform sources you want to remove from the resource mappings. |
Resolves the resources for an application version
Description
Resolves the resources for an application version.
See https://www.paws-r-sdk.com/docs/resiliencehub_resolve_app_version_resources/ for full documentation.
Usage
resiliencehub_resolve_app_version_resources(appArn, appVersion)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
Creates a new application assessment for an application
Description
Creates a new application assessment for an application.
See https://www.paws-r-sdk.com/docs/resiliencehub_start_app_assessment/ for full documentation.
Usage
resiliencehub_start_app_assessment(
appArn,
appVersion,
assessmentName,
clientToken = NULL,
tags = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appVersion |
[required] The version of the application. |
assessmentName |
[required] The name for the assessment. |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
tags |
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair. |
Initiates the export task of metrics
Description
Initiates the export task of metrics.
See https://www.paws-r-sdk.com/docs/resiliencehub_start_metrics_export/ for full documentation.
Usage
resiliencehub_start_metrics_export(bucketName = NULL, clientToken = NULL)
Arguments
bucketName |
(Optional) Specifies the name of the Amazon Simple Storage Service bucket where the exported metrics will be stored. |
clientToken |
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests. |
Starts grouping recommendation task
Description
Starts grouping recommendation task.
See https://www.paws-r-sdk.com/docs/resiliencehub_start_resource_grouping_recommendation_task/ for full documentation.
Usage
resiliencehub_start_resource_grouping_recommendation_task(appArn)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
Applies one or more tags to a resource
Description
Applies one or more tags to a resource.
See https://www.paws-r-sdk.com/docs/resiliencehub_tag_resource/ for full documentation.
Usage
resiliencehub_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] Amazon Resource Name (ARN) of the resource. |
tags |
[required] The tags to assign to the resource. Each tag consists of a key/value pair. |
Removes one or more tags from a resource
Description
Removes one or more tags from a resource.
See https://www.paws-r-sdk.com/docs/resiliencehub_untag_resource/ for full documentation.
Usage
resiliencehub_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] Amazon Resource Name (ARN) of the resource. |
tagKeys |
[required] The keys of the tags you want to remove. |
Updates an application
Description
Updates an application.
See https://www.paws-r-sdk.com/docs/resiliencehub_update_app/ for full documentation.
Usage
resiliencehub_update_app(
appArn,
assessmentSchedule = NULL,
clearResiliencyPolicyArn = NULL,
description = NULL,
eventSubscriptions = NULL,
permissionModel = NULL,
policyArn = NULL
)
Arguments
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
assessmentSchedule |
Assessment execution schedule with 'Daily' or 'Disabled' values. |
clearResiliencyPolicyArn |
Specifies if the resiliency policy ARN should be cleared. |
description |
The optional description for an app. |
eventSubscriptions |
The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events. |
permissionModel |
Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment. |
policyArn |
Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is:
arn: |
Updates the Resilience Hub application version
Description
Updates the Resilience Hub application version.
See https://www.paws-r-sdk.com/docs/resiliencehub_update_app_version/ for full documentation.
Usage
resiliencehub_update_app_version(additionalInfo = NULL, appArn)
Arguments
additionalInfo |
Additional configuration parameters for an Resilience Hub application.
If you want to implement Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key: Value: |
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
Updates an existing Application Component in the Resilience Hub application
Description
Updates an existing Application Component in the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_update_app_version_app_component/ for full documentation.
Usage
resiliencehub_update_app_version_app_component(
additionalInfo = NULL,
appArn,
id,
name = NULL,
type = NULL
)
Arguments
additionalInfo |
Currently, there is no supported additional information for Application Components. |
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
id |
[required] Identifier of the Application Component. |
name |
Name of the Application Component. |
type |
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. |
Updates the resource details in the Resilience Hub application
Description
Updates the resource details in the Resilience Hub application.
See https://www.paws-r-sdk.com/docs/resiliencehub_update_app_version_resource/ for full documentation.
Usage
resiliencehub_update_app_version_resource(
additionalInfo = NULL,
appArn,
appComponents = NULL,
awsAccountId = NULL,
awsRegion = NULL,
excluded = NULL,
logicalResourceId = NULL,
physicalResourceId = NULL,
resourceName = NULL,
resourceType = NULL
)
Arguments
additionalInfo |
Currently, there is no supported additional information for resources. |
appArn |
[required] Amazon Resource Name (ARN) of the Resilience Hub application. The format
for this ARN is:
arn: |
appComponents |
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added. |
awsAccountId |
Amazon Web Services account that owns the physical resource. |
awsRegion |
Amazon Web Services region that owns the physical resource. |
excluded |
Indicates if a resource is excluded from an Resilience Hub application. You can exclude only imported resources from an Resilience Hub application. |
logicalResourceId |
Logical identifier of the resource. |
physicalResourceId |
Physical identifier of the resource. |
resourceName |
Name of the resource. |
resourceType |
Type of resource. |
Updates a resiliency policy
Description
Updates a resiliency policy.
See https://www.paws-r-sdk.com/docs/resiliencehub_update_resiliency_policy/ for full documentation.
Usage
resiliencehub_update_resiliency_policy(
dataLocationConstraint = NULL,
policy = NULL,
policyArn,
policyDescription = NULL,
policyName = NULL,
tier = NULL
)
Arguments
dataLocationConstraint |
Specifies a high-level geographical location constraint for where your resilience policy data can be stored. |
policy |
Resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds. |
policyArn |
[required] Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is:
arn: |
policyDescription |
Description of the resiliency policy. |
policyName |
Name of the resiliency policy. |
tier |
The tier for this resiliency policy, ranging from the highest severity
( |
AWS Resource Groups
Description
Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the Resource Groups User Guide.
Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search results
Getting data about resources that are members of a group
Searching Amazon Web Services resources based on a resource query
Usage
resourcegroups(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- resourcegroups(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| cancel_tag_sync_task | Cancels the specified tag-sync task |
| create_group | Creates a resource group with the specified name and description |
| delete_group | Deletes the specified resource group |
| get_account_settings | Retrieves the current status of optional features in Resource Groups |
| get_group | Returns information about a specified resource group |
| get_group_configuration | Retrieves the service configuration associated with the specified resource group |
| get_group_query | Retrieves the resource query associated with the specified resource group |
| get_tags | Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN) |
| get_tag_sync_task | Returns information about a specified tag-sync task |
| group_resources | Adds the specified resources to the specified group |
| list_grouping_statuses | Returns the status of the last grouping or ungrouping action for each resource in the specified application group |
| list_group_resources | Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group |
| list_groups | Returns a list of existing Resource Groups in your account |
| list_tag_sync_tasks | Returns a list of tag-sync tasks |
| put_group_configuration | Attaches a service configuration to the specified group |
| search_resources | Returns a list of Amazon Web Services resource identifiers that matches the specified query |
| start_tag_sync_task | Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application |
| tag | Adds tags to a resource group with the specified Amazon resource name (ARN) |
| ungroup_resources | Removes the specified resources from the specified group |
| untag | Deletes tags from a specified resource group |
| update_account_settings | Turns on or turns off optional features in Resource Groups |
| update_group | Updates the description for an existing group |
| update_group_query | Updates the resource query of a group |
Examples
## Not run:
svc <- resourcegroups()
svc$cancel_tag_sync_task(
Foo = 123
)
## End(Not run)
Cancels the specified tag-sync task
Description
Cancels the specified tag-sync task.
See https://www.paws-r-sdk.com/docs/resourcegroups_cancel_tag_sync_task/ for full documentation.
Usage
resourcegroups_cancel_tag_sync_task(TaskArn)
Arguments
TaskArn |
[required] The Amazon resource name (ARN) of the tag-sync task. |
Creates a resource group with the specified name and description
Description
Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.
See https://www.paws-r-sdk.com/docs/resourcegroups_create_group/ for full documentation.
Usage
resourcegroups_create_group(
Name,
Description = NULL,
ResourceQuery = NULL,
Tags = NULL,
Configuration = NULL,
Criticality = NULL,
Owner = NULL,
DisplayName = NULL
)
Arguments
Name |
[required] The name of the group, which is the identifier of the group in other
operations. You can't change the name of a resource group after you
create it. A resource group name can consist of letters, numbers,
hyphens, periods, and underscores. The name cannot start with |
Description |
The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces. |
ResourceQuery |
The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups. A resource group can contain either a |
Tags |
The tags to add to the group. A tag is key-value pair string. |
Configuration |
A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups. A resource group can contain either a |
Criticality |
The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical. |
Owner |
A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization. |
DisplayName |
The name of the application group, which you can change at any time. |
Deletes the specified resource group
Description
Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.
See https://www.paws-r-sdk.com/docs/resourcegroups_delete_group/ for full documentation.
Usage
resourcegroups_delete_group(GroupName = NULL, Group = NULL)
Arguments
GroupName |
Deprecated - don't use this parameter. Use |
Group |
The name or the Amazon resource name (ARN) of the resource group to delete. |
Retrieves the current status of optional features in Resource Groups
Description
Retrieves the current status of optional features in Resource Groups.
See https://www.paws-r-sdk.com/docs/resourcegroups_get_account_settings/ for full documentation.
Usage
resourcegroups_get_account_settings()
Returns information about a specified resource group
Description
Returns information about a specified resource group.
See https://www.paws-r-sdk.com/docs/resourcegroups_get_group/ for full documentation.
Usage
resourcegroups_get_group(GroupName = NULL, Group = NULL)
Arguments
GroupName |
Deprecated - don't use this parameter. Use |
Group |
The name or the Amazon resource name (ARN) of the resource group to retrieve. |
Retrieves the service configuration associated with the specified resource group
Description
Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.
See https://www.paws-r-sdk.com/docs/resourcegroups_get_group_configuration/ for full documentation.
Usage
resourcegroups_get_group_configuration(Group = NULL)
Arguments
Group |
The name or the Amazon resource name (ARN) of the resource group for which you want to retrive the service configuration. |
Retrieves the resource query associated with the specified resource group
Description
Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.
See https://www.paws-r-sdk.com/docs/resourcegroups_get_group_query/ for full documentation.
Usage
resourcegroups_get_group_query(GroupName = NULL, Group = NULL)
Arguments
GroupName |
Don't use this parameter. Use |
Group |
The name or the Amazon resource name (ARN) of the resource group to query. |
Returns information about a specified tag-sync task
Description
Returns information about a specified tag-sync task.
See https://www.paws-r-sdk.com/docs/resourcegroups_get_tag_sync_task/ for full documentation.
Usage
resourcegroups_get_tag_sync_task(TaskArn)
Arguments
TaskArn |
[required] The Amazon resource name (ARN) of the tag-sync task. |
Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN)
Description
Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).
See https://www.paws-r-sdk.com/docs/resourcegroups_get_tags/ for full documentation.
Usage
resourcegroups_get_tags(Arn)
Arguments
Arn |
[required] The Amazon resource name (ARN) of the resource group whose tags you want to retrieve. |
Adds the specified resources to the specified group
Description
Adds the specified resources to the specified group.
See https://www.paws-r-sdk.com/docs/resourcegroups_group_resources/ for full documentation.
Usage
resourcegroups_group_resources(Group, ResourceArns)
Arguments
Group |
[required] The name or the Amazon resource name (ARN) of the resource group to add resources to. |
ResourceArns |
[required] The list of Amazon resource names (ARNs) of the resources to be added to the group. |
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group
Description
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group.
See https://www.paws-r-sdk.com/docs/resourcegroups_list_group_resources/ for full documentation.
Usage
resourcegroups_list_group_resources(
GroupName = NULL,
Group = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GroupName |
Deprecated - don't use this parameter. Use the Group request field instead. |
Group |
The name or the Amazon resource name (ARN) of the resource group. |
Filters |
Filters, formatted as ResourceFilter objects, that you want to apply to
a
When you specify a
The error includes a list of resource types that failed the validation
because they are not part of the query associated with the group. This
validation doesn't occur when the group query specifies
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
NextToken |
The parameter for receiving additional results if you receive a
|
Returns the status of the last grouping or ungrouping action for each resource in the specified application group
Description
Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
See https://www.paws-r-sdk.com/docs/resourcegroups_list_grouping_statuses/ for full documentation.
Usage
resourcegroups_list_grouping_statuses(
Group,
MaxResults = NULL,
Filters = NULL,
NextToken = NULL
)
Arguments
Group |
[required] The application group identifier, expressed as an Amazon resource name (ARN) or the application group name. |
MaxResults |
The maximum number of resources and their statuses returned in the response. |
Filters |
The filter name and value pair that is used to return more specific results from a list of resources. |
NextToken |
The parameter for receiving additional results if you receive a
|
Returns a list of existing Resource Groups in your account
Description
Returns a list of existing Resource Groups in your account.
See https://www.paws-r-sdk.com/docs/resourcegroups_list_groups/ for full documentation.
Usage
resourcegroups_list_groups(Filters = NULL, MaxResults = NULL, NextToken = NULL)
Arguments
Filters |
Filters, formatted as GroupFilter objects, that you want to apply to a
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
NextToken |
The parameter for receiving additional results if you receive a
|
Returns a list of tag-sync tasks
Description
Returns a list of tag-sync tasks.
See https://www.paws-r-sdk.com/docs/resourcegroups_list_tag_sync_tasks/ for full documentation.
Usage
resourcegroups_list_tag_sync_tasks(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
The Amazon resource name (ARN) or name of the application group for which you want to return a list of tag-sync tasks. |
MaxResults |
The maximum number of results to be included in the response. |
NextToken |
The parameter for receiving additional results if you receive a
|
Attaches a service configuration to the specified group
Description
Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use get_group_configuration to check the status of the update.
See https://www.paws-r-sdk.com/docs/resourcegroups_put_group_configuration/ for full documentation.
Usage
resourcegroups_put_group_configuration(Group = NULL, Configuration = NULL)
Arguments
Group |
The name or Amazon resource name (ARN) of the resource group with the configuration that you want to update. |
Configuration |
The new configuration to associate with the specified group. A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For information about the syntax of a service configuration, see Service configurations for Resource Groups. A resource group can contain either a |
Returns a list of Amazon Web Services resource identifiers that matches the specified query
Description
Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a create_group or update_group_query operation.
See https://www.paws-r-sdk.com/docs/resourcegroups_search_resources/ for full documentation.
Usage
resourcegroups_search_resources(
ResourceQuery,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ResourceQuery |
[required] The search query, using the same formats that are supported for resource
group definition. For more information, see
|
MaxResults |
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the |
NextToken |
The parameter for receiving additional results if you receive a
|
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application
Description
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.
See https://www.paws-r-sdk.com/docs/resourcegroups_start_tag_sync_task/ for full documentation.
Usage
resourcegroups_start_tag_sync_task(Group, TagKey, TagValue, RoleArn)
Arguments
Group |
[required] The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task. |
TagKey |
[required] The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application. |
TagValue |
[required] The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application. |
RoleArn |
[required] The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf. |
Adds tags to a resource group with the specified Amazon resource name (ARN)
Description
Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters.
See https://www.paws-r-sdk.com/docs/resourcegroups_tag/ for full documentation.
Usage
resourcegroups_tag(Arn, Tags)
Arguments
Arn |
[required] The Amazon resource name (ARN) of the resource group to which to add tags. |
Tags |
[required] The tags to add to the specified resource group. A tag is a string-to-string map of key-value pairs. |
Removes the specified resources from the specified group
Description
Removes the specified resources from the specified group. This operation works only with static groups that you populated using the group_resources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.
See https://www.paws-r-sdk.com/docs/resourcegroups_ungroup_resources/ for full documentation.
Usage
resourcegroups_ungroup_resources(Group, ResourceArns)
Arguments
Group |
[required] The name or the Amazon resource name (ARN) of the resource group from which to remove the resources. |
ResourceArns |
[required] The Amazon resource names (ARNs) of the resources to be removed from the group. |
Deletes tags from a specified resource group
Description
Deletes tags from a specified resource group.
See https://www.paws-r-sdk.com/docs/resourcegroups_untag/ for full documentation.
Usage
resourcegroups_untag(Arn, Keys)
Arguments
Arn |
[required] The Amazon resource name (ARN) of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys. |
Keys |
[required] The keys of the tags to be removed. |
Turns on or turns off optional features in Resource Groups
Description
Turns on or turns off optional features in Resource Groups.
See https://www.paws-r-sdk.com/docs/resourcegroups_update_account_settings/ for full documentation.
Usage
resourcegroups_update_account_settings(
GroupLifecycleEventsDesiredStatus = NULL
)
Arguments
GroupLifecycleEventsDesiredStatus |
Specifies whether you want to turn group lifecycle events on or off. You can't turn on group lifecycle events if your resource groups quota is greater than 2,000. |
Updates the description for an existing group
Description
Updates the description for an existing group. You cannot update the name of a resource group.
See https://www.paws-r-sdk.com/docs/resourcegroups_update_group/ for full documentation.
Usage
resourcegroups_update_group(
GroupName = NULL,
Group = NULL,
Description = NULL,
Criticality = NULL,
Owner = NULL,
DisplayName = NULL
)
Arguments
GroupName |
Don't use this parameter. Use |
Group |
The name or the ARN of the resource group to update. |
Description |
The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces. |
Criticality |
The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical. |
Owner |
A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization. |
DisplayName |
The name of the application group, which you can change at any time. |
Updates the resource query of a group
Description
Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.
See https://www.paws-r-sdk.com/docs/resourcegroups_update_group_query/ for full documentation.
Usage
resourcegroups_update_group_query(
GroupName = NULL,
Group = NULL,
ResourceQuery
)
Arguments
GroupName |
Don't use this parameter. Use |
Group |
The name or the Amazon resource name (ARN) of the resource group to query. |
ResourceQuery |
[required] The resource query to determine which Amazon Web Services resources are members of this resource group. A resource group can contain either a |
AWS Resource Groups Tagging API
Description
Resource Groups Tagging API
Usage
resourcegroupstaggingapi(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- resourcegroupstaggingapi(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| describe_report_creation | Describes the status of the StartReportCreation operation |
| get_compliance_summary | Returns a table that shows counts of resources that are noncompliant with their tag policies |
| get_resources | Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account |
| get_tag_keys | Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account |
| get_tag_values | Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account |
| start_report_creation | Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy |
| tag_resources | Applies one or more tags to the specified resources |
| untag_resources | Removes the specified tags from the specified resources |
Examples
## Not run:
svc <- resourcegroupstaggingapi()
svc$describe_report_creation(
Foo = 123
)
## End(Not run)
Describes the status of the StartReportCreation operation
Description
Describes the status of the start_report_creation operation.
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_describe_report_creation/ for full documentation.
Usage
resourcegroupstaggingapi_describe_report_creation()
Returns a table that shows counts of resources that are noncompliant with their tag policies
Description
Returns a table that shows counts of resources that are noncompliant with their tag policies.
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_get_compliance_summary/ for full documentation.
Usage
resourcegroupstaggingapi_get_compliance_summary(
TargetIdFilters = NULL,
RegionFilters = NULL,
ResourceTypeFilters = NULL,
TagKeyFilters = NULL,
GroupBy = NULL,
MaxResults = NULL,
PaginationToken = NULL
)
Arguments
TargetIdFilters |
Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs. |
RegionFilters |
Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions. |
ResourceTypeFilters |
Specifies that you want the response to include information for only
resources of the specified types. The format of each resource type is
The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:
You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. |
TagKeyFilters |
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys. |
GroupBy |
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes. |
MaxResults |
Specifies the maximum number of results to be returned in each page. A
query can return fewer than this maximum, even if there are more results
still to return. You should always check the |
PaginationToken |
Specifies a |
Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account
Description
Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_get_resources/ for full documentation.
Usage
resourcegroupstaggingapi_get_resources(
PaginationToken = NULL,
TagFilters = NULL,
ResourcesPerPage = NULL,
TagsPerPage = NULL,
ResourceTypeFilters = NULL,
IncludeComplianceDetails = NULL,
ExcludeCompliantResources = NULL,
ResourceARNList = NULL
)
Arguments
PaginationToken |
Specifies a |
TagFilters |
Specifies a list of TagFilters (keys and values) to restrict the output
to only those resources that have tags with the specified keys and, if
included, the specified values. Each Note the following when deciding how to use TagFilters:
|
ResourcesPerPage |
Specifies the maximum number of results to be returned in each page. A
query can return fewer than this maximum, even if there are more results
still to return. You should always check the |
TagsPerPage |
Amazon Web Services recommends using A limit that restricts the number of tags (key and value pairs) returned
by
You can set |
ResourceTypeFilters |
Specifies the resource types that you want included in the response. The
format of each resource type is The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API. You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
|
IncludeComplianceDetails |
Specifies whether to include details regarding the compliance with the
effective tag policy. Set this to |
ExcludeCompliantResources |
Specifies whether to exclude resources that are compliant with the tag
policy. Set this to You can use this parameter only if the |
ResourceARNList |
Specifies a list of ARNs of resources for which you want to retrieve tag
data. You can't specify both this parameter and any of the pagination
parameters ( If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response. An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. |
Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account
Description
Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account.
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_get_tag_keys/ for full documentation.
Usage
resourcegroupstaggingapi_get_tag_keys(PaginationToken = NULL)
Arguments
PaginationToken |
Specifies a |
Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account
Description
Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_get_tag_values/ for full documentation.
Usage
resourcegroupstaggingapi_get_tag_values(PaginationToken = NULL, Key)
Arguments
PaginationToken |
Specifies a |
Key |
[required] Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account. |
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy
Description
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_start_report_creation/ for full documentation.
Usage
resourcegroupstaggingapi_start_report_creation(S3Bucket)
Arguments
S3Bucket |
[required] The name of the Amazon S3 bucket where the report will be stored; for example:
For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page. |
Applies one or more tags to the specified resources
Description
Applies one or more tags to the specified resources. Note the following:
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_tag_resources/ for full documentation.
Usage
resourcegroupstaggingapi_tag_resources(ResourceARNList, Tags)
Arguments
ResourceARNList |
[required] Specifies the list of ARNs of the resources that you want to apply tags to. An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. |
Tags |
[required] Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define. |
Removes the specified tags from the specified resources
Description
Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:
See https://www.paws-r-sdk.com/docs/resourcegroupstaggingapi_untag_resources/ for full documentation.
Usage
resourcegroupstaggingapi_untag_resources(ResourceARNList, TagKeys)
Arguments
ResourceARNList |
[required] Specifies a list of ARNs of the resources that you want to remove tags from. An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. |
TagKeys |
[required] Specifies a list of tag keys that you want to remove from the specified resources. |
AWS Service Catalog
Description
Service Catalog
Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.
Usage
servicecatalog(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- servicecatalog(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| accept_portfolio_share | Accepts an offer to share the specified portfolio |
| associate_budget_with_resource | Associates the specified budget with the specified resource |
| associate_principal_with_portfolio | Associates the specified principal ARN with the specified portfolio |
| associate_product_with_portfolio | Associates the specified product with the specified portfolio |
| associate_service_action_with_provisioning_artifact | Associates a self-service action with a provisioning artifact |
| associate_tag_option_with_resource | Associate the specified TagOption with the specified portfolio or product |
| batch_associate_service_action_with_provisioning_artifact | Associates multiple self-service actions with provisioning artifacts |
| batch_disassociate_service_action_from_provisioning_artifact | Disassociates a batch of self-service actions from the specified provisioning artifact |
| copy_product | Copies the specified source product to the specified target product or a new product |
| create_constraint | Creates a constraint |
| create_portfolio | Creates a portfolio |
| create_portfolio_share | Shares the specified portfolio with the specified account or organization node |
| create_product | Creates a product |
| create_provisioned_product_plan | Creates a plan |
| create_provisioning_artifact | Creates a provisioning artifact (also known as a version) for the specified product |
| create_service_action | Creates a self-service action |
| create_tag_option | Creates a TagOption |
| delete_constraint | Deletes the specified constraint |
| delete_portfolio | Deletes the specified portfolio |
| delete_portfolio_share | Stops sharing the specified portfolio with the specified account or organization node |
| delete_product | Deletes the specified product |
| delete_provisioned_product_plan | Deletes the specified plan |
| delete_provisioning_artifact | Deletes the specified provisioning artifact (also known as a version) for the specified product |
| delete_service_action | Deletes a self-service action |
| delete_tag_option | Deletes the specified TagOption |
| describe_constraint | Gets information about the specified constraint |
| describe_copy_product_status | Gets the status of the specified copy product operation |
| describe_portfolio | Gets information about the specified portfolio |
| describe_portfolio_shares | Returns a summary of each of the portfolio shares that were created for the specified portfolio |
| describe_portfolio_share_status | Gets the status of the specified portfolio share operation |
| describe_product | Gets information about the specified product |
| describe_product_as_admin | Gets information about the specified product |
| describe_product_view | Gets information about the specified product |
| describe_provisioned_product | Gets information about the specified provisioned product |
| describe_provisioned_product_plan | Gets information about the resource changes for the specified plan |
| describe_provisioning_artifact | Gets information about the specified provisioning artifact (also known as a version) for the specified product |
| describe_provisioning_parameters | Gets information about the configuration required to provision the specified product using the specified provisioning artifact |
| describe_record | Gets information about the specified request operation |
| describe_service_action | Describes a self-service action |
| describe_service_action_execution_parameters | Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user |
| describe_tag_option | Gets information about the specified TagOption |
| disable_aws_organizations_access | Disable portfolio sharing through the Organizations service |
| disassociate_budget_from_resource | Disassociates the specified budget from the specified resource |
| disassociate_principal_from_portfolio | Disassociates a previously associated principal ARN from a specified portfolio |
| disassociate_product_from_portfolio | Disassociates the specified product from the specified portfolio |
| disassociate_service_action_from_provisioning_artifact | Disassociates the specified self-service action association from the specified provisioning artifact |
| disassociate_tag_option_from_resource | Disassociates the specified TagOption from the specified resource |
| enable_aws_organizations_access | Enable portfolio sharing feature through Organizations |
| execute_provisioned_product_plan | Provisions or modifies a product based on the resource changes for the specified plan |
| execute_provisioned_product_service_action | Executes a self-service action against a provisioned product |
| get_aws_organizations_access_status | Get the Access Status for Organizations portfolio share feature |
| get_provisioned_product_outputs | This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs |
| import_as_provisioned_product | Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact |
| list_accepted_portfolio_shares | Lists all imported portfolios for which account-to-account shares were accepted by this account |
| list_budgets_for_resource | Lists all the budgets associated to the specified resource |
| list_constraints_for_portfolio | Lists the constraints for the specified portfolio and product |
| list_launch_paths | Lists the paths to the specified product |
| list_organization_portfolio_access | Lists the organization nodes that have access to the specified portfolio |
| list_portfolio_access | Lists the account IDs that have access to the specified portfolio |
| list_portfolios | Lists all portfolios in the catalog |
| list_portfolios_for_product | Lists all portfolios that the specified product is associated with |
| list_principals_for_portfolio | Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio |
| list_provisioned_product_plans | Lists the plans for the specified provisioned product or all plans to which the user has access |
| list_provisioning_artifacts | Lists all provisioning artifacts (also known as versions) for the specified product |
| list_provisioning_artifacts_for_service_action | Lists all provisioning artifacts (also known as versions) for the specified self-service action |
| list_record_history | Lists the specified requests or all performed requests |
| list_resources_for_tag_option | Lists the resources associated with the specified TagOption |
| list_service_actions | Lists all self-service actions |
| list_service_actions_for_provisioning_artifact | Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID |
| list_stack_instances_for_provisioned_product | Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product |
| list_tag_options | Lists the specified TagOptions or all TagOptions |
| notify_provision_product_engine_workflow_result | Notifies the result of the provisioning engine execution |
| notify_terminate_provisioned_product_engine_workflow_result | Notifies the result of the terminate engine execution |
| notify_update_provisioned_product_engine_workflow_result | Notifies the result of the update engine execution |
| provision_product | Provisions the specified product |
| reject_portfolio_share | Rejects an offer to share the specified portfolio |
| scan_provisioned_products | Lists the provisioned products that are available (not terminated) |
| search_products | Gets information about the products to which the caller has access |
| search_products_as_admin | Gets information about the products for the specified portfolio or all products |
| search_provisioned_products | Gets information about the provisioned products that meet the specified criteria |
| terminate_provisioned_product | Terminates the specified provisioned product |
| update_constraint | Updates the specified constraint |
| update_portfolio | Updates the specified portfolio |
| update_portfolio_share | Updates the specified portfolio share |
| update_product | Updates the specified product |
| update_provisioned_product | Requests updates to the configuration of the specified provisioned product |
| update_provisioned_product_properties | Requests updates to the properties of the specified provisioned product |
| update_provisioning_artifact | Updates the specified provisioning artifact (also known as a version) for the specified product |
| update_service_action | Updates a self-service action |
| update_tag_option | Updates the specified TagOption |
Examples
## Not run:
svc <- servicecatalog()
svc$accept_portfolio_share(
Foo = 123
)
## End(Not run)
Accepts an offer to share the specified portfolio
Description
Accepts an offer to share the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_accept_portfolio_share/ for full documentation.
Usage
servicecatalog_accept_portfolio_share(
AcceptLanguage = NULL,
PortfolioId,
PortfolioShareType = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
PortfolioShareType |
The type of shared portfolios to accept. The default is to accept imported portfolios.
For example,
|
Associates the specified budget with the specified resource
Description
Associates the specified budget with the specified resource.
See https://www.paws-r-sdk.com/docs/servicecatalog_associate_budget_with_resource/ for full documentation.
Usage
servicecatalog_associate_budget_with_resource(BudgetName, ResourceId)
Arguments
BudgetName |
[required] The name of the budget you want to associate. |
ResourceId |
[required] The resource identifier. Either a portfolio-id or a product-id. |
Associates the specified principal ARN with the specified portfolio
Description
Associates the specified principal ARN with the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_associate_principal_with_portfolio/ for full documentation.
Usage
servicecatalog_associate_principal_with_portfolio(
AcceptLanguage = NULL,
PortfolioId,
PrincipalARN,
PrincipalType
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
PrincipalARN |
[required] The ARN of the principal (user, role, or group). If the arn:partition:iam:::resource-type/resource-id The ARN resource-id can be either:
Examples of an acceptable wildcard ARN:
Examples of an unacceptable wildcard ARN:
You can associate multiple The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "" wildcard character matches any number of any characters. This is similar to "." in regular regex context. In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "*" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id. The "*" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1. |
PrincipalType |
[required] The principal type. The supported value is |
Associates the specified product with the specified portfolio
Description
Associates the specified product with the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_associate_product_with_portfolio/ for full documentation.
Usage
servicecatalog_associate_product_with_portfolio(
AcceptLanguage = NULL,
ProductId,
PortfolioId,
SourcePortfolioId = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
PortfolioId |
[required] The portfolio identifier. |
SourcePortfolioId |
The identifier of the source portfolio. |
Associates a self-service action with a provisioning artifact
Description
Associates a self-service action with a provisioning artifact.
See https://www.paws-r-sdk.com/docs/servicecatalog_associate_service_action_with_provisioning_artifact/ for full documentation.
Usage
servicecatalog_associate_service_action_with_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
ServiceActionId,
AcceptLanguage = NULL,
IdempotencyToken = NULL
)
Arguments
ProductId |
[required] The product identifier. For example, |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. For example,
|
ServiceActionId |
[required] The self-service action identifier. For example, |
AcceptLanguage |
The language code.
|
IdempotencyToken |
A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request. |
Associate the specified TagOption with the specified portfolio or product
Description
Associate the specified TagOption with the specified portfolio or product.
See https://www.paws-r-sdk.com/docs/servicecatalog_associate_tag_option_with_resource/ for full documentation.
Usage
servicecatalog_associate_tag_option_with_resource(ResourceId, TagOptionId)
Arguments
ResourceId |
[required] The resource identifier. |
TagOptionId |
[required] The TagOption identifier. |
Associates multiple self-service actions with provisioning artifacts
Description
Associates multiple self-service actions with provisioning artifacts.
See https://www.paws-r-sdk.com/docs/servicecatalog_batch_associate_service_action_with_provisioning_artifact/ for full documentation.
Usage
servicecatalog_batch_associate_service_action_with_provisioning_artifact(
ServiceActionAssociations,
AcceptLanguage = NULL
)
Arguments
ServiceActionAssociations |
[required] One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID. |
AcceptLanguage |
The language code.
|
Disassociates a batch of self-service actions from the specified provisioning artifact
Description
Disassociates a batch of self-service actions from the specified provisioning artifact.
See https://www.paws-r-sdk.com/docs/servicecatalog_batch_disassociate_service_action_from_provisioning_artifact/ for full documentation.
Usage
servicecatalog_batch_disassociate_service_action_from_provisioning_artifact(
ServiceActionAssociations,
AcceptLanguage = NULL
)
Arguments
ServiceActionAssociations |
[required] One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID. |
AcceptLanguage |
The language code.
|
Copies the specified source product to the specified target product or a new product
Description
Copies the specified source product to the specified target product or a new product.
See https://www.paws-r-sdk.com/docs/servicecatalog_copy_product/ for full documentation.
Usage
servicecatalog_copy_product(
AcceptLanguage = NULL,
SourceProductArn,
TargetProductId = NULL,
TargetProductName = NULL,
SourceProvisioningArtifactIdentifiers = NULL,
CopyOptions = NULL,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
SourceProductArn |
[required] The Amazon Resource Name (ARN) of the source product. |
TargetProductId |
The identifier of the target product. By default, a new product is created. |
TargetProductName |
A name for the target product. The default is the name of the source product. |
SourceProvisioningArtifactIdentifiers |
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied. |
CopyOptions |
The copy options. If the value is |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Creates a constraint
Description
Creates a constraint.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_constraint/ for full documentation.
Usage
servicecatalog_create_constraint(
AcceptLanguage = NULL,
PortfolioId,
ProductId,
Parameters,
Type,
Description = NULL,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
ProductId |
[required] The product identifier. |
Parameters |
[required] The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH You are required to specify either the Specify the
Specify the
If you specify the The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint. You cannot have both a You also cannot have more than one NOTIFICATION Specify the
RESOURCE_UPDATE Specify the
The STACKSET Specify the
You cannot have both a You also cannot have more than one Products with a TEMPLATE Specify the |
Type |
[required] The type of constraint.
|
Description |
The description of the constraint. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Creates a portfolio
Description
Creates a portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_portfolio/ for full documentation.
Usage
servicecatalog_create_portfolio(
AcceptLanguage = NULL,
DisplayName,
Description = NULL,
ProviderName,
Tags = NULL,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
DisplayName |
[required] The name to use for display purposes. |
Description |
The description of the portfolio. |
ProviderName |
[required] The name of the portfolio provider. |
Tags |
One or more tags. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Shares the specified portfolio with the specified account or organization node
Description
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_portfolio_share/ for full documentation.
Usage
servicecatalog_create_portfolio_share(
AcceptLanguage = NULL,
PortfolioId,
AccountId = NULL,
OrganizationNode = NULL,
ShareTagOptions = NULL,
SharePrincipals = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
AccountId |
The Amazon Web Services account ID. For example, |
OrganizationNode |
The organization node to whom you are going to share. When you pass
|
ShareTagOptions |
Enables or disables |
SharePrincipals |
This parameter is only supported for portfolios with an
OrganizationalNode Type of Enables or disables When you enable Principal Name Sharing for a portfolio share, the share
recipient account end users with a principal that matches any of the
associated IAM patterns can provision products from the portfolio. Once
shared, the share recipient can view associations of |
Creates a product
Description
Creates a product.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_product/ for full documentation.
Usage
servicecatalog_create_product(
AcceptLanguage = NULL,
Name,
Owner,
Description = NULL,
Distributor = NULL,
SupportDescription = NULL,
SupportEmail = NULL,
SupportUrl = NULL,
ProductType,
Tags = NULL,
ProvisioningArtifactParameters = NULL,
IdempotencyToken,
SourceConnection = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Name |
[required] The name of the product. |
Owner |
[required] The owner of the product. |
Description |
The description of the product. |
Distributor |
The distributor of the product. |
SupportDescription |
The support information about the product. |
SupportEmail |
The contact email for product support. |
SupportUrl |
The contact URL for product support.
|
ProductType |
[required] The type of product. |
Tags |
One or more tags. |
ProvisioningArtifactParameters |
The configuration of the provisioning artifact. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
SourceConnection |
Specifies connection details for the created product and syncs the
product to the connection source artifact. This automatically manages
the product's artifacts based on changes to the source. The
|
Creates a plan
Description
Creates a plan.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_provisioned_product_plan/ for full documentation.
Usage
servicecatalog_create_provisioned_product_plan(
AcceptLanguage = NULL,
PlanName,
PlanType,
NotificationArns = NULL,
PathId = NULL,
ProductId,
ProvisionedProductName,
ProvisioningArtifactId,
ProvisioningParameters = NULL,
IdempotencyToken,
Tags = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PlanName |
[required] The name of the plan. |
PlanType |
[required] The plan type. |
NotificationArns |
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. |
PathId |
The path identifier of the product. This value is optional if the
product has a default path, and required if the product has more than
one path. To list the paths for a product, use
|
ProductId |
[required] The product identifier. |
ProvisionedProductName |
[required] A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned. |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. |
ProvisioningParameters |
Parameters specified by the administrator that are required for provisioning the product. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Tags |
One or more tags. If the plan is for an existing provisioned product, the product must
have a |
Creates a provisioning artifact (also known as a version) for the specified product
Description
Creates a provisioning artifact (also known as a version) for the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_provisioning_artifact/ for full documentation.
Usage
servicecatalog_create_provisioning_artifact(
AcceptLanguage = NULL,
ProductId,
Parameters,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
Parameters |
[required] The configuration for the provisioning artifact. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Creates a self-service action
Description
Creates a self-service action.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_service_action/ for full documentation.
Usage
servicecatalog_create_service_action(
Name,
DefinitionType,
Definition,
Description = NULL,
AcceptLanguage = NULL,
IdempotencyToken
)
Arguments
Name |
[required] The self-service action name. |
DefinitionType |
[required] The service action definition type. For example, |
Definition |
[required] The self-service action definition. Can be one of the following: Name The name of the Amazon Web Services Systems Manager document (SSM
document). For example, If you are using a shared SSM document, you must provide the ARN instead of the name. Version The Amazon Web Services Systems Manager automation document version. For
example, AssumeRole The Amazon Resource Name (ARN) of the role that performs the
self-service actions on your behalf. For example,
To reuse the provisioned product launch role, set to
Parameters The list of parameters in JSON format. For example: |
Description |
The self-service action description. |
AcceptLanguage |
The language code.
|
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Creates a TagOption
Description
Creates a TagOption.
See https://www.paws-r-sdk.com/docs/servicecatalog_create_tag_option/ for full documentation.
Usage
servicecatalog_create_tag_option(Key, Value)
Arguments
Key |
[required] The TagOption key. |
Value |
[required] The TagOption value. |
Deletes the specified constraint
Description
Deletes the specified constraint.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_constraint/ for full documentation.
Usage
servicecatalog_delete_constraint(AcceptLanguage = NULL, Id)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The identifier of the constraint. |
Deletes the specified portfolio
Description
Deletes the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_portfolio/ for full documentation.
Usage
servicecatalog_delete_portfolio(AcceptLanguage = NULL, Id)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The portfolio identifier. |
Stops sharing the specified portfolio with the specified account or organization node
Description
Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_portfolio_share/ for full documentation.
Usage
servicecatalog_delete_portfolio_share(
AcceptLanguage = NULL,
PortfolioId,
AccountId = NULL,
OrganizationNode = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
AccountId |
The Amazon Web Services account ID. |
OrganizationNode |
The organization node to whom you are going to stop sharing. |
Deletes the specified product
Description
Deletes the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_product/ for full documentation.
Usage
servicecatalog_delete_product(AcceptLanguage = NULL, Id)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The product identifier. |
Deletes the specified plan
Description
Deletes the specified plan.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_provisioned_product_plan/ for full documentation.
Usage
servicecatalog_delete_provisioned_product_plan(
AcceptLanguage = NULL,
PlanId,
IgnoreErrors = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PlanId |
[required] The plan identifier. |
IgnoreErrors |
If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. |
Deletes the specified provisioning artifact (also known as a version) for the specified product
Description
Deletes the specified provisioning artifact (also known as a version) for the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_provisioning_artifact/ for full documentation.
Usage
servicecatalog_delete_provisioning_artifact(
AcceptLanguage = NULL,
ProductId,
ProvisioningArtifactId
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. |
Deletes a self-service action
Description
Deletes a self-service action.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_service_action/ for full documentation.
Usage
servicecatalog_delete_service_action(
Id,
AcceptLanguage = NULL,
IdempotencyToken = NULL
)
Arguments
Id |
[required] The self-service action identifier. For example, |
AcceptLanguage |
The language code.
|
IdempotencyToken |
A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request. |
Deletes the specified TagOption
Description
Deletes the specified TagOption.
See https://www.paws-r-sdk.com/docs/servicecatalog_delete_tag_option/ for full documentation.
Usage
servicecatalog_delete_tag_option(Id)
Arguments
Id |
[required] The TagOption identifier. |
Gets information about the specified constraint
Description
Gets information about the specified constraint.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_constraint/ for full documentation.
Usage
servicecatalog_describe_constraint(AcceptLanguage = NULL, Id)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The identifier of the constraint. |
Gets the status of the specified copy product operation
Description
Gets the status of the specified copy product operation.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_copy_product_status/ for full documentation.
Usage
servicecatalog_describe_copy_product_status(
AcceptLanguage = NULL,
CopyProductToken
)
Arguments
AcceptLanguage |
The language code.
|
CopyProductToken |
[required] The token for the copy product operation. This token is returned by
|
Gets information about the specified portfolio
Description
Gets information about the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_portfolio/ for full documentation.
Usage
servicecatalog_describe_portfolio(AcceptLanguage = NULL, Id)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The portfolio identifier. |
Gets the status of the specified portfolio share operation
Description
Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_portfolio_share_status/ for full documentation.
Usage
servicecatalog_describe_portfolio_share_status(PortfolioShareToken)
Arguments
PortfolioShareToken |
[required] The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare. |
Returns a summary of each of the portfolio shares that were created for the specified portfolio
Description
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_portfolio_shares/ for full documentation.
Usage
servicecatalog_describe_portfolio_shares(
PortfolioId,
Type,
PageToken = NULL,
PageSize = NULL
)
Arguments
PortfolioId |
[required] The unique identifier of the portfolio for which shares will be retrieved. |
Type |
[required] The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following: 1\. 2\. 3\. 4\. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Gets information about the specified product
Description
Gets information about the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_product/ for full documentation.
Usage
servicecatalog_describe_product(AcceptLanguage = NULL, Id = NULL, Name = NULL)
Arguments
AcceptLanguage |
The language code.
|
Id |
The product identifier. |
Name |
The product name. |
Gets information about the specified product
Description
Gets information about the specified product. This operation is run with administrator access.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_product_as_admin/ for full documentation.
Usage
servicecatalog_describe_product_as_admin(
AcceptLanguage = NULL,
Id = NULL,
Name = NULL,
SourcePortfolioId = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Id |
The product identifier. |
Name |
The product name. |
SourcePortfolioId |
The unique identifier of the shared portfolio that the specified product is associated with. You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned. |
Gets information about the specified product
Description
Gets information about the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_product_view/ for full documentation.
Usage
servicecatalog_describe_product_view(AcceptLanguage = NULL, Id)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The product view identifier. |
Gets information about the specified provisioned product
Description
Gets information about the specified provisioned product.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_provisioned_product/ for full documentation.
Usage
servicecatalog_describe_provisioned_product(
AcceptLanguage = NULL,
Id = NULL,
Name = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Id |
The provisioned product identifier. You must provide the name or ID, but not both. If you do not provide a name or ID, or you provide both name and ID, an
|
Name |
The name of the provisioned product. You must provide the name or ID, but not both. If you do not provide a name or ID, or you provide both name and ID, an
|
Gets information about the resource changes for the specified plan
Description
Gets information about the resource changes for the specified plan.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_provisioned_product_plan/ for full documentation.
Usage
servicecatalog_describe_provisioned_product_plan(
AcceptLanguage = NULL,
PlanId,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PlanId |
[required] The plan identifier. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Gets information about the specified provisioning artifact (also known as a version) for the specified product
Description
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_provisioning_artifact/ for full documentation.
Usage
servicecatalog_describe_provisioning_artifact(
AcceptLanguage = NULL,
ProvisioningArtifactId = NULL,
ProductId = NULL,
ProvisioningArtifactName = NULL,
ProductName = NULL,
Verbose = NULL,
IncludeProvisioningArtifactParameters = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProvisioningArtifactId |
The identifier of the provisioning artifact. |
ProductId |
The product identifier. |
ProvisioningArtifactName |
The provisioning artifact name. |
ProductName |
The product name. |
Verbose |
Indicates whether a verbose level of detail is enabled. |
IncludeProvisioningArtifactParameters |
Indicates if the API call response does or does not include additional details about the provisioning parameters. |
Gets information about the configuration required to provision the specified product using the specified provisioning artifact
Description
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_provisioning_parameters/ for full documentation.
Usage
servicecatalog_describe_provisioning_parameters(
AcceptLanguage = NULL,
ProductId = NULL,
ProductName = NULL,
ProvisioningArtifactId = NULL,
ProvisioningArtifactName = NULL,
PathId = NULL,
PathName = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
The product identifier. You must provide the product name or ID, but not both. |
ProductName |
The name of the product. You must provide the name or ID, but not both. |
ProvisioningArtifactId |
The identifier of the provisioning artifact. You must provide the name or ID, but not both. |
ProvisioningArtifactName |
The name of the provisioning artifact. You must provide the name or ID, but not both. |
PathId |
The path identifier of the product. This value is optional if the
product has a default path, and required if the product has more than
one path. To list the paths for a product, use
|
PathName |
The name of the path. You must provide the name or ID, but not both. |
Gets information about the specified request operation
Description
Gets information about the specified request operation.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_record/ for full documentation.
Usage
servicecatalog_describe_record(
AcceptLanguage = NULL,
Id,
PageToken = NULL,
PageSize = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The record identifier of the provisioned product. This identifier is returned by the request operation. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Describes a self-service action
Description
Describes a self-service action.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_service_action/ for full documentation.
Usage
servicecatalog_describe_service_action(Id, AcceptLanguage = NULL)
Arguments
Id |
[required] The self-service action identifier. |
AcceptLanguage |
The language code.
|
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user
Description
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_service_action_execution_parameters/ for full documentation.
Usage
servicecatalog_describe_service_action_execution_parameters(
ProvisionedProductId,
ServiceActionId,
AcceptLanguage = NULL
)
Arguments
ProvisionedProductId |
[required] The identifier of the provisioned product. |
ServiceActionId |
[required] The self-service action identifier. |
AcceptLanguage |
The language code.
|
Gets information about the specified TagOption
Description
Gets information about the specified TagOption.
See https://www.paws-r-sdk.com/docs/servicecatalog_describe_tag_option/ for full documentation.
Usage
servicecatalog_describe_tag_option(Id)
Arguments
Id |
[required] The TagOption identifier. |
Disable portfolio sharing through the Organizations service
Description
Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
See https://www.paws-r-sdk.com/docs/servicecatalog_disable_aws_organizations_access/ for full documentation.
Usage
servicecatalog_disable_aws_organizations_access()
Disassociates the specified budget from the specified resource
Description
Disassociates the specified budget from the specified resource.
See https://www.paws-r-sdk.com/docs/servicecatalog_disassociate_budget_from_resource/ for full documentation.
Usage
servicecatalog_disassociate_budget_from_resource(BudgetName, ResourceId)
Arguments
BudgetName |
[required] The name of the budget you want to disassociate. |
ResourceId |
[required] The resource identifier you want to disassociate from. Either a portfolio-id or a product-id. |
Disassociates a previously associated principal ARN from a specified portfolio
Description
Disassociates a previously associated principal ARN from a specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_disassociate_principal_from_portfolio/ for full documentation.
Usage
servicecatalog_disassociate_principal_from_portfolio(
AcceptLanguage = NULL,
PortfolioId,
PrincipalARN,
PrincipalType = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
PrincipalARN |
[required] The ARN of the principal (user, role, or group). This field allows an
ARN with no |
PrincipalType |
The supported value is |
Disassociates the specified product from the specified portfolio
Description
Disassociates the specified product from the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_disassociate_product_from_portfolio/ for full documentation.
Usage
servicecatalog_disassociate_product_from_portfolio(
AcceptLanguage = NULL,
ProductId,
PortfolioId
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
PortfolioId |
[required] The portfolio identifier. |
Disassociates the specified self-service action association from the specified provisioning artifact
Description
Disassociates the specified self-service action association from the specified provisioning artifact.
See https://www.paws-r-sdk.com/docs/servicecatalog_disassociate_service_action_from_provisioning_artifact/ for full documentation.
Usage
servicecatalog_disassociate_service_action_from_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
ServiceActionId,
AcceptLanguage = NULL,
IdempotencyToken = NULL
)
Arguments
ProductId |
[required] The product identifier. For example, |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. For example,
|
ServiceActionId |
[required] The self-service action identifier. For example, |
AcceptLanguage |
The language code.
|
IdempotencyToken |
A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request. |
Disassociates the specified TagOption from the specified resource
Description
Disassociates the specified TagOption from the specified resource.
See https://www.paws-r-sdk.com/docs/servicecatalog_disassociate_tag_option_from_resource/ for full documentation.
Usage
servicecatalog_disassociate_tag_option_from_resource(ResourceId, TagOptionId)
Arguments
ResourceId |
[required] The resource identifier. |
TagOptionId |
[required] The TagOption identifier. |
Enable portfolio sharing feature through Organizations
Description
Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.
See https://www.paws-r-sdk.com/docs/servicecatalog_enable_aws_organizations_access/ for full documentation.
Usage
servicecatalog_enable_aws_organizations_access()
Provisions or modifies a product based on the resource changes for the specified plan
Description
Provisions or modifies a product based on the resource changes for the specified plan.
See https://www.paws-r-sdk.com/docs/servicecatalog_execute_provisioned_product_plan/ for full documentation.
Usage
servicecatalog_execute_provisioned_product_plan(
AcceptLanguage = NULL,
PlanId,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
PlanId |
[required] The plan identifier. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Executes a self-service action against a provisioned product
Description
Executes a self-service action against a provisioned product.
See https://www.paws-r-sdk.com/docs/servicecatalog_execute_provisioned_product_service_action/ for full documentation.
Usage
servicecatalog_execute_provisioned_product_service_action(
ProvisionedProductId,
ServiceActionId,
ExecuteToken,
AcceptLanguage = NULL,
Parameters = NULL
)
Arguments
ProvisionedProductId |
[required] The identifier of the provisioned product. |
ServiceActionId |
[required] The self-service action identifier. For example, |
ExecuteToken |
[required] An idempotency token that uniquely identifies the execute request. |
AcceptLanguage |
The language code.
|
Parameters |
A map of all self-service action parameters and their values. If a
provided parameter is of a special type, such as |
Get the Access Status for Organizations portfolio share feature
Description
Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
See https://www.paws-r-sdk.com/docs/servicecatalog_get_aws_organizations_access_status/ for full documentation.
Usage
servicecatalog_get_aws_organizations_access_status()
This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs
Description
This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
See https://www.paws-r-sdk.com/docs/servicecatalog_get_provisioned_product_outputs/ for full documentation.
Usage
servicecatalog_get_provisioned_product_outputs(
AcceptLanguage = NULL,
ProvisionedProductId = NULL,
ProvisionedProductName = NULL,
OutputKeys = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProvisionedProductId |
The identifier of the provisioned product that you want the outputs from. |
ProvisionedProductName |
The name of the provisioned product that you want the outputs from. |
OutputKeys |
The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact
Description
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.
See https://www.paws-r-sdk.com/docs/servicecatalog_import_as_provisioned_product/ for full documentation.
Usage
servicecatalog_import_as_provisioned_product(
AcceptLanguage = NULL,
ProductId,
ProvisioningArtifactId,
ProvisionedProductName,
PhysicalId,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. |
ProvisionedProductName |
[required] The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned. |
PhysicalId |
[required] The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs. |
IdempotencyToken |
[required] A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. |
Lists all imported portfolios for which account-to-account shares were accepted by this account
Description
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_accepted_portfolio_shares/ for full documentation.
Usage
servicecatalog_list_accepted_portfolio_shares(
AcceptLanguage = NULL,
PageToken = NULL,
PageSize = NULL,
PortfolioShareType = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
PortfolioShareType |
The type of shared portfolios to list. The default is to list imported portfolios.
|
Lists all the budgets associated to the specified resource
Description
Lists all the budgets associated to the specified resource.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_budgets_for_resource/ for full documentation.
Usage
servicecatalog_list_budgets_for_resource(
AcceptLanguage = NULL,
ResourceId,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ResourceId |
[required] The resource identifier. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Lists the constraints for the specified portfolio and product
Description
Lists the constraints for the specified portfolio and product.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_constraints_for_portfolio/ for full documentation.
Usage
servicecatalog_list_constraints_for_portfolio(
AcceptLanguage = NULL,
PortfolioId,
ProductId = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
ProductId |
The product identifier. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Lists the paths to the specified product
Description
Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_launch_paths/ for full documentation.
Usage
servicecatalog_list_launch_paths(
AcceptLanguage = NULL,
ProductId,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Lists the organization nodes that have access to the specified portfolio
Description
Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_organization_portfolio_access/ for full documentation.
Usage
servicecatalog_list_organization_portfolio_access(
AcceptLanguage = NULL,
PortfolioId,
OrganizationNodeType,
PageToken = NULL,
PageSize = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. For example, |
OrganizationNodeType |
[required] The organization node type that will be returned in the output.
|
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Lists the account IDs that have access to the specified portfolio
Description
Lists the account IDs that have access to the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_portfolio_access/ for full documentation.
Usage
servicecatalog_list_portfolio_access(
AcceptLanguage = NULL,
PortfolioId,
OrganizationParentId = NULL,
PageToken = NULL,
PageSize = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
OrganizationParentId |
The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Lists all portfolios in the catalog
Description
Lists all portfolios in the catalog.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_portfolios/ for full documentation.
Usage
servicecatalog_list_portfolios(
AcceptLanguage = NULL,
PageToken = NULL,
PageSize = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Lists all portfolios that the specified product is associated with
Description
Lists all portfolios that the specified product is associated with.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_portfolios_for_product/ for full documentation.
Usage
servicecatalog_list_portfolios_for_product(
AcceptLanguage = NULL,
ProductId,
PageToken = NULL,
PageSize = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio
Description
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_principals_for_portfolio/ for full documentation.
Usage
servicecatalog_list_principals_for_portfolio(
AcceptLanguage = NULL,
PortfolioId,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Lists the plans for the specified provisioned product or all plans to which the user has access
Description
Lists the plans for the specified provisioned product or all plans to which the user has access.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_provisioned_product_plans/ for full documentation.
Usage
servicecatalog_list_provisioned_product_plans(
AcceptLanguage = NULL,
ProvisionProductId = NULL,
PageSize = NULL,
PageToken = NULL,
AccessLevelFilter = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProvisionProductId |
The product identifier. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
AccessLevelFilter |
The access level to use to obtain results. The default is |
Lists all provisioning artifacts (also known as versions) for the specified product
Description
Lists all provisioning artifacts (also known as versions) for the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_provisioning_artifacts/ for full documentation.
Usage
servicecatalog_list_provisioning_artifacts(AcceptLanguage = NULL, ProductId)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
Lists all provisioning artifacts (also known as versions) for the specified self-service action
Description
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_provisioning_artifacts_for_service_action/ for full documentation.
Usage
servicecatalog_list_provisioning_artifacts_for_service_action(
ServiceActionId,
PageSize = NULL,
PageToken = NULL,
AcceptLanguage = NULL
)
Arguments
ServiceActionId |
[required] The self-service action identifier. For example, |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
AcceptLanguage |
The language code.
|
Lists the specified requests or all performed requests
Description
Lists the specified requests or all performed requests.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_record_history/ for full documentation.
Usage
servicecatalog_list_record_history(
AcceptLanguage = NULL,
AccessLevelFilter = NULL,
SearchFilter = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
AccessLevelFilter |
The access level to use to obtain results. The default is |
SearchFilter |
The search filter to scope the results. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Lists the resources associated with the specified TagOption
Description
Lists the resources associated with the specified TagOption.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_resources_for_tag_option/ for full documentation.
Usage
servicecatalog_list_resources_for_tag_option(
TagOptionId,
ResourceType = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
TagOptionId |
[required] The TagOption identifier. |
ResourceType |
The resource type.
|
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Lists all self-service actions
Description
Lists all self-service actions.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_service_actions/ for full documentation.
Usage
servicecatalog_list_service_actions(
AcceptLanguage = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID
Description
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_service_actions_for_provisioning_artifact/ for full documentation.
Usage
servicecatalog_list_service_actions_for_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
PageSize = NULL,
PageToken = NULL,
AcceptLanguage = NULL
)
Arguments
ProductId |
[required] The product identifier. For example, |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. For example,
|
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
AcceptLanguage |
The language code.
|
Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product
Description
Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_stack_instances_for_provisioned_product/ for full documentation.
Usage
servicecatalog_list_stack_instances_for_provisioned_product(
AcceptLanguage = NULL,
ProvisionedProductId,
PageToken = NULL,
PageSize = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProvisionedProductId |
[required] The identifier of the provisioned product. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
Lists the specified TagOptions or all TagOptions
Description
Lists the specified TagOptions or all TagOptions.
See https://www.paws-r-sdk.com/docs/servicecatalog_list_tag_options/ for full documentation.
Usage
servicecatalog_list_tag_options(
Filters = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
Filters |
The search filters. If no search filters are specified, the output includes all TagOptions. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Notifies the result of the provisioning engine execution
Description
Notifies the result of the provisioning engine execution.
See https://www.paws-r-sdk.com/docs/servicecatalog_notify_provision_product_engine_workflow_result/ for full documentation.
Usage
servicecatalog_notify_provision_product_engine_workflow_result(
WorkflowToken,
RecordId,
Status,
FailureReason = NULL,
ResourceIdentifier = NULL,
Outputs = NULL,
IdempotencyToken
)
Arguments
WorkflowToken |
[required] The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts. |
RecordId |
[required] The identifier of the record. |
Status |
[required] The status of the provisioning engine execution. |
FailureReason |
The reason why the provisioning engine execution failed. |
ResourceIdentifier |
The ID for the provisioned product resources that are part of a resource group. |
Outputs |
The output of the provisioning engine execution. |
IdempotencyToken |
[required] The idempotency token that identifies the provisioning engine execution. |
Notifies the result of the terminate engine execution
Description
Notifies the result of the terminate engine execution.
See https://www.paws-r-sdk.com/docs/servicecatalog_notify_terminate_provisioned_product_engine_workflow_result/ for full documentation.
Usage
servicecatalog_notify_terminate_provisioned_product_engine_workflow_result(
WorkflowToken,
RecordId,
Status,
FailureReason = NULL,
IdempotencyToken
)
Arguments
WorkflowToken |
[required] The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts. |
RecordId |
[required] The identifier of the record. |
Status |
[required] The status of the terminate engine execution. |
FailureReason |
The reason why the terminate engine execution failed. |
IdempotencyToken |
[required] The idempotency token that identifies the terminate engine execution. |
Notifies the result of the update engine execution
Description
Notifies the result of the update engine execution.
See https://www.paws-r-sdk.com/docs/servicecatalog_notify_update_provisioned_product_engine_workflow_result/ for full documentation.
Usage
servicecatalog_notify_update_provisioned_product_engine_workflow_result(
WorkflowToken,
RecordId,
Status,
FailureReason = NULL,
Outputs = NULL,
IdempotencyToken
)
Arguments
WorkflowToken |
[required] The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts. |
RecordId |
[required] The identifier of the record. |
Status |
[required] The status of the update engine execution. |
FailureReason |
The reason why the update engine execution failed. |
Outputs |
The output of the update engine execution. |
IdempotencyToken |
[required] The idempotency token that identifies the update engine execution. |
Provisions the specified product
Description
Provisions the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_provision_product/ for full documentation.
Usage
servicecatalog_provision_product(
AcceptLanguage = NULL,
ProductId = NULL,
ProductName = NULL,
ProvisioningArtifactId = NULL,
ProvisioningArtifactName = NULL,
PathId = NULL,
PathName = NULL,
ProvisionedProductName,
ProvisioningParameters = NULL,
ProvisioningPreferences = NULL,
Tags = NULL,
NotificationArns = NULL,
ProvisionToken
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
The product identifier. You must provide the name or ID, but not both. |
ProductName |
The name of the product. You must provide the name or ID, but not both. |
ProvisioningArtifactId |
The identifier of the provisioning artifact. You must provide the name or ID, but not both. |
ProvisioningArtifactName |
The name of the provisioning artifact. You must provide the name or ID, but not both. |
PathId |
The path identifier of the product. This value is optional if the
product has a default path, and required if the product has more than
one path. To list the paths for a product, use
|
PathName |
The name of the path. You must provide the name or ID, but not both. |
ProvisionedProductName |
[required] A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned. |
ProvisioningParameters |
Parameters specified by the administrator that are required for provisioning the product. |
ProvisioningPreferences |
An object that contains information about the provisioning preferences for a stack set. |
Tags |
One or more tags. |
NotificationArns |
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. |
ProvisionToken |
[required] An idempotency token that uniquely identifies the provisioning request. |
Rejects an offer to share the specified portfolio
Description
Rejects an offer to share the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_reject_portfolio_share/ for full documentation.
Usage
servicecatalog_reject_portfolio_share(
AcceptLanguage = NULL,
PortfolioId,
PortfolioShareType = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The portfolio identifier. |
PortfolioShareType |
The type of shared portfolios to reject. The default is to reject imported portfolios.
For example,
|
Lists the provisioned products that are available (not terminated)
Description
Lists the provisioned products that are available (not terminated).
See https://www.paws-r-sdk.com/docs/servicecatalog_scan_provisioned_products/ for full documentation.
Usage
servicecatalog_scan_provisioned_products(
AcceptLanguage = NULL,
AccessLevelFilter = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
AccessLevelFilter |
The access level to use to obtain results. The default is |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Gets information about the products to which the caller has access
Description
Gets information about the products to which the caller has access.
See https://www.paws-r-sdk.com/docs/servicecatalog_search_products/ for full documentation.
Usage
servicecatalog_search_products(
AcceptLanguage = NULL,
Filters = NULL,
PageSize = NULL,
SortBy = NULL,
SortOrder = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Filters |
The search filters. If no search filters are specified, the output includes all products to which the caller has access. |
PageSize |
The maximum number of items to return with this call. |
SortBy |
The sort field. If no value is specified, the results are not sorted. |
SortOrder |
The sort order. If no value is specified, the results are not sorted. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Gets information about the products for the specified portfolio or all products
Description
Gets information about the products for the specified portfolio or all products.
See https://www.paws-r-sdk.com/docs/servicecatalog_search_products_as_admin/ for full documentation.
Usage
servicecatalog_search_products_as_admin(
AcceptLanguage = NULL,
PortfolioId = NULL,
Filters = NULL,
SortBy = NULL,
SortOrder = NULL,
PageToken = NULL,
PageSize = NULL,
ProductSource = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
The portfolio identifier. |
Filters |
The search filters. If no search filters are specified, the output includes all products to which the administrator has access. |
SortBy |
The sort field. If no value is specified, the results are not sorted. |
SortOrder |
The sort order. If no value is specified, the results are not sorted. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
PageSize |
The maximum number of items to return with this call. |
ProductSource |
Access level of the source of the product. |
Gets information about the provisioned products that meet the specified criteria
Description
Gets information about the provisioned products that meet the specified criteria.
See https://www.paws-r-sdk.com/docs/servicecatalog_search_provisioned_products/ for full documentation.
Usage
servicecatalog_search_provisioned_products(
AcceptLanguage = NULL,
AccessLevelFilter = NULL,
Filters = NULL,
SortBy = NULL,
SortOrder = NULL,
PageSize = NULL,
PageToken = NULL
)
Arguments
AcceptLanguage |
The language code.
|
AccessLevelFilter |
The access level to use to obtain results. The default is |
Filters |
The search filters. When the key is Example: |
SortBy |
The sort field. If no value is specified, the results are not sorted.
The valid values are |
SortOrder |
The sort order. If no value is specified, the results are not sorted. |
PageSize |
The maximum number of items to return with this call. |
PageToken |
The page token for the next set of results. To retrieve the first set of results, use null. |
Terminates the specified provisioned product
Description
Terminates the specified provisioned product.
See https://www.paws-r-sdk.com/docs/servicecatalog_terminate_provisioned_product/ for full documentation.
Usage
servicecatalog_terminate_provisioned_product(
ProvisionedProductName = NULL,
ProvisionedProductId = NULL,
TerminateToken,
IgnoreErrors = NULL,
AcceptLanguage = NULL,
RetainPhysicalResources = NULL
)
Arguments
ProvisionedProductName |
The name of the provisioned product. You cannot specify both
|
ProvisionedProductId |
The identifier of the provisioned product. You cannot specify both
|
TerminateToken |
[required] An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound. |
IgnoreErrors |
If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. |
AcceptLanguage |
The language code.
|
RetainPhysicalResources |
When this boolean parameter is set to true, the
|
Updates the specified constraint
Description
Updates the specified constraint.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_constraint/ for full documentation.
Usage
servicecatalog_update_constraint(
AcceptLanguage = NULL,
Id,
Description = NULL,
Parameters = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The identifier of the constraint. |
Description |
The updated description of the constraint. |
Parameters |
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH You are required to specify either the Specify the
Specify the
If you specify the The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint. You cannot have both a You also cannot have more than one NOTIFICATION Specify the
RESOURCE_UPDATE Specify the
The STACKSET Specify the
You cannot have both a You also cannot have more than one Products with a TEMPLATE Specify the |
Updates the specified portfolio
Description
Updates the specified portfolio.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_portfolio/ for full documentation.
Usage
servicecatalog_update_portfolio(
AcceptLanguage = NULL,
Id,
DisplayName = NULL,
Description = NULL,
ProviderName = NULL,
AddTags = NULL,
RemoveTags = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The portfolio identifier. |
DisplayName |
The name to use for display purposes. |
Description |
The updated description of the portfolio. |
ProviderName |
The updated name of the portfolio provider. |
AddTags |
The tags to add. |
RemoveTags |
The tags to remove. |
Updates the specified portfolio share
Description
Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_portfolio_share/ for full documentation.
Usage
servicecatalog_update_portfolio_share(
AcceptLanguage = NULL,
PortfolioId,
AccountId = NULL,
OrganizationNode = NULL,
ShareTagOptions = NULL,
SharePrincipals = NULL
)
Arguments
AcceptLanguage |
The language code.
|
PortfolioId |
[required] The unique identifier of the portfolio for which the share will be updated. |
AccountId |
The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share. |
OrganizationNode |
|
ShareTagOptions |
Enables or disables |
SharePrincipals |
A flag to enables or disables |
Updates the specified product
Description
Updates the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_product/ for full documentation.
Usage
servicecatalog_update_product(
AcceptLanguage = NULL,
Id,
Name = NULL,
Owner = NULL,
Description = NULL,
Distributor = NULL,
SupportDescription = NULL,
SupportEmail = NULL,
SupportUrl = NULL,
AddTags = NULL,
RemoveTags = NULL,
SourceConnection = NULL
)
Arguments
AcceptLanguage |
The language code.
|
Id |
[required] The product identifier. |
Name |
The updated product name. |
Owner |
The updated owner of the product. |
Description |
The updated description of the product. |
Distributor |
The updated distributor of the product. |
SupportDescription |
The updated support description for the product. |
SupportEmail |
The updated support email for the product. |
SupportUrl |
The updated support URL for the product. |
AddTags |
The tags to add to the product. |
RemoveTags |
The tags to remove from the product. |
SourceConnection |
Specifies connection details for the updated product and syncs the
product to the connection source artifact. This automatically manages
the product's artifacts based on changes to the source. The
|
Requests updates to the configuration of the specified provisioned product
Description
Requests updates to the configuration of the specified provisioned product.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_provisioned_product/ for full documentation.
Usage
servicecatalog_update_provisioned_product(
AcceptLanguage = NULL,
ProvisionedProductName = NULL,
ProvisionedProductId = NULL,
ProductId = NULL,
ProductName = NULL,
ProvisioningArtifactId = NULL,
ProvisioningArtifactName = NULL,
PathId = NULL,
PathName = NULL,
ProvisioningParameters = NULL,
ProvisioningPreferences = NULL,
Tags = NULL,
UpdateToken
)
Arguments
AcceptLanguage |
The language code.
|
ProvisionedProductName |
The name of the provisioned product. You cannot specify both
|
ProvisionedProductId |
The identifier of the provisioned product. You must provide the name or ID, but not both. |
ProductId |
The identifier of the product. You must provide the name or ID, but not both. |
ProductName |
The name of the product. You must provide the name or ID, but not both. |
ProvisioningArtifactId |
The identifier of the provisioning artifact. |
ProvisioningArtifactName |
The name of the provisioning artifact. You must provide the name or ID, but not both. |
PathId |
The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both. |
PathName |
The name of the path. You must provide the name or ID, but not both. |
ProvisioningParameters |
The new parameters. |
ProvisioningPreferences |
An object that contains information about the provisioning preferences for a stack set. |
Tags |
One or more tags. Requires the product to have |
UpdateToken |
[required] The idempotency token that uniquely identifies the provisioning update request. |
Requests updates to the properties of the specified provisioned product
Description
Requests updates to the properties of the specified provisioned product.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_provisioned_product_properties/ for full documentation.
Usage
servicecatalog_update_provisioned_product_properties(
AcceptLanguage = NULL,
ProvisionedProductId,
ProvisionedProductProperties,
IdempotencyToken
)
Arguments
AcceptLanguage |
The language code.
|
ProvisionedProductId |
[required] The identifier of the provisioned product. |
ProvisionedProductProperties |
[required] A map that contains the provisioned product properties to be updated. The The The administrator can change the owner of a provisioned product to
another IAM or STS entity within the same account. Both end user owners
and administrators can see ownership history of the provisioned product
using the If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product. |
IdempotencyToken |
[required] The idempotency token that uniquely identifies the provisioning product update request. |
Updates the specified provisioning artifact (also known as a version) for the specified product
Description
Updates the specified provisioning artifact (also known as a version) for the specified product.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_provisioning_artifact/ for full documentation.
Usage
servicecatalog_update_provisioning_artifact(
AcceptLanguage = NULL,
ProductId,
ProvisioningArtifactId,
Name = NULL,
Description = NULL,
Active = NULL,
Guidance = NULL
)
Arguments
AcceptLanguage |
The language code.
|
ProductId |
[required] The product identifier. |
ProvisioningArtifactId |
[required] The identifier of the provisioning artifact. |
Name |
The updated name of the provisioning artifact. |
Description |
The updated description of the provisioning artifact. |
Active |
Indicates whether the product version is active. Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact. |
Guidance |
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use. The The administrator can set the guidance to |
Updates a self-service action
Description
Updates a self-service action.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_service_action/ for full documentation.
Usage
servicecatalog_update_service_action(
Id,
Name = NULL,
Definition = NULL,
Description = NULL,
AcceptLanguage = NULL
)
Arguments
Id |
[required] The self-service action identifier. |
Name |
The self-service action name. |
Definition |
A map that defines the self-service action. |
Description |
The self-service action description. |
AcceptLanguage |
The language code.
|
Updates the specified TagOption
Description
Updates the specified TagOption.
See https://www.paws-r-sdk.com/docs/servicecatalog_update_tag_option/ for full documentation.
Usage
servicecatalog_update_tag_option(Id, Value = NULL, Active = NULL)
Arguments
Id |
[required] The TagOption identifier. |
Value |
The updated value. |
Active |
The updated active state. |
Service Quotas
Description
With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.
Usage
servicequotas(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- servicequotas(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_service_quota_template | Associates your quota request template with your organization |
| delete_service_quota_increase_request_from_template | Deletes the quota increase request for the specified quota from your quota request template |
| disassociate_service_quota_template | Disables your quota request template |
| get_association_for_service_quota_template | Retrieves the status of the association for the quota request template |
| get_aws_default_service_quota | Retrieves the default value for the specified quota |
| get_requested_service_quota_change | Retrieves information about the specified quota increase request |
| get_service_quota | Retrieves the applied quota value for the specified quota |
| get_service_quota_increase_request_from_template | Retrieves information about the specified quota increase request in your quota request template |
| list_aws_default_service_quotas | Lists the default values for the quotas for the specified Amazon Web Service |
| list_requested_service_quota_change_history | Retrieves the quota increase requests for the specified Amazon Web Service |
| list_requested_service_quota_change_history_by_quota | Retrieves the quota increase requests for the specified quota |
| list_service_quota_increase_requests_in_template | Lists the quota increase requests in the specified quota request template |
| list_service_quotas | Lists the applied quota values for the specified Amazon Web Service |
| list_services | Lists the names and codes for the Amazon Web Services integrated with Service Quotas |
| list_tags_for_resource | Returns a list of the tags assigned to the specified applied quota |
| put_service_quota_increase_request_into_template | Adds a quota increase request to your quota request template |
| request_service_quota_increase | Submits a quota increase request for the specified quota |
| tag_resource | Adds tags to the specified applied quota |
| untag_resource | Removes tags from the specified applied quota |
Examples
## Not run:
svc <- servicequotas()
svc$associate_service_quota_template(
Foo = 123
)
## End(Not run)
Associates your quota request template with your organization
Description
Associates your quota request template with your organization. When a new Amazon Web Services account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.
See https://www.paws-r-sdk.com/docs/servicequotas_associate_service_quota_template/ for full documentation.
Usage
servicequotas_associate_service_quota_template()
Deletes the quota increase request for the specified quota from your quota request template
Description
Deletes the quota increase request for the specified quota from your quota request template.
See https://www.paws-r-sdk.com/docs/servicequotas_delete_service_quota_increase_request_from_template/ for full documentation.
Usage
servicequotas_delete_service_quota_increase_request_from_template(
ServiceCode,
QuotaCode,
AwsRegion
)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
AwsRegion |
[required] Specifies the Amazon Web Services Region for which the request was made. |
Disables your quota request template
Description
Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new Amazon Web Services accounts in your organization. Disabling a quota request template does not apply its quota increase requests.
See https://www.paws-r-sdk.com/docs/servicequotas_disassociate_service_quota_template/ for full documentation.
Usage
servicequotas_disassociate_service_quota_template()
Retrieves the status of the association for the quota request template
Description
Retrieves the status of the association for the quota request template.
See https://www.paws-r-sdk.com/docs/servicequotas_get_association_for_service_quota_template/ for full documentation.
Usage
servicequotas_get_association_for_service_quota_template()
Retrieves the default value for the specified quota
Description
Retrieves the default value for the specified quota. The default value does not reflect any quota increases.
See https://www.paws-r-sdk.com/docs/servicequotas_get_aws_default_service_quota/ for full documentation.
Usage
servicequotas_get_aws_default_service_quota(ServiceCode, QuotaCode)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
Retrieves information about the specified quota increase request
Description
Retrieves information about the specified quota increase request.
See https://www.paws-r-sdk.com/docs/servicequotas_get_requested_service_quota_change/ for full documentation.
Usage
servicequotas_get_requested_service_quota_change(RequestId)
Arguments
RequestId |
[required] Specifies the ID of the quota increase request. |
Retrieves the applied quota value for the specified quota
Description
Retrieves the applied quota value for the specified quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.
See https://www.paws-r-sdk.com/docs/servicequotas_get_service_quota/ for full documentation.
Usage
servicequotas_get_service_quota(ServiceCode, QuotaCode, ContextId = NULL)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
ContextId |
Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota. |
Retrieves information about the specified quota increase request in your quota request template
Description
Retrieves information about the specified quota increase request in your quota request template.
See https://www.paws-r-sdk.com/docs/servicequotas_get_service_quota_increase_request_from_template/ for full documentation.
Usage
servicequotas_get_service_quota_increase_request_from_template(
ServiceCode,
QuotaCode,
AwsRegion
)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
AwsRegion |
[required] Specifies the Amazon Web Services Region for which you made the request. |
Lists the default values for the quotas for the specified Amazon Web Service
Description
Lists the default values for the quotas for the specified Amazon Web Service. A default value does not reflect any quota increases.
See https://www.paws-r-sdk.com/docs/servicequotas_list_aws_default_service_quotas/ for full documentation.
Usage
servicequotas_list_aws_default_service_quotas(
ServiceCode,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
NextToken |
Specifies a value for receiving additional results after you receive a
|
MaxResults |
Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value appropriate to the operation. If additional items exist
beyond those included in the current response, the An API operation can return fewer results than the maximum even when
there are more results available. You should check |
Retrieves the quota increase requests for the specified Amazon Web Service
Description
Retrieves the quota increase requests for the specified Amazon Web Service.
See https://www.paws-r-sdk.com/docs/servicequotas_list_requested_service_quota_change_history/ for full documentation.
Usage
servicequotas_list_requested_service_quota_change_history(
ServiceCode = NULL,
Status = NULL,
NextToken = NULL,
MaxResults = NULL,
QuotaRequestedAtLevel = NULL
)
Arguments
ServiceCode |
Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
Status |
Specifies that you want to filter the results to only the requests with the matching status. |
NextToken |
Specifies a value for receiving additional results after you receive a
|
MaxResults |
Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value appropriate to the operation. If additional items exist
beyond those included in the current response, the An API operation can return fewer results than the maximum even when
there are more results available. You should check |
QuotaRequestedAtLevel |
Specifies at which level within the Amazon Web Services account the quota request applies to. |
Retrieves the quota increase requests for the specified quota
Description
Retrieves the quota increase requests for the specified quota.
See https://www.paws-r-sdk.com/docs/servicequotas_list_requested_service_quota_change_history_by_quota/ for full documentation.
Usage
servicequotas_list_requested_service_quota_change_history_by_quota(
ServiceCode,
QuotaCode,
Status = NULL,
NextToken = NULL,
MaxResults = NULL,
QuotaRequestedAtLevel = NULL
)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
Status |
Specifies that you want to filter the results to only the requests with the matching status. |
NextToken |
Specifies a value for receiving additional results after you receive a
|
MaxResults |
Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value appropriate to the operation. If additional items exist
beyond those included in the current response, the An API operation can return fewer results than the maximum even when
there are more results available. You should check |
QuotaRequestedAtLevel |
Specifies at which level within the Amazon Web Services account the quota request applies to. |
Lists the quota increase requests in the specified quota request template
Description
Lists the quota increase requests in the specified quota request template.
See https://www.paws-r-sdk.com/docs/servicequotas_list_service_quota_increase_requests_in_template/ for full documentation.
Usage
servicequotas_list_service_quota_increase_requests_in_template(
ServiceCode = NULL,
AwsRegion = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceCode |
Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
AwsRegion |
Specifies the Amazon Web Services Region for which you made the request. |
NextToken |
Specifies a value for receiving additional results after you receive a
|
MaxResults |
Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value appropriate to the operation. If additional items exist
beyond those included in the current response, the An API operation can return fewer results than the maximum even when
there are more results available. You should check |
Lists the applied quota values for the specified Amazon Web Service
Description
Lists the applied quota values for the specified Amazon Web Service. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.
See https://www.paws-r-sdk.com/docs/servicequotas_list_service_quotas/ for full documentation.
Usage
servicequotas_list_service_quotas(
ServiceCode,
NextToken = NULL,
MaxResults = NULL,
QuotaCode = NULL,
QuotaAppliedAtLevel = NULL
)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
NextToken |
Specifies a value for receiving additional results after you receive a
|
MaxResults |
Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value appropriate to the operation. If additional items exist
beyond those included in the current response, the An API operation can return fewer results than the maximum even when
there are more results available. You should check |
QuotaCode |
Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
QuotaAppliedAtLevel |
Specifies at which level of granularity that the quota value is applied. |
Lists the names and codes for the Amazon Web Services integrated with Service Quotas
Description
Lists the names and codes for the Amazon Web Services integrated with Service Quotas.
See https://www.paws-r-sdk.com/docs/servicequotas_list_services/ for full documentation.
Usage
servicequotas_list_services(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
Specifies a value for receiving additional results after you receive a
|
MaxResults |
Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value appropriate to the operation. If additional items exist
beyond those included in the current response, the An API operation can return fewer results than the maximum even when
there are more results available. You should check |
Returns a list of the tags assigned to the specified applied quota
Description
Returns a list of the tags assigned to the specified applied quota.
See https://www.paws-r-sdk.com/docs/servicequotas_list_tags_for_resource/ for full documentation.
Usage
servicequotas_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) for the applied quota for which you want
to list tags. You can get this information by using the Service Quotas
console, or by listing the quotas using the
list-service-quotas
CLI command or the
|
Adds a quota increase request to your quota request template
Description
Adds a quota increase request to your quota request template.
See https://www.paws-r-sdk.com/docs/servicequotas_put_service_quota_increase_request_into_template/ for full documentation.
Usage
servicequotas_put_service_quota_increase_request_into_template(
QuotaCode,
ServiceCode,
AwsRegion,
DesiredValue
)
Arguments
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
AwsRegion |
[required] Specifies the Amazon Web Services Region to which the template applies. |
DesiredValue |
[required] Specifies the new, increased value for the quota. |
Submits a quota increase request for the specified quota
Description
Submits a quota increase request for the specified quota.
See https://www.paws-r-sdk.com/docs/servicequotas_request_service_quota_increase/ for full documentation.
Usage
servicequotas_request_service_quota_increase(
ServiceCode,
QuotaCode,
DesiredValue,
ContextId = NULL
)
Arguments
ServiceCode |
[required] Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the
|
QuotaCode |
[required] Specifies the quota identifier. To find the quota code for a specific
quota, use the
|
DesiredValue |
[required] Specifies the new, increased value for the quota. |
ContextId |
Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota. |
Adds tags to the specified applied quota
Description
Adds tags to the specified applied quota. You can include one or more tags to add to the quota.
See https://www.paws-r-sdk.com/docs/servicequotas_tag_resource/ for full documentation.
Usage
servicequotas_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) for the applied quota. You can get this
information by using the Service Quotas console, or by listing the
quotas using the
list-service-quotas
CLI command or the
|
Tags |
[required] The tags that you want to add to the resource. |
Removes tags from the specified applied quota
Description
Removes tags from the specified applied quota. You can specify one or more tags to remove.
See https://www.paws-r-sdk.com/docs/servicequotas_untag_resource/ for full documentation.
Usage
servicequotas_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) for the applied quota that you want to
untag. You can get this information by using the Service Quotas console,
or by listing the quotas using the
list-service-quotas
CLI command or the
|
TagKeys |
[required] The keys of the tags that you want to remove from the resource. |
Amazon Simple Systems Manager (SSM)
Description
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
For information about each of the tools that comprise Systems Manager, see Using Systems Manager tools in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
For information about AppConfig, a tool in Systems Manager, see the AppConfig User Guide and the * AppConfig API Reference* .
For information about Incident Manager, a tool in Systems Manager, see the Systems Manager Incident Manager User Guide and the * Systems Manager Incident Manager API Reference* .
Usage
ssm(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- ssm(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| add_tags_to_resource | Adds or overwrites one or more tags for the specified resource |
| associate_ops_item_related_item | Associates a related item to a Systems Manager OpsCenter OpsItem |
| cancel_command | Attempts to cancel the command specified by the Command ID |
| cancel_maintenance_window_execution | Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running |
| create_activation | Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager |
| create_association | A State Manager association defines the state that you want to maintain on your managed nodes |
| create_association_batch | Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets |
| create_document | Creates a Amazon Web Services Systems Manager (SSM document) |
| create_maintenance_window | Creates a new maintenance window |
| create_ops_item | Creates a new OpsItem |
| create_ops_metadata | If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type |
| create_patch_baseline | Creates a patch baseline |
| create_resource_data_sync | A resource data sync helps you view data from multiple sources in a single location |
| delete_activation | Deletes an activation |
| delete_association | Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node |
| delete_document | Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document |
| delete_inventory | Delete a custom inventory type or the data associated with a custom Inventory type |
| delete_maintenance_window | Deletes a maintenance window |
| delete_ops_item | Delete an OpsItem |
| delete_ops_metadata | Delete OpsMetadata related to an application |
| delete_parameter | Delete a parameter from the system |
| delete_parameters | Delete a list of parameters |
| delete_patch_baseline | Deletes a patch baseline |
| delete_resource_data_sync | Deletes a resource data sync configuration |
| delete_resource_policy | Deletes a Systems Manager resource policy |
| deregister_managed_instance | Removes the server or virtual machine from the list of registered servers |
| deregister_patch_baseline_for_patch_group | Removes a patch group from a patch baseline |
| deregister_target_from_maintenance_window | Removes a target from a maintenance window |
| deregister_task_from_maintenance_window | Removes a task from a maintenance window |
| describe_activations | Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation |
| describe_association | Describes the association for the specified target or managed node |
| describe_association_executions | Views all executions for a specific association ID |
| describe_association_execution_targets | Views information about a specific execution of a specific association |
| describe_automation_executions | Provides details about all active and terminated Automation executions |
| describe_automation_step_executions | Information about all active and terminated step executions in an Automation workflow |
| describe_available_patches | Lists all patches eligible to be included in a patch baseline |
| describe_document | Describes the specified Amazon Web Services Systems Manager document (SSM document) |
| describe_document_permission | Describes the permissions for a Amazon Web Services Systems Manager document (SSM document) |
| describe_effective_instance_associations | All associations for the managed nodes |
| describe_effective_patches_for_patch_baseline | Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline |
| describe_instance_associations_status | The status of the associations for the managed nodes |
| describe_instance_information | Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address |
| describe_instance_patches | Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node |
| describe_instance_patch_states | Retrieves the high-level patch state of one or more managed nodes |
| describe_instance_patch_states_for_patch_group | Retrieves the high-level patch state for the managed nodes in the specified patch group |
| describe_instance_properties | An API operation used by the Systems Manager console to display information about Systems Manager managed nodes |
| describe_inventory_deletions | Describes a specific delete inventory operation |
| describe_maintenance_window_executions | Lists the executions of a maintenance window |
| describe_maintenance_window_execution_task_invocations | Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution |
| describe_maintenance_window_execution_tasks | For a given maintenance window execution, lists the tasks that were run |
| describe_maintenance_windows | Retrieves the maintenance windows in an Amazon Web Services account |
| describe_maintenance_window_schedule | Retrieves information about upcoming executions of a maintenance window |
| describe_maintenance_windows_for_target | Retrieves information about the maintenance window targets or tasks that a managed node is associated with |
| describe_maintenance_window_targets | Lists the targets registered with the maintenance window |
| describe_maintenance_window_tasks | Lists the tasks in a maintenance window |
| describe_ops_items | Query a set of OpsItems |
| describe_parameters | Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option |
| describe_patch_baselines | Lists the patch baselines in your Amazon Web Services account |
| describe_patch_groups | Lists all patch groups that have been registered with patch baselines |
| describe_patch_group_state | Returns high-level aggregated patch compliance state information for a patch group |
| describe_patch_properties | Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches |
| describe_sessions | Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days |
| disassociate_ops_item_related_item | Deletes the association between an OpsItem and a related item |
| get_automation_execution | Get detailed information about a particular Automation execution |
| get_calendar_state | Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time |
| get_command_invocation | Returns detailed information about command execution for an invocation or plugin |
| get_connection_status | Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections |
| get_default_patch_baseline | Retrieves the default patch baseline |
| get_deployable_patch_snapshot_for_instance | Retrieves the current snapshot for the patch baseline the managed node uses |
| get_document | Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document) |
| get_execution_preview | Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources |
| get_inventory | Query inventory information |
| get_inventory_schema | Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type |
| get_maintenance_window | Retrieves a maintenance window |
| get_maintenance_window_execution | Retrieves details about a specific a maintenance window execution |
| get_maintenance_window_execution_task | Retrieves the details about a specific task run as part of a maintenance window execution |
| get_maintenance_window_execution_task_invocation | Retrieves information about a specific task running on a specific target |
| get_maintenance_window_task | Retrieves the details of a maintenance window task |
| get_ops_item | Get information about an OpsItem by using the ID |
| get_ops_metadata | View operational metadata related to an application in Application Manager |
| get_ops_summary | View a summary of operations metadata (OpsData) based on specified filters and aggregators |
| get_parameter | Get information about a single parameter by specifying the parameter name |
| get_parameter_history | Retrieves the history of all changes to a parameter |
| get_parameters | Get information about one or more parameters by specifying multiple parameter names |
| get_parameters_by_path | Retrieve information about one or more parameters under a specified level in a hierarchy |
| get_patch_baseline | Retrieves information about a patch baseline |
| get_patch_baseline_for_patch_group | Retrieves the patch baseline that should be used for the specified patch group |
| get_resource_policies | Returns an array of the Policy object |
| get_service_setting | ServiceSetting is an account-level setting for an Amazon Web Services service |
| label_parameter_version | A parameter label is a user-defined alias to help you manage different versions of a parameter |
| list_associations | Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region |
| list_association_versions | Retrieves all versions of an association for a specific association ID |
| list_command_invocations | An invocation is copy of a command sent to a specific managed node |
| list_commands | Lists the commands requested by users of the Amazon Web Services account |
| list_compliance_items | For a specified resource ID, this API operation returns a list of compliance statuses for different resource types |
| list_compliance_summaries | Returns a summary count of compliant and non-compliant resources for a compliance type |
| list_document_metadata_history | Information about approval reviews for a version of a change template in Change Manager |
| list_documents | Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region |
| list_document_versions | List all versions for a document |
| list_inventory_entries | A list of inventory items returned by the request |
| list_nodes | Takes in filters and returns a list of managed nodes matching the filter criteria |
| list_nodes_summary | Generates a summary of managed instance/node metadata based on the filters and aggregators you specify |
| list_ops_item_events | Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account |
| list_ops_item_related_items | Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem |
| list_ops_metadata | Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs |
| list_resource_compliance_summaries | Returns a resource-level summary count |
| list_resource_data_sync | Lists your resource data sync configurations |
| list_tags_for_resource | Returns a list of the tags assigned to the specified resource |
| modify_document_permission | Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately |
| put_compliance_items | Registers a compliance type and other compliance details on a designated resource |
| put_inventory | Bulk update custom inventory items on one or more managed nodes |
| put_parameter | Add a parameter to the system |
| put_resource_policy | Creates or updates a Systems Manager resource policy |
| register_default_patch_baseline | Defines the default patch baseline for the relevant operating system |
| register_patch_baseline_for_patch_group | Registers a patch baseline for a patch group |
| register_target_with_maintenance_window | Registers a target with a maintenance window |
| register_task_with_maintenance_window | Adds a new task to a maintenance window |
| remove_tags_from_resource | Removes tag keys from the specified resource |
| reset_service_setting | ServiceSetting is an account-level setting for an Amazon Web Services service |
| resume_session | Reconnects a session to a managed node after it has been disconnected |
| send_automation_signal | Sends a signal to an Automation execution to change the current behavior or status of the execution |
| send_command | Runs commands on one or more managed nodes |
| start_associations_once | Runs an association immediately and only one time |
| start_automation_execution | Initiates execution of an Automation runbook |
| start_change_request_execution | Creates a change request for Change Manager |
| start_execution_preview | Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources |
| start_session | Initiates a connection to a target (for example, a managed node) for a Session Manager session |
| stop_automation_execution | Stop an Automation that is currently running |
| terminate_session | Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node |
| unlabel_parameter_version | Remove a label or labels from a parameter |
| update_association | Updates an association |
| update_association_status | Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node |
| update_document | Updates one or more values for an SSM document |
| update_document_default_version | Set the default version of a document |
| update_document_metadata | Updates information related to approval reviews for a specific version of a change template in Change Manager |
| update_maintenance_window | Updates an existing maintenance window |
| update_maintenance_window_target | Modifies the target of an existing maintenance window |
| update_maintenance_window_task | Modifies a task assigned to a maintenance window |
| update_managed_instance_role | Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM) |
| update_ops_item | Edit or change an OpsItem |
| update_ops_metadata | Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager |
| update_patch_baseline | Modifies an existing patch baseline |
| update_resource_data_sync | Update a resource data sync |
| update_service_setting | ServiceSetting is an account-level setting for an Amazon Web Services service |
Examples
## Not run:
svc <- ssm()
svc$add_tags_to_resource(
Foo = 123
)
## End(Not run)
Adds or overwrites one or more tags for the specified resource
Description
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
See https://www.paws-r-sdk.com/docs/ssm_add_tags_to_resource/ for full documentation.
Usage
ssm_add_tags_to_resource(ResourceType, ResourceId, Tags)
Arguments
ResourceType |
[required] Specifies the type of resource you are tagging. The |
ResourceId |
[required] The resource ID you want to tag. Use the ID of the resource. Here are some examples:
For the
The |
Tags |
[required] One or more tags. The value parameter is required. Don't enter personally identifiable information in this field. |
Associates a related item to a Systems Manager OpsCenter OpsItem
Description
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.
See https://www.paws-r-sdk.com/docs/ssm_associate_ops_item_related_item/ for full documentation.
Usage
ssm_associate_ops_item_related_item(
OpsItemId,
AssociationType,
ResourceType,
ResourceUri
)
Arguments
OpsItemId |
[required] The ID of the OpsItem to which you want to associate a resource as a related item. |
AssociationType |
[required] The type of association that you want to create between an OpsItem and a
resource. OpsCenter supports |
ResourceType |
[required] The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:
|
ResourceUri |
[required] The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem. |
Attempts to cancel the command specified by the Command ID
Description
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
See https://www.paws-r-sdk.com/docs/ssm_cancel_command/ for full documentation.
Usage
ssm_cancel_command(CommandId, InstanceIds = NULL)
Arguments
CommandId |
[required] The ID of the command you want to cancel. |
InstanceIds |
(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested. |
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running
Description
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
See https://www.paws-r-sdk.com/docs/ssm_cancel_maintenance_window_execution/ for full documentation.
Usage
ssm_cancel_maintenance_window_execution(WindowExecutionId)
Arguments
WindowExecutionId |
[required] The ID of the maintenance window execution to stop. |
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager
Description
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.
See https://www.paws-r-sdk.com/docs/ssm_create_activation/ for full documentation.
Usage
ssm_create_activation(
Description = NULL,
DefaultInstanceName = NULL,
IamRole,
RegistrationLimit = NULL,
ExpirationDate = NULL,
Tags = NULL,
RegistrationMetadata = NULL
)
Arguments
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. |
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. |
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
permissions for the Amazon Web Services Systems Manager service
principal You can't specify an IAM service-linked role for this parameter. You must create a unique role. |
RegistrationLimit |
Specify the maximum number of managed nodes you want to register. The
default value is |
ExpirationDate |
The date by which this activation request should expire, in timestamp format, such as "2024-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours. |
Tags |
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to 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:
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
node ID. This means they are listed in the Amazon Web Services Systems
Manager console with an ID that is prefixed with "mi-". For information
about how to add tags to your managed nodes, see
|
RegistrationMetadata |
Reserved for internal use. |
A State Manager association defines the state that you want to maintain on your managed nodes
Description
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
See https://www.paws-r-sdk.com/docs/ssm_create_association/ for full documentation.
Usage
ssm_create_association(
Name,
DocumentVersion = NULL,
InstanceId = NULL,
Parameters = NULL,
Targets = NULL,
ScheduleExpression = NULL,
OutputLocation = NULL,
AssociationName = NULL,
AutomationTargetParameterName = NULL,
MaxErrors = NULL,
MaxConcurrency = NULL,
ComplianceSeverity = NULL,
SyncCompliance = NULL,
ApplyOnlyAtCronInterval = NULL,
CalendarNames = NULL,
TargetLocations = NULL,
ScheduleOffset = NULL,
Duration = NULL,
TargetMaps = NULL,
Tags = NULL,
AlarmConfiguration = NULL
)
Arguments
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 Amazon Web Services 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:
For example:
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name. For
example, |
DocumentVersion |
The document version you want to associate with the targets. 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 |
InstanceId |
The managed node ID.
|
Parameters |
The parameters for the runtime configuration of the document. |
Targets |
The targets for the association. You can target managed nodes by using
tags, Amazon Web Services resource groups, all managed nodes in an
Amazon Web Services account, or individual managed node IDs. You can
target all managed nodes in an Amazon Web Services account by specifying
the |
ScheduleExpression |
A cron expression when the association will be applied to the targets. |
OutputLocation |
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request. |
AssociationName |
Specify a descriptive name for the association. |
AutomationTargetParameterName |
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager. |
MaxErrors |
The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify
either an absolute number of errors, for example 10, or a percentage of
the target set, for example 10%. If you specify 3, for example, the
system stops sending requests when the fourth error is received. If you
specify 0, then the system stops sending requests after the first error
is returned. If you run an association on 50 managed nodes and set
Executions that are already running an association when |
MaxConcurrency |
The maximum number of targets allowed to run the association at the same 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 |
ComplianceSeverity |
The severity level to assign to the association. |
SyncCompliance |
The mode for generating association compliance. You can specify In By default, all associations use |
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 specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. |
CalendarNames |
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar. |
TargetLocations |
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts. |
ScheduleOffset |
Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of
To use offsets, you must specify the |
Duration |
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. The
|
TargetMaps |
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together. |
Tags |
Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. |
AlarmConfiguration |
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets
Description
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
See https://www.paws-r-sdk.com/docs/ssm_create_association_batch/ for full documentation.
Usage
ssm_create_association_batch(Entries)
Arguments
Entries |
[required] One or more associations. |
Creates a Amazon Web Services Systems Manager (SSM document)
Description
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
See https://www.paws-r-sdk.com/docs/ssm_create_document/ for full documentation.
Usage
ssm_create_document(
Content,
Requires = NULL,
Attachments = NULL,
Name,
DisplayName = NULL,
VersionName = NULL,
DocumentType = NULL,
DocumentFormat = NULL,
TargetType = NULL,
Tags = NULL
)
Arguments
Content |
[required] The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. 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. |
Requires |
A list of SSM documents required by a document. This parameter is used
exclusively by AppConfig. When a user creates an AppConfig configuration
in an SSM document, the user must also specify a required document for
validation purposes. In this case, an |
Attachments |
A list of key-value pairs that describe attachments to a version of a document. |
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:
|
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
can update this value at a later time using the
|
VersionName |
An optional field specifying the version of the artifact you are
creating with the document. For example, |
DocumentType |
The type of document to create. The |
DocumentFormat |
Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format. |
TargetType |
Specify a target type to define the kinds of resources the document can
run on. For example, to run a document on EC2 instances, specify the
following value: |
Tags |
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or 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:
To add tags to an existing SSM document, use the
|
Creates a new maintenance window
Description
Creates a new maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_create_maintenance_window/ for full documentation.
Usage
ssm_create_maintenance_window(
Name,
Description = NULL,
StartDate = NULL,
EndDate = NULL,
Schedule,
ScheduleTimezone = NULL,
ScheduleOffset = NULL,
Duration,
Cutoff,
AllowUnassociatedTargets,
ClientToken = NULL,
Tags = NULL
)
Arguments
Name |
[required] The name of the maintenance window. |
Description |
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows. |
StartDate |
The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become active. When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. |
EndDate |
The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become inactive. |
Schedule |
[required] The schedule of the maintenance window in the form of a cron or rate expression. |
ScheduleTimezone |
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. |
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.
If the schedule offset is |
Duration |
[required] The duration of the maintenance window in hours. |
Cutoff |
[required] The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution. |
AllowUnassociatedTargets |
[required] Enables a maintenance window task to run on managed nodes, even if you 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. |
ClientToken |
User-provided idempotency token. |
Tags |
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to 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:
To add tags to an existing maintenance window, use the
|
Creates a new OpsItem
Description
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
See https://www.paws-r-sdk.com/docs/ssm_create_ops_item/ for full documentation.
Usage
ssm_create_ops_item(
Description,
OpsItemType = NULL,
OperationalData = NULL,
Notifications = NULL,
Priority = NULL,
RelatedOpsItems = NULL,
Source,
Title,
Tags = NULL,
Category = NULL,
Severity = NULL,
ActualStartTime = NULL,
ActualEndTime = NULL,
PlannedStartTime = NULL,
PlannedEndTime = NULL,
AccountId = NULL
)
Arguments
Description |
[required] User-defined text that contains information about the OpsItem, in Markdown format. Provide enough information so that users viewing this OpsItem for the first time understand the issue. |
OpsItemType |
The type of OpsItem to create. Systems Manager supports the following types of OpsItems:
|
OperationalData |
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: 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
Use the |
Notifications |
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed. |
Priority |
The importance of this OpsItem in relation to other OpsItems in the system. |
RelatedOpsItems |
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. |
Source |
[required] The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The source name can't contain the following strings: |
Title |
[required] A short heading that describes the nature of the OpsItem and the impacted resource. |
Tags |
Optional metadata that you assign to a resource. Tags use a key-value pair. For example:
To add tags to a new OpsItem, a user must have IAM permissions for both
the |
Category |
Specify a category to assign to an OpsItem. |
Severity |
Specify a severity to assign to an OpsItem. |
ActualStartTime |
The time a runbook workflow started. Currently reported only for the
OpsItem type |
ActualEndTime |
The time a runbook workflow ended. Currently reported only for the
OpsItem type |
PlannedStartTime |
The time specified in a change request for a runbook workflow to start.
Currently supported only for the OpsItem type |
PlannedEndTime |
The time specified in a change request for a runbook workflow to end.
Currently supported only for the OpsItem type |
AccountId |
The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide. |
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type
Description
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
See https://www.paws-r-sdk.com/docs/ssm_create_ops_metadata/ for full documentation.
Usage
ssm_create_ops_metadata(ResourceId, Metadata = NULL, Tags = NULL)
Arguments
ResourceId |
[required] A resource ID for a new Application Manager application. |
Metadata |
Metadata for a new Application Manager application. |
Tags |
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or 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:
|
Creates a patch baseline
Description
Creates a patch baseline.
See https://www.paws-r-sdk.com/docs/ssm_create_patch_baseline/ for full documentation.
Usage
ssm_create_patch_baseline(
OperatingSystem = NULL,
Name,
GlobalFilters = NULL,
ApprovalRules = NULL,
ApprovedPatches = NULL,
ApprovedPatchesComplianceLevel = NULL,
ApprovedPatchesEnableNonSecurity = NULL,
RejectedPatches = NULL,
RejectedPatchesAction = NULL,
Description = NULL,
Sources = NULL,
ClientToken = NULL,
Tags = NULL
)
Arguments
OperatingSystem |
Defines the operating system the patch baseline applies to. The default
value is |
Name |
[required] The name of the patch baseline. |
GlobalFilters |
A set of global filters used to include patches in the baseline. The |
ApprovalRules |
A set of rules used to include patches in the baseline. |
ApprovedPatches |
A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide. |
ApprovedPatchesComplianceLevel |
Defines the compliance level for approved patches. When an approved
patch is reported as missing, this value describes the severity of the
compliance violation. The default value is |
ApprovedPatchesEnableNonSecurity |
Indicates whether the list of approved patches includes non-security
updates that should be applied to the managed nodes. The default value
is |
RejectedPatches |
A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide. |
RejectedPatchesAction |
The action for Patch Manager to take on patches included in the
ALLOW_AS_DEPENDENCY Linux and macOS: 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
Windows Server: Windows Server doesn't support the concept of
package dependencies. If a package in the rejected patches list and
already installed on the node, its status is reported as
BLOCK All OSs: Packages in the rejected patches list, and packages that
include them as dependencies, aren't installed by Patch Manager under
any circumstances. If a package was installed before it was added to the
rejected patches list, or is installed outside of Patch Manager
afterward, it's considered noncompliant with the patch baseline and its
status is reported as |
Description |
A description of the patch baseline. |
Sources |
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only. |
ClientToken |
User-provided idempotency token. |
Tags |
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to 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:
To add tags to an existing patch baseline, use the
|
A resource data sync helps you view data from multiple sources in a single location
Description
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.
See https://www.paws-r-sdk.com/docs/ssm_create_resource_data_sync/ for full documentation.
Usage
ssm_create_resource_data_sync(
SyncName,
S3Destination = NULL,
SyncType = NULL,
SyncSource = NULL
)
Arguments
SyncName |
[required] A name for the configuration. |
S3Destination |
Amazon S3 configuration details for the sync. This parameter is required
if the |
SyncType |
Specify |
SyncSource |
Specify information about the data sources to synchronize. This
parameter is required if the |
Deletes an activation
Description
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
See https://www.paws-r-sdk.com/docs/ssm_delete_activation/ for full documentation.
Usage
ssm_delete_activation(ActivationId)
Arguments
ActivationId |
[required] The ID of the activation that you want to delete. |
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node
Description
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID.
See https://www.paws-r-sdk.com/docs/ssm_delete_association/ for full documentation.
Usage
ssm_delete_association(Name = NULL, InstanceId = NULL, AssociationId = NULL)
Arguments
Name |
The name of the SSM document. |
InstanceId |
The managed node ID.
|
AssociationId |
The association ID that you want to delete. |
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document
Description
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
See https://www.paws-r-sdk.com/docs/ssm_delete_document/ for full documentation.
Usage
ssm_delete_document(
Name,
DocumentVersion = NULL,
VersionName = NULL,
Force = NULL
)
Arguments
Name |
[required] The name of the document. |
DocumentVersion |
The version of the document that you want to delete. If not provided, all versions of the document are deleted. |
VersionName |
The version name of the document that you want to delete. If not provided, all versions of the document are deleted. |
Force |
Some SSM document types require that you specify a |
Delete a custom inventory type or the data associated with a custom Inventory type
Description
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
See https://www.paws-r-sdk.com/docs/ssm_delete_inventory/ for full documentation.
Usage
ssm_delete_inventory(
TypeName,
SchemaDeleteOption = NULL,
DryRun = NULL,
ClientToken = NULL
)
Arguments
TypeName |
[required] The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself. |
SchemaDeleteOption |
Use the 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
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want. |
DryRun |
Use this option to view a summary of the deletion request without
deleting any data or the data type. This option is useful when you only
want to understand what will be deleted. Once you validate that the data
to be deleted is what you intend to delete, you can run the same command
without specifying the |
ClientToken |
User-provided idempotency token. |
Deletes a maintenance window
Description
Deletes a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_delete_maintenance_window/ for full documentation.
Usage
ssm_delete_maintenance_window(WindowId)
Arguments
WindowId |
[required] The ID of the maintenance window to delete. |
Delete an OpsItem
Description
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
See https://www.paws-r-sdk.com/docs/ssm_delete_ops_item/ for full documentation.
Usage
ssm_delete_ops_item(OpsItemId)
Arguments
OpsItemId |
[required] The ID of the OpsItem that you want to delete. |
Delete OpsMetadata related to an application
Description
Delete OpsMetadata related to an application.
See https://www.paws-r-sdk.com/docs/ssm_delete_ops_metadata/ for full documentation.
Usage
ssm_delete_ops_metadata(OpsMetadataArn)
Arguments
OpsMetadataArn |
[required] The Amazon Resource Name (ARN) of an OpsMetadata Object to delete. |
Delete a parameter from the system
Description
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
See https://www.paws-r-sdk.com/docs/ssm_delete_parameter/ for full documentation.
Usage
ssm_delete_parameter(Name)
Arguments
Name |
[required] The name of the parameter to delete. You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. |
Delete a list of parameters
Description
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
See https://www.paws-r-sdk.com/docs/ssm_delete_parameters/ for full documentation.
Usage
ssm_delete_parameters(Names)
Arguments
Names |
[required] The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. |
Deletes a patch baseline
Description
Deletes a patch baseline.
See https://www.paws-r-sdk.com/docs/ssm_delete_patch_baseline/ for full documentation.
Usage
ssm_delete_patch_baseline(BaselineId)
Arguments
BaselineId |
[required] The ID of the patch baseline to delete. |
Deletes a resource data sync configuration
Description
Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
See https://www.paws-r-sdk.com/docs/ssm_delete_resource_data_sync/ for full documentation.
Usage
ssm_delete_resource_data_sync(SyncName, SyncType = NULL)
Arguments
SyncName |
[required] The name of the configuration to delete. |
SyncType |
Specify the type of resource data sync to delete. |
Deletes a Systems Manager resource policy
Description
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
See https://www.paws-r-sdk.com/docs/ssm_delete_resource_policy/ for full documentation.
Usage
ssm_delete_resource_policy(ResourceArn, PolicyId, PolicyHash)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the resource to which the policies are attached. |
PolicyId |
[required] The policy ID. |
PolicyHash |
[required] ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy. |
Removes the server or virtual machine from the list of registered servers
Description
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
See https://www.paws-r-sdk.com/docs/ssm_deregister_managed_instance/ for full documentation.
Usage
ssm_deregister_managed_instance(InstanceId)
Arguments
InstanceId |
[required] The ID assigned to the managed node when you registered it using the activation process. |
Removes a patch group from a patch baseline
Description
Removes a patch group from a patch baseline.
See https://www.paws-r-sdk.com/docs/ssm_deregister_patch_baseline_for_patch_group/ for full documentation.
Usage
ssm_deregister_patch_baseline_for_patch_group(BaselineId, PatchGroup)
Arguments
BaselineId |
[required] The ID of the patch baseline to deregister the patch group from. |
PatchGroup |
[required] The name of the patch group that should be deregistered from the patch baseline. |
Removes a target from a maintenance window
Description
Removes a target from a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_deregister_target_from_maintenance_window/ for full documentation.
Usage
ssm_deregister_target_from_maintenance_window(
WindowId,
WindowTargetId,
Safe = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window the target should be removed from. |
WindowTargetId |
[required] The ID of the target definition to remove. |
Safe |
The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window. |
Removes a task from a maintenance window
Description
Removes a task from a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_deregister_task_from_maintenance_window/ for full documentation.
Usage
ssm_deregister_task_from_maintenance_window(WindowId, WindowTaskId)
Arguments
WindowId |
[required] The ID of the maintenance window the task should be removed from. |
WindowTaskId |
[required] The ID of the task to remove from the maintenance window. |
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation
Description
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
See https://www.paws-r-sdk.com/docs/ssm_describe_activations/ for full documentation.
Usage
ssm_describe_activations(Filters = NULL, MaxResults = NULL, NextToken = NULL)
Arguments
Filters |
A filter to view information about your activations. |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Describes the association for the specified target or managed node
Description
Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.
See https://www.paws-r-sdk.com/docs/ssm_describe_association/ for full documentation.
Usage
ssm_describe_association(
Name = NULL,
InstanceId = NULL,
AssociationId = NULL,
AssociationVersion = NULL
)
Arguments
Name |
The name of the SSM document. |
InstanceId |
The managed node ID. |
AssociationId |
The association ID for which you want information. |
AssociationVersion |
Specify the association version to retrieve. To view the latest version,
either specify |
Views information about a specific execution of a specific association
Description
Views information about a specific execution of a specific association.
See https://www.paws-r-sdk.com/docs/ssm_describe_association_execution_targets/ for full documentation.
Usage
ssm_describe_association_execution_targets(
AssociationId,
ExecutionId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AssociationId |
[required] The association ID that includes the execution for which you want to view details. |
ExecutionId |
[required] The execution ID for which you want to view details. |
Filters |
Filters for the request. You can specify the following filters and values. Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Views all executions for a specific association ID
Description
Views all executions for a specific association ID.
See https://www.paws-r-sdk.com/docs/ssm_describe_association_executions/ for full documentation.
Usage
ssm_describe_association_executions(
AssociationId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AssociationId |
[required] The association ID for which you want to view execution history details. |
Filters |
Filters for the request. You can specify the following filters and values. ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Provides details about all active and terminated Automation executions
Description
Provides details about all active and terminated Automation executions.
See https://www.paws-r-sdk.com/docs/ssm_describe_automation_executions/ for full documentation.
Usage
ssm_describe_automation_executions(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
Filters used to limit the scope of executions that are requested. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Information about all active and terminated step executions in an Automation workflow
Description
Information about all active and terminated step executions in an Automation workflow.
See https://www.paws-r-sdk.com/docs/ssm_describe_automation_step_executions/ for full documentation.
Usage
ssm_describe_automation_step_executions(
AutomationExecutionId,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL,
ReverseOrder = NULL
)
Arguments
AutomationExecutionId |
[required] The Automation execution ID for which you want step execution descriptions. |
Filters |
One or more filters to limit the number of step executions returned by the request. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
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 next set of results. |
ReverseOrder |
Indicates whether to list step executions in reverse order by start time. The default value is 'false'. |
Lists all patches eligible to be included in a patch baseline
Description
Lists all patches eligible to be included in a patch baseline.
See https://www.paws-r-sdk.com/docs/ssm_describe_available_patches/ for full documentation.
Usage
ssm_describe_available_patches(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
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:
Linux When specifying filters for Linux patches, you must specify a key-pair
for
However, the following command succeeds:
Supported keys for Linux managed node patches include the following:
|
MaxResults |
The maximum number of patches to return (per page). |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Describes the specified Amazon Web Services Systems Manager document (SSM document)
Description
Describes the specified Amazon Web Services Systems Manager document (SSM document).
See https://www.paws-r-sdk.com/docs/ssm_describe_document/ for full documentation.
Usage
ssm_describe_document(Name, DocumentVersion = NULL, VersionName = NULL)
Arguments
Name |
[required] The name of the SSM document. |
DocumentVersion |
The document version for which you want information. Can be a specific version or the default version. |
VersionName |
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed. |
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document)
Description
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
See https://www.paws-r-sdk.com/docs/ssm_describe_document_permission/ for full documentation.
Usage
ssm_describe_document_permission(
Name,
PermissionType,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Name |
[required] The name of the document for which you are the owner. |
PermissionType |
[required] The permission type for the document. The permission type can be Share. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
All associations for the managed nodes
Description
All associations for the managed nodes.
See https://www.paws-r-sdk.com/docs/ssm_describe_effective_instance_associations/ for full documentation.
Usage
ssm_describe_effective_instance_associations(
InstanceId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
InstanceId |
[required] The managed node ID for which you want to view all associations. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline
Description
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
See https://www.paws-r-sdk.com/docs/ssm_describe_effective_patches_for_patch_baseline/ for full documentation.
Usage
ssm_describe_effective_patches_for_patch_baseline(
BaselineId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
BaselineId |
[required] The ID of the patch baseline to retrieve the effective patches for. |
MaxResults |
The maximum number of patches to return (per page). |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
The status of the associations for the managed nodes
Description
The status of the associations for the managed nodes.
See https://www.paws-r-sdk.com/docs/ssm_describe_instance_associations_status/ for full documentation.
Usage
ssm_describe_instance_associations_status(
InstanceId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
InstanceId |
[required] The managed node IDs for which you want association status information. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address
Description
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
See https://www.paws-r-sdk.com/docs/ssm_describe_instance_information/ for full documentation.
Usage
ssm_describe_instance_information(
InstanceInformationFilterList = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
InstanceInformationFilterList |
This is a legacy method. We recommend that you don't use this method.
Instead, use the Attempting to use |
Filters |
One or more filters. Use a filter to return a more specific list of
managed nodes. You can filter based on tags applied to your managed
nodes. Tag filters can't be combined with other filter types. Use this
|
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 next set of results. The default value is 10 items. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Retrieves the high-level patch state of one or more managed nodes
Description
Retrieves the high-level patch state of one or more managed nodes.
See https://www.paws-r-sdk.com/docs/ssm_describe_instance_patch_states/ for full documentation.
Usage
ssm_describe_instance_patch_states(
InstanceIds,
NextToken = NULL,
MaxResults = NULL
)
Arguments
InstanceIds |
[required] The ID of the managed node for which patch state information should be retrieved. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxResults |
The maximum number of managed nodes to return (per page). |
Retrieves the high-level patch state for the managed nodes in the specified patch group
Description
Retrieves the high-level patch state for the managed nodes in the specified patch group.
See https://www.paws-r-sdk.com/docs/ssm_describe_instance_patch_states_for_patch_group/ for full documentation.
Usage
ssm_describe_instance_patch_states_for_patch_group(
PatchGroup,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
PatchGroup |
[required] The name of the patch group for which the patch state information should be retrieved. |
Filters |
Each entry in the array is a structure containing:
|
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxResults |
The maximum number of patches to return (per page). |
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node
Description
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
See https://www.paws-r-sdk.com/docs/ssm_describe_instance_patches/ for full documentation.
Usage
ssm_describe_instance_patches(
InstanceId,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
InstanceId |
[required] The ID of the managed node whose patch state information should be retrieved. |
Filters |
Each element in the array is a structure containing a key-value pair. Supported keys for
|
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
MaxResults |
The maximum number of patches to return (per page). |
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes
Description
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
See https://www.paws-r-sdk.com/docs/ssm_describe_instance_properties/ for full documentation.
Usage
ssm_describe_instance_properties(
InstancePropertyFilterList = NULL,
FiltersWithOperator = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
InstancePropertyFilterList |
An array of instance property filters. |
FiltersWithOperator |
The request filters to use with the operator. |
MaxResults |
The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results. |
NextToken |
The token provided by a previous request to use to return the next set of properties. |
Describes a specific delete inventory operation
Description
Describes a specific delete inventory operation.
See https://www.paws-r-sdk.com/docs/ssm_describe_inventory_deletions/ for full documentation.
Usage
ssm_describe_inventory_deletions(
DeletionId = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
DeletionId |
Specify the delete inventory ID for which you want information. This ID
was returned by the |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution
Description
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_window_execution_task_invocations/ for full documentation.
Usage
ssm_describe_maintenance_window_execution_task_invocations(
WindowExecutionId,
TaskId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
WindowExecutionId |
[required] The ID of the maintenance window execution the task is part of. |
TaskId |
[required] The ID of the specific task in the maintenance window task that should be retrieved. |
Filters |
Optional filters used to scope down the returned task invocations. The
supported filter key is |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
For a given maintenance window execution, lists the tasks that were run
Description
For a given maintenance window execution, lists the tasks that were run.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_window_execution_tasks/ for full documentation.
Usage
ssm_describe_maintenance_window_execution_tasks(
WindowExecutionId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
WindowExecutionId |
[required] The ID of the maintenance window execution whose task executions should be retrieved. |
Filters |
Optional filters used to scope down the returned tasks. The supported
filter key is |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Lists the executions of a maintenance window
Description
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_window_executions/ for full documentation.
Usage
ssm_describe_maintenance_window_executions(
WindowId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window whose executions should be retrieved. |
Filters |
Each entry in the array is a structure containing:
|
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Retrieves information about upcoming executions of a maintenance window
Description
Retrieves information about upcoming executions of a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_window_schedule/ for full documentation.
Usage
ssm_describe_maintenance_window_schedule(
WindowId = NULL,
Targets = NULL,
ResourceType = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
WindowId |
The ID of the maintenance window to retrieve information about. |
Targets |
The managed node ID or key-value pair to retrieve information about. |
ResourceType |
The type of resource you want to retrieve information about. For
example, |
Filters |
Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Lists the targets registered with the maintenance window
Description
Lists the targets registered with the maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_window_targets/ for full documentation.
Usage
ssm_describe_maintenance_window_targets(
WindowId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window whose targets should be retrieved. |
Filters |
Optional filters that can be used to narrow down the scope of the
returned window targets. The supported filter keys are |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Lists the tasks in a maintenance window
Description
Lists the tasks in a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_window_tasks/ for full documentation.
Usage
ssm_describe_maintenance_window_tasks(
WindowId,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window whose tasks should be retrieved. |
Filters |
Optional filters used to narrow down the scope of the returned tasks.
The supported filter keys are |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Retrieves the maintenance windows in an Amazon Web Services account
Description
Retrieves the maintenance windows in an Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_windows/ for full documentation.
Usage
ssm_describe_maintenance_windows(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
Optional filters used to narrow down the scope of the returned
maintenance windows. Supported filter keys are |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Retrieves information about the maintenance window targets or tasks that a managed node is associated with
Description
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
See https://www.paws-r-sdk.com/docs/ssm_describe_maintenance_windows_for_target/ for full documentation.
Usage
ssm_describe_maintenance_windows_for_target(
Targets,
ResourceType,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Targets |
[required] The managed node ID or key-value pair to retrieve information about. |
ResourceType |
[required] The type of resource you want to retrieve information about. For
example, |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Query a set of OpsItems
Description
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
See https://www.paws-r-sdk.com/docs/ssm_describe_ops_items/ for full documentation.
Usage
ssm_describe_ops_items(
OpsItemFilters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
OpsItemFilters |
One or more filters to limit the response.
*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"} |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option
Description
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
See https://www.paws-r-sdk.com/docs/ssm_describe_parameters/ for full documentation.
Usage
ssm_describe_parameters(
Filters = NULL,
ParameterFilters = NULL,
MaxResults = NULL,
NextToken = NULL,
Shared = NULL
)
Arguments
Filters |
This data type is deprecated. Instead, use |
ParameterFilters |
Filters to limit the request results. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Shared |
Lists parameters that are shared with you. By default when using this option, the command returns parameters that
have been shared using a standard Resource Access Manager Resource
Share. In order for a parameter that was shared using the
For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide. |
Lists the patch baselines in your Amazon Web Services account
Description
Lists the patch baselines in your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/ssm_describe_patch_baselines/ for full documentation.
Usage
ssm_describe_patch_baselines(
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Filters |
Each element in the array is a structure containing a key-value pair. Supported keys for
|
MaxResults |
The maximum number of patch baselines to return (per page). |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Returns high-level aggregated patch compliance state information for a patch group
Description
Returns high-level aggregated patch compliance state information for a patch group.
See https://www.paws-r-sdk.com/docs/ssm_describe_patch_group_state/ for full documentation.
Usage
ssm_describe_patch_group_state(PatchGroup)
Arguments
PatchGroup |
[required] The name of the patch group whose patch snapshot should be retrieved. |
Lists all patch groups that have been registered with patch baselines
Description
Lists all patch groups that have been registered with patch baselines.
See https://www.paws-r-sdk.com/docs/ssm_describe_patch_groups/ for full documentation.
Usage
ssm_describe_patch_groups(MaxResults = NULL, Filters = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of patch groups to return (per page). |
Filters |
Each element in the array is a structure containing a key-value pair. Supported keys for
|
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches
Description
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as create_patch_baseline, update_patch_baseline, describe_available_patches, and describe_patch_baselines.
See https://www.paws-r-sdk.com/docs/ssm_describe_patch_properties/ for full documentation.
Usage
ssm_describe_patch_properties(
OperatingSystem,
Property,
PatchSet = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
OperatingSystem |
[required] The operating system type for which to list patches. |
Property |
[required] The patch property for which you want to view patch details. |
PatchSet |
Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days
Description
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
See https://www.paws-r-sdk.com/docs/ssm_describe_sessions/ for full documentation.
Usage
ssm_describe_sessions(
State,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
State |
[required] The session status to retrieve a list of sessions for. For example, "Active". |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Filters |
One or more filters to limit the type of sessions returned by the request. |
Deletes the association between an OpsItem and a related item
Description
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.
See https://www.paws-r-sdk.com/docs/ssm_disassociate_ops_item_related_item/ for full documentation.
Usage
ssm_disassociate_ops_item_related_item(OpsItemId, AssociationId)
Arguments
OpsItemId |
[required] The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item. |
AssociationId |
[required] The ID of the association for which you want to delete an association between the OpsItem and a related item. |
Get detailed information about a particular Automation execution
Description
Get detailed information about a particular Automation execution.
See https://www.paws-r-sdk.com/docs/ssm_get_automation_execution/ for full documentation.
Usage
ssm_get_automation_execution(AutomationExecutionId)
Arguments
AutomationExecutionId |
[required] The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated. |
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time
Description
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, get_calendar_state returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, get_calendar_state uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.
See https://www.paws-r-sdk.com/docs/ssm_get_calendar_state/ for full documentation.
Usage
ssm_get_calendar_state(CalendarNames, AtTime = NULL)
Arguments
CalendarNames |
[required] The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state. |
AtTime |
(Optional) The specific time for which you want to get calendar state
information, in ISO 8601
format. If you don't specify a value or |
Returns detailed information about command execution for an invocation or plugin
Description
Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.
See https://www.paws-r-sdk.com/docs/ssm_get_command_invocation/ for full documentation.
Usage
ssm_get_command_invocation(CommandId, InstanceId, PluginName = NULL)
Arguments
CommandId |
[required] (Required) The parent command ID of the invocation plugin. |
InstanceId |
[required] (Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager. |
PluginName |
The name of the step for which you want detailed results. If the
document contains only one step, you can omit the name and details for
that step. If the document contains more than one step, you must specify
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
To find the |
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections
Description
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
See https://www.paws-r-sdk.com/docs/ssm_get_connection_status/ for full documentation.
Usage
ssm_get_connection_status(Target)
Arguments
Target |
[required] The managed node ID. |
Retrieves the default patch baseline
Description
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
See https://www.paws-r-sdk.com/docs/ssm_get_default_patch_baseline/ for full documentation.
Usage
ssm_get_default_patch_baseline(OperatingSystem = NULL)
Arguments
OperatingSystem |
Returns the default patch baseline for the specified operating system. |
Retrieves the current snapshot for the patch baseline the managed node uses
Description
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).
See https://www.paws-r-sdk.com/docs/ssm_get_deployable_patch_snapshot_for_instance/ for full documentation.
Usage
ssm_get_deployable_patch_snapshot_for_instance(
InstanceId,
SnapshotId,
BaselineOverride = NULL
)
Arguments
InstanceId |
[required] The ID of the managed node for which the appropriate patch snapshot should be retrieved. |
SnapshotId |
[required] The snapshot ID provided by the user when running
|
BaselineOverride |
Defines the basic information about a patch baseline override. |
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document)
Description
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
See https://www.paws-r-sdk.com/docs/ssm_get_document/ for full documentation.
Usage
ssm_get_document(
Name,
VersionName = NULL,
DocumentVersion = NULL,
DocumentFormat = NULL
)
Arguments
Name |
[required] The name of the SSM document. |
VersionName |
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed. |
DocumentVersion |
The document version for which you want information. |
DocumentFormat |
Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format. |
Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources
Description
Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.
See https://www.paws-r-sdk.com/docs/ssm_get_execution_preview/ for full documentation.
Usage
ssm_get_execution_preview(ExecutionPreviewId)
Arguments
ExecutionPreviewId |
[required] The ID of the existing execution preview. |
Query inventory information
Description
Query inventory information. This includes managed node status, such as Stopped or Terminated.
See https://www.paws-r-sdk.com/docs/ssm_get_inventory/ for full documentation.
Usage
ssm_get_inventory(
Filters = NULL,
Aggregators = NULL,
ResultAttributes = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filters |
One or more filters. Use a filter to return a more specific list of results. |
Aggregators |
Returns counts of inventory types based on one or more expressions. For
example, if you aggregate by using an expression that uses the
|
ResultAttributes |
The list of inventory item types to return. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
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 next set of results. |
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type
Description
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
See https://www.paws-r-sdk.com/docs/ssm_get_inventory_schema/ for full documentation.
Usage
ssm_get_inventory_schema(
TypeName = NULL,
NextToken = NULL,
MaxResults = NULL,
Aggregator = NULL,
SubType = NULL
)
Arguments
TypeName |
The type of inventory item to return. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
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 next set of results. |
Aggregator |
Returns inventory schemas that support aggregation. For example, this
call returns the |
SubType |
Returns the sub-type schema for a specified inventory type. |
Retrieves a maintenance window
Description
Retrieves a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_get_maintenance_window/ for full documentation.
Usage
ssm_get_maintenance_window(WindowId)
Arguments
WindowId |
[required] The ID of the maintenance window for which you want to retrieve information. |
Retrieves details about a specific a maintenance window execution
Description
Retrieves details about a specific a maintenance window execution.
See https://www.paws-r-sdk.com/docs/ssm_get_maintenance_window_execution/ for full documentation.
Usage
ssm_get_maintenance_window_execution(WindowExecutionId)
Arguments
WindowExecutionId |
[required] The ID of the maintenance window execution that includes the task. |
Retrieves the details about a specific task run as part of a maintenance window execution
Description
Retrieves the details about a specific task run as part of a maintenance window execution.
See https://www.paws-r-sdk.com/docs/ssm_get_maintenance_window_execution_task/ for full documentation.
Usage
ssm_get_maintenance_window_execution_task(WindowExecutionId, TaskId)
Arguments
WindowExecutionId |
[required] The ID of the maintenance window execution that includes the task. |
TaskId |
[required] The ID of the specific task execution in the maintenance window task that should be retrieved. |
Retrieves information about a specific task running on a specific target
Description
Retrieves information about a specific task running on a specific target.
See https://www.paws-r-sdk.com/docs/ssm_get_maintenance_window_execution_task_invocation/ for full documentation.
Usage
ssm_get_maintenance_window_execution_task_invocation(
WindowExecutionId,
TaskId,
InvocationId
)
Arguments
WindowExecutionId |
[required] The ID of the maintenance window execution for which the task is a part. |
TaskId |
[required] The ID of the specific task in the maintenance window task that should be retrieved. |
InvocationId |
[required] The invocation ID to retrieve. |
Retrieves the details of a maintenance window task
Description
Retrieves the details of a maintenance window task.
See https://www.paws-r-sdk.com/docs/ssm_get_maintenance_window_task/ for full documentation.
Usage
ssm_get_maintenance_window_task(WindowId, WindowTaskId)
Arguments
WindowId |
[required] The maintenance window ID that includes the task to retrieve. |
WindowTaskId |
[required] The maintenance window task ID to retrieve. |
Get information about an OpsItem by using the ID
Description
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
See https://www.paws-r-sdk.com/docs/ssm_get_ops_item/ for full documentation.
Usage
ssm_get_ops_item(OpsItemId, OpsItemArn = NULL)
Arguments
OpsItemId |
[required] The ID of the OpsItem that you want to get. |
OpsItemArn |
The OpsItem Amazon Resource Name (ARN). |
View operational metadata related to an application in Application Manager
Description
View operational metadata related to an application in Application Manager.
See https://www.paws-r-sdk.com/docs/ssm_get_ops_metadata/ for full documentation.
Usage
ssm_get_ops_metadata(OpsMetadataArn, MaxResults = NULL, NextToken = NULL)
Arguments
OpsMetadataArn |
[required] The Amazon Resource Name (ARN) of an OpsMetadata Object to view. |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
View a summary of operations metadata (OpsData) based on specified filters and aggregators
Description
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
See https://www.paws-r-sdk.com/docs/ssm_get_ops_summary/ for full documentation.
Usage
ssm_get_ops_summary(
SyncName = NULL,
Filters = NULL,
Aggregators = NULL,
ResultAttributes = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
SyncName |
Specify the name of a resource data sync to get. |
Filters |
Optional filters used to scope down the returned OpsData. |
Aggregators |
Optional aggregators that return counts of OpsData based on one or more expressions. |
ResultAttributes |
The OpsData data type to return. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Get information about a single parameter by specifying the parameter name
Description
Get information about a single parameter by specifying the parameter name.
See https://www.paws-r-sdk.com/docs/ssm_get_parameter/ for full documentation.
Usage
ssm_get_parameter(Name, WithDecryption = NULL)
Arguments
Name |
[required] The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN. To query by parameter label, use For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide. |
WithDecryption |
Return decrypted values for secure string parameters. This flag is
ignored for |
Retrieves the history of all changes to a parameter
Description
Retrieves the history of all changes to a parameter.
See https://www.paws-r-sdk.com/docs/ssm_get_parameter_history/ for full documentation.
Usage
ssm_get_parameter_history(
Name,
WithDecryption = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Name |
[required] The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN. |
WithDecryption |
Return decrypted values for secure string parameters. This flag is
ignored for |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Get information about one or more parameters by specifying multiple parameter names
Description
Get information about one or more parameters by specifying multiple parameter names.
See https://www.paws-r-sdk.com/docs/ssm_get_parameters/ for full documentation.
Usage
ssm_get_parameters(Names, WithDecryption = NULL)
Arguments
Names |
[required] The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs. To query by parameter label, use The results for For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide. |
WithDecryption |
Return decrypted secure string value. Return decrypted values for secure
string parameters. This flag is ignored for |
Retrieve information about one or more parameters under a specified level in a hierarchy
Description
Retrieve information about one or more parameters under a specified level in a hierarchy.
See https://www.paws-r-sdk.com/docs/ssm_get_parameters_by_path/ for full documentation.
Usage
ssm_get_parameters_by_path(
Path,
Recursive = NULL,
ParameterFilters = NULL,
WithDecryption = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Path |
[required] The hierarchy for the parameter. Hierarchies start with a forward slash
(/). The hierarchy is the parameter name except the last part of the
parameter. For the API call to succeed, the last part of the parameter
name can't be in the path. A parameter name hierarchy can have a maximum
of 15 levels. Here is an example of a hierarchy:
|
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 |
ParameterFilters |
Filters to limit the request results. The following The following |
WithDecryption |
Retrieve all parameters in a hierarchy with their value decrypted. |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Retrieves information about a patch baseline
Description
Retrieves information about a patch baseline.
See https://www.paws-r-sdk.com/docs/ssm_get_patch_baseline/ for full documentation.
Usage
ssm_get_patch_baseline(BaselineId)
Arguments
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 |
Retrieves the patch baseline that should be used for the specified patch group
Description
Retrieves the patch baseline that should be used for the specified patch group.
See https://www.paws-r-sdk.com/docs/ssm_get_patch_baseline_for_patch_group/ for full documentation.
Usage
ssm_get_patch_baseline_for_patch_group(PatchGroup, OperatingSystem = NULL)
Arguments
PatchGroup |
[required] The name of the patch group whose patch baseline should be retrieved. |
OperatingSystem |
Returns the operating system rule specified for patch groups using the patch baseline. |
Returns an array of the Policy object
Description
Returns an array of the Policy object.
See https://www.paws-r-sdk.com/docs/ssm_get_resource_policies/ for full documentation.
Usage
ssm_get_resource_policies(ResourceArn, NextToken = NULL, MaxResults = NULL)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the resource to which the policies are attached. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
ServiceSetting is an account-level setting for an Amazon Web Services service
Description
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.
See https://www.paws-r-sdk.com/docs/ssm_get_service_setting/ for full documentation.
Usage
ssm_get_service_setting(SettingId)
Arguments
SettingId |
[required] The ID of the service setting to get. The setting ID can be one of the following.
|
A parameter label is a user-defined alias to help you manage different versions of a parameter
Description
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
See https://www.paws-r-sdk.com/docs/ssm_label_parameter_version/ for full documentation.
Usage
ssm_label_parameter_version(Name, ParameterVersion = NULL, Labels)
Arguments
Name |
[required] The parameter name on which you want to attach one or more labels. You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. |
ParameterVersion |
The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version. |
Labels |
[required] One or more labels to attach to the specified parameter version. |
Retrieves all versions of an association for a specific association ID
Description
Retrieves all versions of an association for a specific association ID.
See https://www.paws-r-sdk.com/docs/ssm_list_association_versions/ for full documentation.
Usage
ssm_list_association_versions(
AssociationId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AssociationId |
[required] The association ID for which you want to view all versions. |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region
Description
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.
See https://www.paws-r-sdk.com/docs/ssm_list_associations/ for full documentation.
Usage
ssm_list_associations(
AssociationFilterList = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AssociationFilterList |
One or more filters. Use a filter to return a more specific list of results. Filtering associations using the |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
An invocation is copy of a command sent to a specific managed node
Description
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs send_command against three managed nodes, then a command invocation is created for each requested managed node ID. list_command_invocations provide status about command execution.
See https://www.paws-r-sdk.com/docs/ssm_list_command_invocations/ for full documentation.
Usage
ssm_list_command_invocations(
CommandId = NULL,
InstanceId = NULL,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL,
Details = NULL
)
Arguments
CommandId |
(Optional) The invocations for a specific command ID. |
InstanceId |
(Optional) The command execution details for a specific managed node ID. |
MaxResults |
(Optional) 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 next set of results. |
NextToken |
(Optional) The token for the next set of items to return. (You received this token from a previous call.) |
Filters |
(Optional) One or more filters. Use a filter to return a more specific list of results. |
Details |
(Optional) If set this returns the response of the command executions
and any command output. The default value is |
Lists the commands requested by users of the Amazon Web Services account
Description
Lists the commands requested by users of the Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/ssm_list_commands/ for full documentation.
Usage
ssm_list_commands(
CommandId = NULL,
InstanceId = NULL,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
CommandId |
(Optional) If provided, lists only the specified command. |
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
|
MaxResults |
(Optional) 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 next set of results. |
NextToken |
(Optional) The token for the next set of items to return. (You received this token from a previous call.) |
Filters |
(Optional) One or more filters. Use a filter to return a more specific list of results. |
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types
Description
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
See https://www.paws-r-sdk.com/docs/ssm_list_compliance_items/ for full documentation.
Usage
ssm_list_compliance_items(
Filters = NULL,
ResourceIds = NULL,
ResourceTypes = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filters |
One or more compliance filters. Use a filter to return a more specific list of results. |
ResourceIds |
The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID. |
ResourceTypes |
The type of resource from which to get compliance information.
Currently, the only supported resource type is |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Returns a summary count of compliant and non-compliant resources for a compliance type
Description
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
See https://www.paws-r-sdk.com/docs/ssm_list_compliance_summaries/ for full documentation.
Usage
ssm_list_compliance_summaries(
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filters |
One or more compliance or inventory filters. Use a filter to return a more specific list of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
MaxResults |
The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. |
Information about approval reviews for a version of a change template in Change Manager
Description
Information about approval reviews for a version of a change template in Change Manager.
See https://www.paws-r-sdk.com/docs/ssm_list_document_metadata_history/ for full documentation.
Usage
ssm_list_document_metadata_history(
Name,
DocumentVersion = NULL,
Metadata,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Name |
[required] The name of the change template. |
DocumentVersion |
The version of the change template. |
Metadata |
[required] The type of data for which details are being requested. Currently, the
only supported value is |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
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 next set of results. |
List all versions for a document
Description
List all versions for a document.
See https://www.paws-r-sdk.com/docs/ssm_list_document_versions/ for full documentation.
Usage
ssm_list_document_versions(Name, MaxResults = NULL, NextToken = NULL)
Arguments
Name |
[required] The name of the document. You can specify an Amazon Resource Name (ARN). |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region
Description
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
See https://www.paws-r-sdk.com/docs/ssm_list_documents/ for full documentation.
Usage
ssm_list_documents(
DocumentFilterList = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
DocumentFilterList |
This data type is deprecated. Instead, use |
Filters |
One or more This API operation only supports filtering documents by using a single
tag key and one or more tag values. For example:
|
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
A list of inventory items returned by the request
Description
A list of inventory items returned by the request.
See https://www.paws-r-sdk.com/docs/ssm_list_inventory_entries/ for full documentation.
Usage
ssm_list_inventory_entries(
InstanceId,
TypeName,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
InstanceId |
[required] The managed node ID for which you want inventory information. |
TypeName |
[required] The type of inventory item for which you want information. |
Filters |
One or more filters. Use a filter to return a more specific list of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
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 next set of results. |
Takes in filters and returns a list of managed nodes matching the filter criteria
Description
Takes in filters and returns a list of managed nodes matching the filter criteria.
See https://www.paws-r-sdk.com/docs/ssm_list_nodes/ for full documentation.
Usage
ssm_list_nodes(
SyncName = NULL,
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
SyncName |
The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configurations. Optional for single account/single-Region configurations. |
Filters |
One or more filters. Use a filter to return a more specific list of managed nodes. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
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 next set of results. |
Generates a summary of managed instance/node metadata based on the filters and aggregators you specify
Description
Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.
See https://www.paws-r-sdk.com/docs/ssm_list_nodes_summary/ for full documentation.
Usage
ssm_list_nodes_summary(
SyncName = NULL,
Filters = NULL,
Aggregators,
NextToken = NULL,
MaxResults = NULL
)
Arguments
SyncName |
The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configuration. Optional for single account/single-Region configurations. |
Filters |
One or more filters. Use a filter to generate a summary that matches your specified filter criteria. |
Aggregators |
[required] Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results. |
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 next set of results. |
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account
Description
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
See https://www.paws-r-sdk.com/docs/ssm_list_ops_item_events/ for full documentation.
Usage
ssm_list_ops_item_events(Filters = NULL, MaxResults = NULL, NextToken = NULL)
Arguments
Filters |
One or more OpsItem filters. Use a filter to return a more specific list of results. |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem
Description
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.
See https://www.paws-r-sdk.com/docs/ssm_list_ops_item_related_items/ for full documentation.
Usage
ssm_list_ops_item_related_items(
OpsItemId = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
OpsItemId |
The ID of the OpsItem for which you want to list all related-item resources. |
Filters |
One or more OpsItem filters. Use a filter to return a more specific list of results. |
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 next set of results. |
NextToken |
The token for the next set of items to return. (You received this token from a previous call.) |
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs
Description
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
See https://www.paws-r-sdk.com/docs/ssm_list_ops_metadata/ for full documentation.
Usage
ssm_list_ops_metadata(Filters = NULL, MaxResults = NULL, NextToken = NULL)
Arguments
Filters |
One or more filters to limit the number of OpsMetadata objects returned by the call. |
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 next set of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
Returns a resource-level summary count
Description
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
See https://www.paws-r-sdk.com/docs/ssm_list_resource_compliance_summaries/ for full documentation.
Usage
ssm_list_resource_compliance_summaries(
Filters = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Filters |
One or more filters. Use a filter to return a more specific list of results. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Lists your resource data sync configurations
Description
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
See https://www.paws-r-sdk.com/docs/ssm_list_resource_data_sync/ for full documentation.
Usage
ssm_list_resource_data_sync(
SyncType = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
SyncType |
View a list of resource data syncs according to the sync type. Specify
|
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Returns a list of the tags assigned to the specified resource
Description
Returns a list of the tags assigned to the specified resource.
See https://www.paws-r-sdk.com/docs/ssm_list_tags_for_resource/ for full documentation.
Usage
ssm_list_tags_for_resource(ResourceType, ResourceId)
Arguments
ResourceType |
[required] Returns a list of tags for a specific resource type. |
ResourceId |
[required] The resource ID for which you want to see a list of tags. |
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately
Description
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
See https://www.paws-r-sdk.com/docs/ssm_modify_document_permission/ for full documentation.
Usage
ssm_modify_document_permission(
Name,
PermissionType,
AccountIdsToAdd = NULL,
AccountIdsToRemove = NULL,
SharedDocumentVersion = NULL
)
Arguments
Name |
[required] The name of the document that you want to share. |
PermissionType |
[required] The permission type for the document. The permission type can be Share. |
AccountIdsToAdd |
The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All. |
AccountIdsToRemove |
The Amazon Web Services users that should no longer have access to the
document. The Amazon Web Services user can either be a group of account
IDs or All. This action has a higher priority than |
SharedDocumentVersion |
(Optional) The version of the document to share. If it isn't specified,
the system choose the |
Registers a compliance type and other compliance details on a designated resource
Description
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
See https://www.paws-r-sdk.com/docs/ssm_put_compliance_items/ for full documentation.
Usage
ssm_put_compliance_items(
ResourceId,
ResourceType,
ComplianceType,
ExecutionSummary,
Items,
ItemContentHash = NULL,
UploadType = NULL
)
Arguments
ResourceId |
[required] Specify an ID for this resource. For a managed node, this is the node ID. |
ResourceType |
[required] Specify the type of resource. |
ComplianceType |
[required] Specify the compliance type. For example, specify Association (for a
State Manager association), Patch, or Custom: |
ExecutionSummary |
[required] A summary of the call execution that includes an execution ID, the type
of execution (for example, |
Items |
[required] Information about the compliance as defined by the resource type. For
example, for a patch compliance type, |
ItemContentHash |
MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored. |
UploadType |
The mode for uploading compliance items. You can specify In This attribute is only valid for association compliance. |
Bulk update custom inventory items on one or more managed nodes
Description
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
See https://www.paws-r-sdk.com/docs/ssm_put_inventory/ for full documentation.
Usage
ssm_put_inventory(InstanceId, Items)
Arguments
InstanceId |
[required] An managed node ID where you want to add or update inventory items. |
Items |
[required] The inventory items that you want to add or update on managed nodes. |
Add a parameter to the system
Description
Add a parameter to the system.
See https://www.paws-r-sdk.com/docs/ssm_put_parameter/ for full documentation.
Usage
ssm_put_parameter(
Name,
Description = NULL,
Value,
Type = NULL,
KeyId = NULL,
Overwrite = NULL,
AllowedPattern = NULL,
Tags = NULL,
Tier = NULL,
Policies = NULL,
DataType = NULL
)
Arguments
Name |
[required] The fully qualified name of the parameter that you want to add to the system. You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. The fully qualified name includes the complete hierarchy of the
parameter path and name. For parameters in a hierarchy, you must include
a leading forward slash character (/) when you create or reference a
parameter. For example: Naming Constraints:
For additional information about valid values for parameter names, see Creating Systems Manager parameters 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.
This includes the characters in the ARN that precede the name you
specify, such as |
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. |
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 values wrapped in double brackets |
Type |
The type of parameter that you want to add to the system.
Items in a Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter. |
KeyId |
The Key Management Service (KMS) ID that you want to use to encrypt a
parameter. Use a custom key for better security. Required for parameters
that use the If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account which is not as secure as using a custom key.
|
Overwrite |
Overwrite an existing parameter. The default value is |
AllowedPattern |
A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ |
Tags |
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:
To add tags to an existing Systems Manager parameter, use the
|
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 account. Advanced parameters incur a charge. For more information, see Managing parameter tiers 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 data loss because the system would truncate the size of the parameter 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 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:
Options that require an advanced parameter include the following:
For more information about configuring the default tier option, see Specifying a default parameter tier in the Amazon Web Services Systems Manager User Guide. |
Policies |
One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in 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. |
DataType |
The data type for a The following data type values are supported.
When you create a If the action is successful, the service sends back an HTTP 200 response
which indicates a successful |
Creates or updates a Systems Manager resource policy
Description
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
See https://www.paws-r-sdk.com/docs/ssm_put_resource_policy/ for full documentation.
Usage
ssm_put_resource_policy(
ResourceArn,
Policy,
PolicyId = NULL,
PolicyHash = NULL
)
Arguments
ResourceArn |
[required] Amazon Resource Name (ARN) of the resource to which you want to attach a policy. |
Policy |
[required] A policy you want to associate with a resource. |
PolicyId |
The policy ID. |
PolicyHash |
ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy. |
Defines the default patch baseline for the relevant operating system
Description
Defines the default patch baseline for the relevant operating system.
See https://www.paws-r-sdk.com/docs/ssm_register_default_patch_baseline/ for full documentation.
Usage
ssm_register_default_patch_baseline(BaselineId)
Arguments
BaselineId |
[required] The ID of the patch baseline that should be the default patch baseline. |
Registers a patch baseline for a patch group
Description
Registers a patch baseline for a patch group.
See https://www.paws-r-sdk.com/docs/ssm_register_patch_baseline_for_patch_group/ for full documentation.
Usage
ssm_register_patch_baseline_for_patch_group(BaselineId, PatchGroup)
Arguments
BaselineId |
[required] The ID of the patch baseline to register with the patch group. |
PatchGroup |
[required] The name of the patch group to be registered with the patch baseline. |
Registers a target with a maintenance window
Description
Registers a target with a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_register_target_with_maintenance_window/ for full documentation.
Usage
ssm_register_target_with_maintenance_window(
WindowId,
ResourceType,
Targets,
OwnerInformation = NULL,
Name = NULL,
Description = NULL,
ClientToken = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window the target should be registered with. |
ResourceType |
[required] The type of target being registered with the maintenance window. |
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
Example 2: Use tag key-pairs applied to managed nodes
Example 3: Use tag-keys applied to managed nodes
Example 4: Use resource group names
Example 5: Use filters for resource group types
For
For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide. |
OwnerInformation |
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window. |
Name |
An optional name for the target. |
Description |
An optional description for the target. |
ClientToken |
User-provided idempotency token. |
Adds a new task to a maintenance window
Description
Adds a new task to a maintenance window.
See https://www.paws-r-sdk.com/docs/ssm_register_task_with_maintenance_window/ for full documentation.
Usage
ssm_register_task_with_maintenance_window(
WindowId,
Targets = NULL,
TaskArn,
ServiceRoleArn = NULL,
TaskType,
TaskParameters = NULL,
TaskInvocationParameters = NULL,
Priority = NULL,
MaxConcurrency = NULL,
MaxErrors = NULL,
LoggingInfo = NULL,
Name = NULL,
Description = NULL,
ClientToken = NULL,
CutoffBehavior = NULL,
AlarmConfiguration = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window the task should be added to. |
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 Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide. Specify managed nodes using the following format:
Specify maintenance window targets using the following format:
|
TaskArn |
[required] The ARN of the task to run. |
ServiceRoleArn |
The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
Services Systems Manager to assume when running a maintenance window
task. If you do not specify a service role ARN, Systems Manager uses a
service-linked role in your account. If no appropriate service-linked
role for Systems Manager exists in your account, it is created when you
run
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide. |
TaskType |
[required] The type of task being registered. |
TaskParameters |
The parameters that should be passed to the task when it is run.
|
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. |
Priority |
The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel. |
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 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 |
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 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 |
LoggingInfo |
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
|
Name |
An optional name for the task. |
Description |
An optional description for the task. |
ClientToken |
User-provided idempotency token. |
CutoffBehavior |
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
|
AlarmConfiguration |
The CloudWatch alarm you want to apply to your maintenance window task. |
Removes tag keys from the specified resource
Description
Removes tag keys from the specified resource.
See https://www.paws-r-sdk.com/docs/ssm_remove_tags_from_resource/ for full documentation.
Usage
ssm_remove_tags_from_resource(ResourceType, ResourceId, TagKeys)
Arguments
ResourceType |
[required] The type of resource from which you want to remove a tag. The |
ResourceId |
[required] The ID of the resource from which you want to remove tags. For example: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde OpsMetadata object: For the Document and Parameter values, use the name of the resource. The |
TagKeys |
[required] Tag keys that you want to remove from the specified resource. |
ServiceSetting is an account-level setting for an Amazon Web Services service
Description
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
See https://www.paws-r-sdk.com/docs/ssm_reset_service_setting/ for full documentation.
Usage
ssm_reset_service_setting(SettingId)
Arguments
SettingId |
[required] The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.
|
Reconnects a session to a managed node after it has been disconnected
Description
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
See https://www.paws-r-sdk.com/docs/ssm_resume_session/ for full documentation.
Usage
ssm_resume_session(SessionId)
Arguments
SessionId |
[required] The ID of the disconnected session to resume. |
Sends a signal to an Automation execution to change the current behavior or status of the execution
Description
Sends a signal to an Automation execution to change the current behavior or status of the execution.
See https://www.paws-r-sdk.com/docs/ssm_send_automation_signal/ for full documentation.
Usage
ssm_send_automation_signal(AutomationExecutionId, SignalType, Payload = NULL)
Arguments
AutomationExecutionId |
[required] The unique identifier for an existing Automation execution that you want to send the signal to. |
SignalType |
[required] The type of signal to send to an Automation execution. |
Payload |
The data sent with the signal. The data schema depends on the type of signal used in the request. For
For
For the
|
Runs commands on one or more managed nodes
Description
Runs commands on one or more managed nodes.
See https://www.paws-r-sdk.com/docs/ssm_send_command/ for full documentation.
Usage
ssm_send_command(
InstanceIds = NULL,
Targets = NULL,
DocumentName,
DocumentVersion = NULL,
DocumentHash = NULL,
DocumentHashType = NULL,
TimeoutSeconds = NULL,
Comment = NULL,
Parameters = NULL,
OutputS3Region = NULL,
OutputS3BucketName = NULL,
OutputS3KeyPrefix = NULL,
MaxConcurrency = NULL,
MaxErrors = NULL,
ServiceRoleArn = NULL,
NotificationConfig = NULL,
CloudWatchOutputConfig = NULL,
AlarmConfiguration = NULL
)
Arguments
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 For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide. |
Targets |
An array of search criteria that targets managed nodes using a
To send a command to a smaller number of managed nodes, you can use the
For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide. |
DocumentName |
[required] The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents 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 |
DocumentVersion |
The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by 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 "3" |
DocumentHash |
The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. |
DocumentHashType |
Sha256 or Sha1. Sha1 hashes have been deprecated. |
TimeoutSeconds |
If this time is reached and the command hasn't already started running, it won't run. |
Comment |
User-specified information about the command, such as a brief description of what the command should do. |
Parameters |
The required and optional parameters specified in the document being run. |
OutputS3Region |
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket. |
OutputS3BucketName |
The name of the S3 bucket where command execution responses should be stored. |
OutputS3KeyPrefix |
The directory structure within the S3 bucket where the responses should be stored. |
MaxConcurrency |
(Optional) The maximum number of managed nodes that are allowed to run
the command at the same time. You can specify a number such as 10 or a
percentage such as 10%. The default value is |
MaxErrors |
The maximum number of errors allowed without the command failing. When
the command fails one more time beyond the value of |
ServiceRoleArn |
The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands. This role must provide the |
NotificationConfig |
Configurations for sending notifications. |
CloudWatchOutputConfig |
Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in Amazon Web Services Systems Manager. |
AlarmConfiguration |
The CloudWatch alarm you want to apply to your command. |
Runs an association immediately and only one time
Description
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
See https://www.paws-r-sdk.com/docs/ssm_start_associations_once/ for full documentation.
Usage
ssm_start_associations_once(AssociationIds)
Arguments
AssociationIds |
[required] The association IDs that you want to run immediately and only one time. |
Initiates execution of an Automation runbook
Description
Initiates execution of an Automation runbook.
See https://www.paws-r-sdk.com/docs/ssm_start_automation_execution/ for full documentation.
Usage
ssm_start_automation_execution(
DocumentName,
DocumentVersion = NULL,
Parameters = NULL,
ClientToken = NULL,
Mode = NULL,
TargetParameterName = NULL,
Targets = NULL,
TargetMaps = NULL,
MaxConcurrency = NULL,
MaxErrors = NULL,
TargetLocations = NULL,
Tags = NULL,
AlarmConfiguration = NULL,
TargetLocationsURL = NULL
)
Arguments
DocumentName |
[required] The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide. |
DocumentVersion |
The version of the Automation runbook to use for this execution. |
Parameters |
A key-value map of execution parameters, which match the declared parameters in the Automation runbook. |
ClientToken |
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused. |
Mode |
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto. |
TargetParameterName |
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets. |
Targets |
A key-value mapping to target resources. Required if you specify TargetParameterName. If both this parameter and the |
TargetMaps |
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together. |
MaxConcurrency |
The maximum number of targets allowed to run this task in parallel. You
can specify a number, such as 10, or a percentage, such as 10%. The
default value is If both this parameter and the |
MaxErrors |
The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the 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 failed executions, set max-concurrency to 1 so the executions proceed one at a time. If this parameter and the |
TargetLocations |
A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running automations in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide. |
Tags |
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. 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:
The |
AlarmConfiguration |
The CloudWatch alarm you want to apply to your automation. |
TargetLocationsURL |
Specify a publicly accessible URL for a file that contains the
|
Creates a change request for Change Manager
Description
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
See https://www.paws-r-sdk.com/docs/ssm_start_change_request_execution/ for full documentation.
Usage
ssm_start_change_request_execution(
ScheduledTime = NULL,
DocumentName,
DocumentVersion = NULL,
Parameters = NULL,
ChangeRequestName = NULL,
ClientToken = NULL,
AutoApprove = NULL,
Runbooks,
Tags = NULL,
ScheduledEndTime = NULL,
ChangeDetails = NULL
)
Arguments
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. |
DocumentName |
[required] The name of the change template document to run during the runbook workflow. |
DocumentVersion |
The version of the change template document to run during the runbook workflow. |
Parameters |
A key-value map of parameters that match the declared parameters in the change template document. |
ChangeRequestName |
The name of the change request associated with the runbook workflow to be run. |
ClientToken |
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused. |
AutoApprove |
Indicates whether the change request can be approved automatically without the need for manual approvals. If Change Calendar restrictions are not bypassed in this scenario. If the
state of an associated calendar is |
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. |
Tags |
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. 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:
The |
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 requester provides for reviewers. |
ChangeDetails |
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added. |
Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources
Description
Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.
See https://www.paws-r-sdk.com/docs/ssm_start_execution_preview/ for full documentation.
Usage
ssm_start_execution_preview(
DocumentName,
DocumentVersion = NULL,
ExecutionInputs = NULL
)
Arguments
DocumentName |
[required] The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook. |
DocumentVersion |
The version of the Automation runbook to run. The default value is
|
ExecutionInputs |
Information about the inputs that can be specified for the preview operation. |
Initiates a connection to a target (for example, a managed node) for a Session Manager session
Description
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
See https://www.paws-r-sdk.com/docs/ssm_start_session/ for full documentation.
Usage
ssm_start_session(
Target,
DocumentName = NULL,
Reason = NULL,
Parameters = NULL
)
Arguments
Target |
[required] The managed node to connect to for the session. |
DocumentName |
The name of the SSM document you want to use to define the type of
session, input parameters, or preferences for the session. For example,
|
Reason |
The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session. |
Parameters |
The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide. |
Stop an Automation that is currently running
Description
Stop an Automation that is currently running.
See https://www.paws-r-sdk.com/docs/ssm_stop_automation_execution/ for full documentation.
Usage
ssm_stop_automation_execution(AutomationExecutionId, Type = NULL)
Arguments
AutomationExecutionId |
[required] The execution ID of the Automation to stop. |
Type |
The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel. |
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node
Description
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
See https://www.paws-r-sdk.com/docs/ssm_terminate_session/ for full documentation.
Usage
ssm_terminate_session(SessionId)
Arguments
SessionId |
[required] The ID of the session to terminate. |
Remove a label or labels from a parameter
Description
Remove a label or labels from a parameter.
See https://www.paws-r-sdk.com/docs/ssm_unlabel_parameter_version/ for full documentation.
Usage
ssm_unlabel_parameter_version(Name, ParameterVersion, Labels)
Arguments
Name |
[required] The name of the parameter from which you want to delete one or more labels. You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. |
ParameterVersion |
[required] The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail. |
Labels |
[required] One or more labels to delete from the specified parameter version. |
Updates an association
Description
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call update_association, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the describe_association API operation and make a note of all optional parameters required for your update_association call.
See https://www.paws-r-sdk.com/docs/ssm_update_association/ for full documentation.
Usage
ssm_update_association(
AssociationId,
Parameters = NULL,
DocumentVersion = NULL,
ScheduleExpression = NULL,
OutputLocation = NULL,
Name = NULL,
Targets = NULL,
AssociationName = NULL,
AssociationVersion = NULL,
AutomationTargetParameterName = NULL,
MaxErrors = NULL,
MaxConcurrency = NULL,
ComplianceSeverity = NULL,
SyncCompliance = NULL,
ApplyOnlyAtCronInterval = NULL,
CalendarNames = NULL,
TargetLocations = NULL,
ScheduleOffset = NULL,
Duration = NULL,
TargetMaps = NULL,
AlarmConfiguration = NULL
)
Arguments
AssociationId |
[required] The ID of the association you want to update. |
Parameters |
The parameters you want to update for the association. If you create a
parameter using Parameter Store, a tool in Amazon Web Services Systems
Manager, you can reference the parameter using |
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 |
ScheduleExpression |
The cron expression used to schedule the association that you want to update. |
OutputLocation |
An S3 bucket where you want to store the results of this request. |
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:
For example:
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name. For
example, |
Targets |
The targets of the association. |
AssociationName |
The name of the association that you want to update. |
AssociationVersion |
This parameter is provided for concurrency control purposes. You must
specify the latest association version in the service. If you want to
ensure that this request succeeds, either specify |
AutomationTargetParameterName |
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager. |
MaxErrors |
The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify
either an absolute number of errors, for example 10, or a percentage of
the target set, for example 10%. If you specify 3, for example, the
system stops sending requests when the fourth error is received. If you
specify 0, then the system stops sending requests after the first error
is returned. If you run an association on 50 managed nodes and set
Executions that are already running an association when |
MaxConcurrency |
The maximum number of targets allowed to run the association at the same 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 |
ComplianceSeverity |
The severity level to assign to the association. |
SyncCompliance |
The mode for generating association compliance. You can specify In By default, all associations use |
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),
State Manager applies the association at the next specified cron
interval. For example, if you chose the You can reset this option. To do so, specify the
|
CalendarNames |
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar. |
TargetLocations |
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts. |
ScheduleOffset |
Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of
To use offsets, you must specify the |
Duration |
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. The
|
TargetMaps |
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together. |
AlarmConfiguration |
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node
Description
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
See https://www.paws-r-sdk.com/docs/ssm_update_association_status/ for full documentation.
Usage
ssm_update_association_status(Name, InstanceId, AssociationStatus)
Arguments
Name |
[required] The name of the SSM document. |
InstanceId |
[required] The managed node ID. |
AssociationStatus |
[required] The association status. |
Updates one or more values for an SSM document
Description
Updates one or more values for an SSM document.
See https://www.paws-r-sdk.com/docs/ssm_update_document/ for full documentation.
Usage
ssm_update_document(
Content,
Attachments = NULL,
Name,
DisplayName = NULL,
VersionName = NULL,
DocumentVersion = NULL,
DocumentFormat = NULL,
TargetType = NULL
)
Arguments
Content |
[required] A valid JSON or YAML string. |
Attachments |
A list of key-value pairs that describe attachments to a version of a document. |
Name |
[required] The name of the SSM document that you want to update. |
DisplayName |
The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version. |
VersionName |
An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed. |
DocumentVersion |
The version of the document that you want to update. Currently, Systems
Manager supports updating only the latest version of the document. You
can specify the version number of the latest version or use the
If you change a document version for a State Manager association,
Systems Manager immediately runs the association unless you previously
specifed the |
DocumentFormat |
Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format. |
TargetType |
Specify a new target type for the document. |
Set the default version of a document
Description
Set the default version of a document.
See https://www.paws-r-sdk.com/docs/ssm_update_document_default_version/ for full documentation.
Usage
ssm_update_document_default_version(Name, DocumentVersion)
Arguments
Name |
[required] The name of a custom document that you want to set as the default version. |
DocumentVersion |
[required] The version of a custom document that you want to set as the default version. |
Updates information related to approval reviews for a specific version of a change template in Change Manager
Description
Updates information related to approval reviews for a specific version of a change template in Change Manager.
See https://www.paws-r-sdk.com/docs/ssm_update_document_metadata/ for full documentation.
Usage
ssm_update_document_metadata(Name, DocumentVersion = NULL, DocumentReviews)
Arguments
Name |
[required] The name of the change template for which a version's metadata is to be updated. |
DocumentVersion |
The version of a change template in which to update approval metadata. |
DocumentReviews |
[required] The change template review details to update. |
Updates an existing maintenance window
Description
Updates an existing maintenance window. Only specified parameters are modified.
See https://www.paws-r-sdk.com/docs/ssm_update_maintenance_window/ for full documentation.
Usage
ssm_update_maintenance_window(
WindowId,
Name = NULL,
Description = NULL,
StartDate = NULL,
EndDate = NULL,
Schedule = NULL,
ScheduleTimezone = NULL,
ScheduleOffset = NULL,
Duration = NULL,
Cutoff = NULL,
AllowUnassociatedTargets = NULL,
Enabled = NULL,
Replace = NULL
)
Arguments
WindowId |
[required] The ID of the maintenance window to update. |
Name |
The name of the maintenance window. |
Description |
An optional description for the update request. |
StartDate |
The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become active. When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. |
EndDate |
The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become inactive. |
Schedule |
The schedule of the maintenance window in the form of a cron or rate expression. |
ScheduleTimezone |
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. |
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.
If the schedule offset is |
Duration |
The duration of the maintenance window in hours. |
Cutoff |
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution. |
AllowUnassociatedTargets |
Whether targets must be registered with the maintenance window before tasks can be defined for those targets. |
Enabled |
Whether the maintenance window is enabled. |
Replace |
If |
Modifies the target of an existing maintenance window
Description
Modifies the target of an existing maintenance window. You can change the following:
See https://www.paws-r-sdk.com/docs/ssm_update_maintenance_window_target/ for full documentation.
Usage
ssm_update_maintenance_window_target(
WindowId,
WindowTargetId,
Targets = NULL,
OwnerInformation = NULL,
Name = NULL,
Description = NULL,
Replace = NULL
)
Arguments
WindowId |
[required] The maintenance window ID with which to modify the target. |
WindowTargetId |
[required] The target ID to modify. |
Targets |
The targets to add or replace. |
OwnerInformation |
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window. |
Name |
A name for the update. |
Description |
An optional description for the update. |
Replace |
If |
Modifies a task assigned to a maintenance window
Description
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
See https://www.paws-r-sdk.com/docs/ssm_update_maintenance_window_task/ for full documentation.
Usage
ssm_update_maintenance_window_task(
WindowId,
WindowTaskId,
Targets = NULL,
TaskArn = NULL,
ServiceRoleArn = NULL,
TaskParameters = NULL,
TaskInvocationParameters = NULL,
Priority = NULL,
MaxConcurrency = NULL,
MaxErrors = NULL,
LoggingInfo = NULL,
Name = NULL,
Description = NULL,
Replace = NULL,
CutoffBehavior = NULL,
AlarmConfiguration = NULL
)
Arguments
WindowId |
[required] The maintenance window ID that contains the task to modify. |
WindowTaskId |
[required] The task ID to modify. |
Targets |
The targets (either managed nodes or tags) to modify. Managed nodes are
specified using the format
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 Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide. |
TaskArn |
The task ARN to modify. |
ServiceRoleArn |
The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
Services Systems Manager to assume when running a maintenance window
task. If you do not specify a service role ARN, Systems Manager uses a
service-linked role in your account. If no appropriate service-linked
role for Systems Manager exists in your account, it is created when you
run
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide. |
TaskParameters |
The parameters to modify.
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 |
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
|
Priority |
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. |
MaxConcurrency |
The new Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task 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 |
MaxErrors |
The new Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task 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 |
LoggingInfo |
The new logging location in Amazon S3 to specify.
|
Name |
The new task name to specify. |
Description |
The new task description to specify. |
Replace |
If True, then all fields that are required by the
|
CutoffBehavior |
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
|
AlarmConfiguration |
The CloudWatch alarm you want to apply to your maintenance window task. |
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM)
Description
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see create_activation.
See https://www.paws-r-sdk.com/docs/ssm_update_managed_instance_role/ for full documentation.
Usage
ssm_update_managed_instance_role(InstanceId, IamRole)
Arguments
InstanceId |
[required] The ID of the managed node where you want to update the role. |
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
permissions for the Amazon Web Services Systems Manager service
principal You can't specify an IAM service-linked role for this parameter. You must create a unique role. |
Edit or change an OpsItem
Description
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
See https://www.paws-r-sdk.com/docs/ssm_update_ops_item/ for full documentation.
Usage
ssm_update_ops_item(
Description = NULL,
OperationalData = NULL,
OperationalDataToDelete = NULL,
Notifications = NULL,
Priority = NULL,
RelatedOpsItems = NULL,
Status = NULL,
OpsItemId,
Title = NULL,
Category = NULL,
Severity = NULL,
ActualStartTime = NULL,
ActualEndTime = NULL,
PlannedStartTime = NULL,
PlannedEndTime = NULL,
OpsItemArn = NULL
)
Arguments
Description |
User-defined text that contains information about the OpsItem, in Markdown format. |
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: 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
Use the |
OperationalDataToDelete |
Keys that you want to remove from the OperationalData map. |
Notifications |
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed. |
Priority |
The importance of this OpsItem in relation to other OpsItems in the system. |
RelatedOpsItems |
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. |
Status |
The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide. |
OpsItemId |
[required] The ID of the OpsItem. |
Title |
A short heading that describes the nature of the OpsItem and the impacted resource. |
Category |
Specify a new category for an OpsItem. |
Severity |
Specify a new severity for an OpsItem. |
ActualStartTime |
The time a runbook workflow started. Currently reported only for the
OpsItem type |
ActualEndTime |
The time a runbook workflow ended. Currently reported only for the
OpsItem type |
PlannedStartTime |
The time specified in a change request for a runbook workflow to start.
Currently supported only for the OpsItem type |
PlannedEndTime |
The time specified in a change request for a runbook workflow to end.
Currently supported only for the OpsItem type |
OpsItemArn |
The OpsItem Amazon Resource Name (ARN). |
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager
Description
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
See https://www.paws-r-sdk.com/docs/ssm_update_ops_metadata/ for full documentation.
Usage
ssm_update_ops_metadata(
OpsMetadataArn,
MetadataToUpdate = NULL,
KeysToDelete = NULL
)
Arguments
OpsMetadataArn |
[required] The Amazon Resource Name (ARN) of the OpsMetadata Object to update. |
MetadataToUpdate |
Metadata to add to an OpsMetadata object. |
KeysToDelete |
The metadata keys to delete from the OpsMetadata object. |
Modifies an existing patch baseline
Description
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
See https://www.paws-r-sdk.com/docs/ssm_update_patch_baseline/ for full documentation.
Usage
ssm_update_patch_baseline(
BaselineId,
Name = NULL,
GlobalFilters = NULL,
ApprovalRules = NULL,
ApprovedPatches = NULL,
ApprovedPatchesComplianceLevel = NULL,
ApprovedPatchesEnableNonSecurity = NULL,
RejectedPatches = NULL,
RejectedPatchesAction = NULL,
Description = NULL,
Sources = NULL,
Replace = NULL
)
Arguments
BaselineId |
[required] The ID of the patch baseline to update. |
Name |
The name of the patch baseline. |
GlobalFilters |
A set of global filters used to include patches in the baseline. The |
ApprovalRules |
A set of rules used to include patches in the baseline. |
ApprovedPatches |
A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide. |
ApprovedPatchesComplianceLevel |
Assigns a new compliance severity level to an existing patch baseline. |
ApprovedPatchesEnableNonSecurity |
Indicates whether the list of approved patches includes non-security
updates that should be applied to the managed nodes. The default value
is |
RejectedPatches |
A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide. |
RejectedPatchesAction |
The action for Patch Manager to take on patches included in the
ALLOW_AS_DEPENDENCY Linux and macOS: 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
Windows Server: Windows Server doesn't support the concept of
package dependencies. If a package in the rejected patches list and
already installed on the node, its status is reported as
BLOCK All OSs: Packages in the rejected patches list, and packages that
include them as dependencies, aren't installed by Patch Manager under
any circumstances. If a package was installed before it was added to the
rejected patches list, or is installed outside of Patch Manager
afterward, it's considered noncompliant with the patch baseline and its
status is reported as |
Description |
A description of the patch baseline. |
Sources |
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only. |
Replace |
If True, then all fields that are required by the
|
Update a resource data sync
Description
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
See https://www.paws-r-sdk.com/docs/ssm_update_resource_data_sync/ for full documentation.
Usage
ssm_update_resource_data_sync(SyncName, SyncType, SyncSource)
Arguments
SyncName |
[required] The name of the resource data sync you want to update. |
SyncType |
[required] The type of resource data sync. The supported |
SyncSource |
[required] Specify information about the data sources to synchronize. |
ServiceSetting is an account-level setting for an Amazon Web Services service
Description
ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
See https://www.paws-r-sdk.com/docs/ssm_update_service_setting/ for full documentation.
Usage
ssm_update_service_setting(SettingId, SettingValue)
Arguments
SettingId |
[required] The Amazon Resource Name (ARN) of the service setting to update. For
example,
Permissions to update the
|
SettingValue |
[required] The new value to specify for the service setting. The following list specifies the available values for each setting.
|
AWS Systems Manager Incident Manager Contacts
Description
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Usage
ssmcontacts(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- ssmcontacts(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| accept_page | Used to acknowledge an engagement to a contact channel during an incident |
| activate_contact_channel | Activates a contact's contact channel |
| create_contact | Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident |
| create_contact_channel | A contact channel is the method that Incident Manager uses to engage your contact |
| create_rotation | Creates a rotation in an on-call schedule |
| create_rotation_override | Creates an override for a rotation in an on-call schedule |
| deactivate_contact_channel | To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel |
| delete_contact | To remove a contact from Incident Manager, you can delete the contact |
| delete_contact_channel | To no longer receive engagements on a contact channel, you can delete the channel from a contact |
| delete_rotation | Deletes a rotation from the system |
| delete_rotation_override | Deletes an existing override for an on-call rotation |
| describe_engagement | Incident Manager uses engagements to engage contacts and escalation plans during an incident |
| describe_page | Lists details of the engagement to a contact channel |
| get_contact | Retrieves information about the specified contact or escalation plan |
| get_contact_channel | List details about a specific contact channel |
| get_contact_policy | Retrieves the resource policies attached to the specified contact or escalation plan |
| get_rotation | Retrieves information about an on-call rotation |
| get_rotation_override | Retrieves information about an override to an on-call rotation |
| list_contact_channels | Lists all contact channels for the specified contact |
| list_contacts | Lists all contacts and escalation plans in Incident Manager |
| list_engagements | Lists all engagements that have happened in an incident |
| list_page_receipts | Lists all of the engagements to contact channels that have been acknowledged |
| list_page_resolutions | Returns the resolution path of an engagement |
| list_pages_by_contact | Lists the engagements to a contact's contact channels |
| list_pages_by_engagement | Lists the engagements to contact channels that occurred by engaging a contact |
| list_preview_rotation_shifts | Returns a list of shifts based on rotation configuration parameters |
| list_rotation_overrides | Retrieves a list of overrides currently specified for an on-call rotation |
| list_rotations | Retrieves a list of on-call rotations |
| list_rotation_shifts | Returns a list of shifts generated by an existing rotation in the system |
| list_tags_for_resource | Lists the tags of an escalation plan or contact |
| put_contact_policy | Adds a resource policy to the specified contact or escalation plan |
| send_activation_code | Sends an activation code to a contact channel |
| start_engagement | Starts an engagement to a contact or escalation plan |
| stop_engagement | Stops an engagement before it finishes the final stage of the escalation plan or engagement plan |
| tag_resource | Tags a contact or escalation plan |
| untag_resource | Removes tags from the specified resource |
| update_contact | Updates the contact or escalation plan specified |
| update_contact_channel | Updates a contact's contact channel |
| update_rotation | Updates the information specified for an on-call rotation |
Examples
## Not run:
svc <- ssmcontacts()
# The following accept-page operation uses an accept code sent to the
# contact channel to accept a page.
svc$accept_page(
AcceptCode = "425440",
AcceptType = "READ",
PageId = "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b..."
)
## End(Not run)
Used to acknowledge an engagement to a contact channel during an incident
Description
Used to acknowledge an engagement to a contact channel during an incident.
See https://www.paws-r-sdk.com/docs/ssmcontacts_accept_page/ for full documentation.
Usage
ssmcontacts_accept_page(
PageId,
ContactChannelId = NULL,
AcceptType,
Note = NULL,
AcceptCode,
AcceptCodeValidation = NULL
)
Arguments
PageId |
[required] The Amazon Resource Name (ARN) of the engagement to a contact channel. |
ContactChannelId |
The ARN of the contact channel. |
AcceptType |
[required] The type indicates if the page was |
Note |
Information provided by the user when the user acknowledges the page. |
AcceptCode |
[required] A 6-digit code used to acknowledge the page. |
AcceptCodeValidation |
An optional field that Incident Manager uses to Incident Manager can also |
Activates a contact's contact channel
Description
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
See https://www.paws-r-sdk.com/docs/ssmcontacts_activate_contact_channel/ for full documentation.
Usage
ssmcontacts_activate_contact_channel(ContactChannelId, ActivationCode)
Arguments
ContactChannelId |
[required] The Amazon Resource Name (ARN) of the contact channel. |
ActivationCode |
[required] The code sent to the contact channel when it was created in the contact. |
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident
Description
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
See https://www.paws-r-sdk.com/docs/ssmcontacts_create_contact/ for full documentation.
Usage
ssmcontacts_create_contact(
Alias,
DisplayName = NULL,
Type,
Plan,
Tags = NULL,
IdempotencyToken = NULL
)
Arguments
Alias |
[required] The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable. |
DisplayName |
The full name of the contact or escalation plan. |
Type |
[required] To create an escalation plan use |
Plan |
[required] A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts. |
Tags |
Adds a tag to the target. You can only tag resources created in the first Region of your replication set. |
IdempotencyToken |
A token ensuring that the operation is called only once with the specified details. |
A contact channel is the method that Incident Manager uses to engage your contact
Description
A contact channel is the method that Incident Manager uses to engage your contact.
See https://www.paws-r-sdk.com/docs/ssmcontacts_create_contact_channel/ for full documentation.
Usage
ssmcontacts_create_contact_channel(
ContactId,
Name,
Type,
DeliveryAddress,
DeferActivation = NULL,
IdempotencyToken = NULL
)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact you are adding the contact channel to. |
Name |
[required] The name of the contact channel. |
Type |
[required] Incident Manager supports three types of contact channels:
|
DeliveryAddress |
[required] The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:
|
DeferActivation |
If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated. |
IdempotencyToken |
A token ensuring that the operation is called only once with the specified details. |
Creates a rotation in an on-call schedule
Description
Creates a rotation in an on-call schedule.
See https://www.paws-r-sdk.com/docs/ssmcontacts_create_rotation/ for full documentation.
Usage
ssmcontacts_create_rotation(
Name,
ContactIds,
StartTime = NULL,
TimeZoneId,
Recurrence,
Tags = NULL,
IdempotencyToken = NULL
)
Arguments
Name |
[required] The name of the rotation. |
ContactIds |
[required] The Amazon Resource Names (ARNs) of the contacts to add to the rotation. The order that you list the contacts in is their shift order in the
rotation schedule. To change the order of the contact's shifts, use the
|
StartTime |
The date and time that the rotation goes into effect. |
TimeZoneId |
[required] The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported. |
Recurrence |
[required] Information about the rule that specifies when a shift's team members rotate. |
Tags |
Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide. |
IdempotencyToken |
A token that ensures that the operation is called only once with the specified details. |
Creates an override for a rotation in an on-call schedule
Description
Creates an override for a rotation in an on-call schedule.
See https://www.paws-r-sdk.com/docs/ssmcontacts_create_rotation_override/ for full documentation.
Usage
ssmcontacts_create_rotation_override(
RotationId,
NewContactIds,
StartTime,
EndTime,
IdempotencyToken = NULL
)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the rotation to create an override for. |
NewContactIds |
[required] The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with. If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list. |
StartTime |
[required] The date and time when the override goes into effect. |
EndTime |
[required] The date and time when the override ends. |
IdempotencyToken |
A token that ensures that the operation is called only once with the specified details. |
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel
Description
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
See https://www.paws-r-sdk.com/docs/ssmcontacts_deactivate_contact_channel/ for full documentation.
Usage
ssmcontacts_deactivate_contact_channel(ContactChannelId)
Arguments
ContactChannelId |
[required] The Amazon Resource Name (ARN) of the contact channel you're deactivating. |
To remove a contact from Incident Manager, you can delete the contact
Description
To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.
See https://www.paws-r-sdk.com/docs/ssmcontacts_delete_contact/ for full documentation.
Usage
ssmcontacts_delete_contact(ContactId)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact that you're deleting. |
To no longer receive engagements on a contact channel, you can delete the channel from a contact
Description
To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.
See https://www.paws-r-sdk.com/docs/ssmcontacts_delete_contact_channel/ for full documentation.
Usage
ssmcontacts_delete_contact_channel(ContactChannelId)
Arguments
ContactChannelId |
[required] The Amazon Resource Name (ARN) of the contact channel. |
Deletes a rotation from the system
Description
Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
See https://www.paws-r-sdk.com/docs/ssmcontacts_delete_rotation/ for full documentation.
Usage
ssmcontacts_delete_rotation(RotationId)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the on-call rotation to delete. |
Deletes an existing override for an on-call rotation
Description
Deletes an existing override for an on-call rotation.
See https://www.paws-r-sdk.com/docs/ssmcontacts_delete_rotation_override/ for full documentation.
Usage
ssmcontacts_delete_rotation_override(RotationId, RotationOverrideId)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the rotation that was overridden. |
RotationOverrideId |
[required] The Amazon Resource Name (ARN) of the on-call rotation override to delete. |
Incident Manager uses engagements to engage contacts and escalation plans during an incident
Description
Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
See https://www.paws-r-sdk.com/docs/ssmcontacts_describe_engagement/ for full documentation.
Usage
ssmcontacts_describe_engagement(EngagementId)
Arguments
EngagementId |
[required] The Amazon Resource Name (ARN) of the engagement you want the details of. |
Lists details of the engagement to a contact channel
Description
Lists details of the engagement to a contact channel.
See https://www.paws-r-sdk.com/docs/ssmcontacts_describe_page/ for full documentation.
Usage
ssmcontacts_describe_page(PageId)
Arguments
PageId |
[required] The ID of the engagement to a contact channel. |
Retrieves information about the specified contact or escalation plan
Description
Retrieves information about the specified contact or escalation plan.
See https://www.paws-r-sdk.com/docs/ssmcontacts_get_contact/ for full documentation.
Usage
ssmcontacts_get_contact(ContactId)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan. |
List details about a specific contact channel
Description
List details about a specific contact channel.
See https://www.paws-r-sdk.com/docs/ssmcontacts_get_contact_channel/ for full documentation.
Usage
ssmcontacts_get_contact_channel(ContactChannelId)
Arguments
ContactChannelId |
[required] The Amazon Resource Name (ARN) of the contact channel you want information about. |
Retrieves the resource policies attached to the specified contact or escalation plan
Description
Retrieves the resource policies attached to the specified contact or escalation plan.
See https://www.paws-r-sdk.com/docs/ssmcontacts_get_contact_policy/ for full documentation.
Usage
ssmcontacts_get_contact_policy(ContactArn)
Arguments
ContactArn |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan. |
Retrieves information about an on-call rotation
Description
Retrieves information about an on-call rotation.
See https://www.paws-r-sdk.com/docs/ssmcontacts_get_rotation/ for full documentation.
Usage
ssmcontacts_get_rotation(RotationId)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about. |
Retrieves information about an override to an on-call rotation
Description
Retrieves information about an override to an on-call rotation.
See https://www.paws-r-sdk.com/docs/ssmcontacts_get_rotation_override/ for full documentation.
Usage
ssmcontacts_get_rotation_override(RotationId, RotationOverrideId)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about. |
RotationOverrideId |
[required] The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about. |
Lists all contact channels for the specified contact
Description
Lists all contact channels for the specified contact.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_contact_channels/ for full documentation.
Usage
ssmcontacts_list_contact_channels(
ContactId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact. |
NextToken |
The pagination token to continue to the next page of results. |
MaxResults |
The maximum number of contact channels per page. |
Lists all contacts and escalation plans in Incident Manager
Description
Lists all contacts and escalation plans in Incident Manager.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_contacts/ for full documentation.
Usage
ssmcontacts_list_contacts(
NextToken = NULL,
MaxResults = NULL,
AliasPrefix = NULL,
Type = NULL
)
Arguments
NextToken |
The pagination token to continue to the next page of results. |
MaxResults |
The maximum number of contacts and escalation plans per page of results. |
AliasPrefix |
Used to list only contacts who's aliases start with the specified prefix. |
Type |
The type of contact. A contact is type |
Lists all engagements that have happened in an incident
Description
Lists all engagements that have happened in an incident.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_engagements/ for full documentation.
Usage
ssmcontacts_list_engagements(
NextToken = NULL,
MaxResults = NULL,
IncidentId = NULL,
TimeRangeValue = NULL
)
Arguments
NextToken |
The pagination token to continue to the next page of results. |
MaxResults |
The maximum number of engagements per page of results. |
IncidentId |
The Amazon Resource Name (ARN) of the incident you're listing engagements for. |
TimeRangeValue |
The time range to lists engagements for an incident. |
Lists all of the engagements to contact channels that have been acknowledged
Description
Lists all of the engagements to contact channels that have been acknowledged.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_page_receipts/ for full documentation.
Usage
ssmcontacts_list_page_receipts(PageId, NextToken = NULL, MaxResults = NULL)
Arguments
PageId |
[required] The Amazon Resource Name (ARN) of the engagement to a specific contact channel. |
NextToken |
The pagination token to continue to the next page of results. |
MaxResults |
The maximum number of acknowledgements per page of results. |
Returns the resolution path of an engagement
Description
Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan \> on-call schedule \> contact.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_page_resolutions/ for full documentation.
Usage
ssmcontacts_list_page_resolutions(NextToken = NULL, PageId)
Arguments
NextToken |
A token to start the list. Use this token to get the next set of results. |
PageId |
[required] The Amazon Resource Name (ARN) of the contact engaged for the incident. |
Lists the engagements to a contact's contact channels
Description
Lists the engagements to a contact's contact channels.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_pages_by_contact/ for full documentation.
Usage
ssmcontacts_list_pages_by_contact(
ContactId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact you are retrieving engagements for. |
NextToken |
The pagination token to continue to the next page of results. |
MaxResults |
The maximum number of engagements to contact channels to list per page of results. |
Lists the engagements to contact channels that occurred by engaging a contact
Description
Lists the engagements to contact channels that occurred by engaging a contact.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_pages_by_engagement/ for full documentation.
Usage
ssmcontacts_list_pages_by_engagement(
EngagementId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
EngagementId |
[required] The Amazon Resource Name (ARN) of the engagement. |
NextToken |
The pagination token to continue to the next page of results. |
MaxResults |
The maximum number of engagements to contact channels to list per page of results. |
Returns a list of shifts based on rotation configuration parameters
Description
Returns a list of shifts based on rotation configuration parameters.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_preview_rotation_shifts/ for full documentation.
Usage
ssmcontacts_list_preview_rotation_shifts(
RotationStartTime = NULL,
StartTime = NULL,
EndTime,
Members,
TimeZoneId,
Recurrence,
Overrides = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
RotationStartTime |
The date and time a rotation would begin. The first shift is calculated from this date and time. |
StartTime |
Used to filter the range of calculated shifts before sending the response back to the user. |
EndTime |
[required] The date and time a rotation shift would end. |
Members |
[required] The contacts that would be assigned to a rotation. |
TimeZoneId |
[required] The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". |
Recurrence |
[required] Information about how long a rotation would last before restarting at the beginning of the shift order. |
Overrides |
Information about changes that would be made in a rotation override. |
NextToken |
A token to start the list. This token is used to get the next set of results. |
MaxResults |
The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results. |
Retrieves a list of overrides currently specified for an on-call rotation
Description
Retrieves a list of overrides currently specified for an on-call rotation.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_rotation_overrides/ for full documentation.
Usage
ssmcontacts_list_rotation_overrides(
RotationId,
StartTime,
EndTime,
NextToken = NULL,
MaxResults = NULL
)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the rotation to retrieve information about. |
StartTime |
[required] The date and time for the beginning of a time range for listing overrides. |
EndTime |
[required] The date and time for the end of a time range for listing overrides. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Returns a list of shifts generated by an existing rotation in the system
Description
Returns a list of shifts generated by an existing rotation in the system.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_rotation_shifts/ for full documentation.
Usage
ssmcontacts_list_rotation_shifts(
RotationId,
StartTime = NULL,
EndTime,
NextToken = NULL,
MaxResults = NULL
)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the rotation to retrieve shift information about. |
StartTime |
The date and time for the beginning of the time range to list shifts for. |
EndTime |
[required] The date and time for the end of the time range to list shifts for. |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Retrieves a list of on-call rotations
Description
Retrieves a list of on-call rotations.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_rotations/ for full documentation.
Usage
ssmcontacts_list_rotations(
RotationNamePrefix = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
RotationNamePrefix |
A filter to include rotations in list results based on their common
prefix. For example, entering prod returns a list of all rotation names
that begin with |
NextToken |
A token to start the list. Use this token to get the next set of results. |
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 next set of results. |
Lists the tags of an escalation plan or contact
Description
Lists the tags of an escalation plan or contact.
See https://www.paws-r-sdk.com/docs/ssmcontacts_list_tags_for_resource/ for full documentation.
Usage
ssmcontacts_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan. |
Adds a resource policy to the specified contact or escalation plan
Description
Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.
See https://www.paws-r-sdk.com/docs/ssmcontacts_put_contact_policy/ for full documentation.
Usage
ssmcontacts_put_contact_policy(ContactArn, Policy)
Arguments
ContactArn |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan. |
Policy |
[required] Details of the resource policy. |
Sends an activation code to a contact channel
Description
Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.
See https://www.paws-r-sdk.com/docs/ssmcontacts_send_activation_code/ for full documentation.
Usage
ssmcontacts_send_activation_code(ContactChannelId)
Arguments
ContactChannelId |
[required] The Amazon Resource Name (ARN) of the contact channel. |
Starts an engagement to a contact or escalation plan
Description
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
See https://www.paws-r-sdk.com/docs/ssmcontacts_start_engagement/ for full documentation.
Usage
ssmcontacts_start_engagement(
ContactId,
Sender,
Subject,
Content,
PublicSubject = NULL,
PublicContent = NULL,
IncidentId = NULL,
IdempotencyToken = NULL
)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact being engaged. |
Sender |
[required] The user that started the engagement. |
Subject |
[required] The secure subject of the message that was sent to the contact. Use this
field for engagements to |
Content |
[required] The secure content of the message that was sent to the contact. Use this
field for engagements to |
PublicSubject |
The insecure subject of the message that was sent to the contact. Use
this field for engagements to |
PublicContent |
The insecure content of the message that was sent to the contact. Use
this field for engagements to |
IncidentId |
The ARN of the incident that the engagement is part of. |
IdempotencyToken |
A token ensuring that the operation is called only once with the specified details. |
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan
Description
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
See https://www.paws-r-sdk.com/docs/ssmcontacts_stop_engagement/ for full documentation.
Usage
ssmcontacts_stop_engagement(EngagementId, Reason = NULL)
Arguments
EngagementId |
[required] The Amazon Resource Name (ARN) of the engagement. |
Reason |
The reason that you're stopping the engagement. |
Tags a contact or escalation plan
Description
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
See https://www.paws-r-sdk.com/docs/ssmcontacts_tag_resource/ for full documentation.
Usage
ssmcontacts_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan. |
Tags |
[required] A list of tags that you are adding to the contact or escalation plan. |
Removes tags from the specified resource
Description
Removes tags from the specified resource.
See https://www.paws-r-sdk.com/docs/ssmcontacts_untag_resource/ for full documentation.
Usage
ssmcontacts_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan. |
TagKeys |
[required] The key of the tag that you want to remove. |
Updates the contact or escalation plan specified
Description
Updates the contact or escalation plan specified.
See https://www.paws-r-sdk.com/docs/ssmcontacts_update_contact/ for full documentation.
Usage
ssmcontacts_update_contact(ContactId, DisplayName = NULL, Plan = NULL)
Arguments
ContactId |
[required] The Amazon Resource Name (ARN) of the contact or escalation plan you're updating. |
DisplayName |
The full name of the contact or escalation plan. |
Plan |
A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts. |
Updates a contact's contact channel
Description
Updates a contact's contact channel.
See https://www.paws-r-sdk.com/docs/ssmcontacts_update_contact_channel/ for full documentation.
Usage
ssmcontacts_update_contact_channel(
ContactChannelId,
Name = NULL,
DeliveryAddress = NULL
)
Arguments
ContactChannelId |
[required] The Amazon Resource Name (ARN) of the contact channel you want to update. |
Name |
The name of the contact channel. |
DeliveryAddress |
The details that Incident Manager uses when trying to engage the contact channel. |
Updates the information specified for an on-call rotation
Description
Updates the information specified for an on-call rotation.
See https://www.paws-r-sdk.com/docs/ssmcontacts_update_rotation/ for full documentation.
Usage
ssmcontacts_update_rotation(
RotationId,
ContactIds = NULL,
StartTime = NULL,
TimeZoneId = NULL,
Recurrence
)
Arguments
RotationId |
[required] The Amazon Resource Name (ARN) of the rotation to update. |
ContactIds |
The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation. The order in which you list the contacts is their shift order in the rotation schedule. |
StartTime |
The date and time the rotation goes into effect. |
TimeZoneId |
The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported. |
Recurrence |
[required] Information about how long the updated rotation lasts before restarting at the beginning of the shift order. |
AWS Systems Manager Incident Manager
Description
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Usage
ssmincidents(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- ssmincidents(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| batch_get_incident_findings | Retrieves details about all specified findings for an incident, including descriptive details about each finding |
| create_replication_set | A replication set replicates and encrypts your data to the provided Regions with the provided KMS key |
| create_response_plan | Creates a response plan that automates the initial response to incidents |
| create_timeline_event | Creates a custom timeline event on the incident details page of an incident record |
| delete_incident_record | Delete an incident record from Incident Manager |
| delete_replication_set | Deletes all Regions in your replication set |
| delete_resource_policy | Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource |
| delete_response_plan | Deletes the specified response plan |
| delete_timeline_event | Deletes a timeline event from an incident |
| get_incident_record | Returns the details for the specified incident record |
| get_replication_set | Retrieve your Incident Manager replication set |
| get_resource_policies | Retrieves the resource policies attached to the specified response plan |
| get_response_plan | Retrieves the details of the specified response plan |
| get_timeline_event | Retrieves a timeline event based on its ID and incident record |
| list_incident_findings | Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident |
| list_incident_records | Lists all incident records in your account |
| list_related_items | List all related items for an incident record |
| list_replication_sets | Lists details about the replication set configured in your account |
| list_response_plans | Lists all response plans in your account |
| list_tags_for_resource | Lists the tags that are attached to the specified response plan or incident |
| list_timeline_events | Lists timeline events for the specified incident record |
| put_resource_policy | Adds a resource policy to the specified response plan |
| start_incident | Used to start an incident from CloudWatch alarms, EventBridge events, or manually |
| tag_resource | Adds a tag to a response plan |
| untag_resource | Removes a tag from a resource |
| update_deletion_protection | Update deletion protection to either allow or deny deletion of the final Region in a replication set |
| update_incident_record | Update the details of an incident record |
| update_related_items | Add or remove related items from the related items tab of an incident record |
| update_replication_set | Add or delete Regions from your replication set |
| update_response_plan | Updates the specified response plan |
| update_timeline_event | Updates a timeline event |
Examples
## Not run:
svc <- ssmincidents()
svc$batch_get_incident_findings(
Foo = 123
)
## End(Not run)
Retrieves details about all specified findings for an incident, including descriptive details about each finding
Description
Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.
See https://www.paws-r-sdk.com/docs/ssmincidents_batch_get_incident_findings/ for full documentation.
Usage
ssmincidents_batch_get_incident_findings(findingIds, incidentRecordArn)
Arguments
findingIds |
[required] A list of IDs of findings for which you want to view details. |
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident for which you want to view finding details. |
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key
Description
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
See https://www.paws-r-sdk.com/docs/ssmincidents_create_replication_set/ for full documentation.
Usage
ssmincidents_create_replication_set(clientToken = NULL, regions, tags = NULL)
Arguments
clientToken |
A token that ensures that the operation is called only once with the specified details. |
regions |
[required] The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set. |
tags |
A list of tags to add to the replication set. |
Creates a response plan that automates the initial response to incidents
Description
Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.
See https://www.paws-r-sdk.com/docs/ssmincidents_create_response_plan/ for full documentation.
Usage
ssmincidents_create_response_plan(
actions = NULL,
chatChannel = NULL,
clientToken = NULL,
displayName = NULL,
engagements = NULL,
incidentTemplate,
integrations = NULL,
name,
tags = NULL
)
Arguments
actions |
The actions that the response plan starts at the beginning of an incident. |
chatChannel |
The Chatbot chat channel used for collaboration during an incident. |
clientToken |
A token ensuring that the operation is called only once with the specified details. |
displayName |
The long format of the response plan name. This field can contain spaces. |
engagements |
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident. |
incidentTemplate |
[required] Details used to create an incident when using this response plan. |
integrations |
Information about third-party services integrated into the response plan. |
name |
[required] The short format name of the response plan. Can't include spaces. |
tags |
A list of tags that you are adding to the response plan. |
Creates a custom timeline event on the incident details page of an incident record
Description
Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.
See https://www.paws-r-sdk.com/docs/ssmincidents_create_timeline_event/ for full documentation.
Usage
ssmincidents_create_timeline_event(
clientToken = NULL,
eventData,
eventReferences = NULL,
eventTime,
eventType,
incidentRecordArn
)
Arguments
clientToken |
A token that ensures that a client calls the action only once with the specified details. |
eventData |
[required] A short description of the event. |
eventReferences |
Adds one or more references to the |
eventTime |
[required] The timestamp for when the event occurred. |
eventType |
[required] The type of event. You can create timeline events of type To make a Note-type event appear on the Incident notes panel in the
console, specify |
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident record that the action adds the incident to. |
Delete an incident record from Incident Manager
Description
Delete an incident record from Incident Manager.
See https://www.paws-r-sdk.com/docs/ssmincidents_delete_incident_record/ for full documentation.
Usage
ssmincidents_delete_incident_record(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the incident record you are deleting. |
Deletes all Regions in your replication set
Description
Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
See https://www.paws-r-sdk.com/docs/ssmincidents_delete_replication_set/ for full documentation.
Usage
ssmincidents_delete_replication_set(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the replication set you're deleting. |
Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource
Description
Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
See https://www.paws-r-sdk.com/docs/ssmincidents_delete_resource_policy/ for full documentation.
Usage
ssmincidents_delete_resource_policy(policyId, resourceArn)
Arguments
policyId |
[required] The ID of the resource policy you're deleting. |
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource you're deleting the policy from. |
Deletes the specified response plan
Description
Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.
See https://www.paws-r-sdk.com/docs/ssmincidents_delete_response_plan/ for full documentation.
Usage
ssmincidents_delete_response_plan(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the response plan. |
Deletes a timeline event from an incident
Description
Deletes a timeline event from an incident.
See https://www.paws-r-sdk.com/docs/ssmincidents_delete_timeline_event/ for full documentation.
Usage
ssmincidents_delete_timeline_event(eventId, incidentRecordArn)
Arguments
eventId |
[required] The ID of the event to update. You can use
|
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident that includes the timeline event. |
Returns the details for the specified incident record
Description
Returns the details for the specified incident record.
See https://www.paws-r-sdk.com/docs/ssmincidents_get_incident_record/ for full documentation.
Usage
ssmincidents_get_incident_record(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the incident record. |
Retrieve your Incident Manager replication set
Description
Retrieve your Incident Manager replication set.
See https://www.paws-r-sdk.com/docs/ssmincidents_get_replication_set/ for full documentation.
Usage
ssmincidents_get_replication_set(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the replication set you want to retrieve. |
Retrieves the resource policies attached to the specified response plan
Description
Retrieves the resource policies attached to the specified response plan.
See https://www.paws-r-sdk.com/docs/ssmincidents_get_resource_policies/ for full documentation.
Usage
ssmincidents_get_resource_policies(
maxResults = NULL,
nextToken = NULL,
resourceArn
)
Arguments
maxResults |
The maximum number of resource policies to display for each page of results. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
resourceArn |
[required] The Amazon Resource Name (ARN) of the response plan with the attached resource policy. |
Retrieves the details of the specified response plan
Description
Retrieves the details of the specified response plan.
See https://www.paws-r-sdk.com/docs/ssmincidents_get_response_plan/ for full documentation.
Usage
ssmincidents_get_response_plan(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the response plan. |
Retrieves a timeline event based on its ID and incident record
Description
Retrieves a timeline event based on its ID and incident record.
See https://www.paws-r-sdk.com/docs/ssmincidents_get_timeline_event/ for full documentation.
Usage
ssmincidents_get_timeline_event(eventId, incidentRecordArn)
Arguments
eventId |
[required] The ID of the event. You can get an event's ID when you create it, or by
using |
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident that includes the timeline event. |
Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident
Description
Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_incident_findings/ for full documentation.
Usage
ssmincidents_list_incident_findings(
incidentRecordArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident for which you want to view associated findings. |
maxResults |
The maximum number of findings to retrieve per call. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
Lists all incident records in your account
Description
Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_incident_records/ for full documentation.
Usage
ssmincidents_list_incident_records(
filters = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
filters |
Filters the list of incident records you want to search through. You can filter on the following keys:
Note the following when when you use Filters:
|
maxResults |
The maximum number of results per page. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
List all related items for an incident record
Description
List all related items for an incident record.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_related_items/ for full documentation.
Usage
ssmincidents_list_related_items(
incidentRecordArn,
maxResults = NULL,
nextToken = NULL
)
Arguments
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident record containing the listed related items. |
maxResults |
The maximum number of related items per page. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
Lists details about the replication set configured in your account
Description
Lists details about the replication set configured in your account.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_replication_sets/ for full documentation.
Usage
ssmincidents_list_replication_sets(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results per page. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
Lists all response plans in your account
Description
Lists all response plans in your account.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_response_plans/ for full documentation.
Usage
ssmincidents_list_response_plans(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of response plans per page. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
Lists the tags that are attached to the specified response plan or incident
Description
Lists the tags that are attached to the specified response plan or incident.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_tags_for_resource/ for full documentation.
Usage
ssmincidents_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the response plan or incident. |
Lists timeline events for the specified incident record
Description
Lists timeline events for the specified incident record.
See https://www.paws-r-sdk.com/docs/ssmincidents_list_timeline_events/ for full documentation.
Usage
ssmincidents_list_timeline_events(
filters = NULL,
incidentRecordArn,
maxResults = NULL,
nextToken = NULL,
sortBy = NULL,
sortOrder = NULL
)
Arguments
filters |
Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:
Note the following when deciding how to use Filters:
|
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident that includes the timeline event. |
maxResults |
The maximum number of results per page. |
nextToken |
The pagination token for the next set of items to return. (You received this token from a previous call.) |
sortBy |
Sort timeline events by the specified key value pair. |
sortOrder |
Sorts the order of timeline events by the value specified in the
|
Adds a resource policy to the specified response plan
Description
Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management.
See https://www.paws-r-sdk.com/docs/ssmincidents_put_resource_policy/ for full documentation.
Usage
ssmincidents_put_resource_policy(policy, resourceArn)
Arguments
policy |
[required] Details of the resource policy. |
resourceArn |
[required] The Amazon Resource Name (ARN) of the response plan to add the resource policy to. |
Used to start an incident from CloudWatch alarms, EventBridge events, or manually
Description
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
See https://www.paws-r-sdk.com/docs/ssmincidents_start_incident/ for full documentation.
Usage
ssmincidents_start_incident(
clientToken = NULL,
impact = NULL,
relatedItems = NULL,
responsePlanArn,
title = NULL,
triggerDetails = NULL
)
Arguments
clientToken |
A token ensuring that the operation is called only once with the specified details. |
impact |
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan. Supported impact codes
|
relatedItems |
Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket. |
responsePlanArn |
[required] The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident. |
title |
Provide a title for the incident. Providing a title overwrites the title provided by the response plan. |
triggerDetails |
Details of what created the incident record in Incident Manager. |
Adds a tag to a response plan
Description
Adds a tag to a response plan.
See https://www.paws-r-sdk.com/docs/ssmincidents_tag_resource/ for full documentation.
Usage
ssmincidents_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the response plan you're adding the tags to. |
tags |
[required] A list of tags to add to the response plan. |
Removes a tag from a resource
Description
Removes a tag from a resource.
See https://www.paws-r-sdk.com/docs/ssmincidents_untag_resource/ for full documentation.
Usage
ssmincidents_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the response plan you're removing a tag from. |
tagKeys |
[required] The name of the tag to remove from the response plan. |
Update deletion protection to either allow or deny deletion of the final Region in a replication set
Description
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
See https://www.paws-r-sdk.com/docs/ssmincidents_update_deletion_protection/ for full documentation.
Usage
ssmincidents_update_deletion_protection(
arn,
clientToken = NULL,
deletionProtected
)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the replication set to update. |
clientToken |
A token that ensures that the operation is called only once with the specified details. |
deletionProtected |
[required] Specifies if deletion protection is turned on or off in your account. |
Update the details of an incident record
Description
Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.
See https://www.paws-r-sdk.com/docs/ssmincidents_update_incident_record/ for full documentation.
Usage
ssmincidents_update_incident_record(
arn,
chatChannel = NULL,
clientToken = NULL,
impact = NULL,
notificationTargets = NULL,
status = NULL,
summary = NULL,
title = NULL
)
Arguments
arn |
[required] The Amazon Resource Name (ARN) of the incident record you are updating. |
chatChannel |
The Chatbot chat channel where responders can collaborate. |
clientToken |
A token that ensures that a client calls the operation only once with the specified details. |
impact |
Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan. Supported impact codes
|
notificationTargets |
The Amazon SNS targets that Incident Manager notifies when a client updates an incident. Using multiple SNS topics creates redundancy in the event that a Region is down during the incident. |
status |
The status of the incident. Possible statuses are |
summary |
A longer description of what occurred during the incident. |
title |
A brief description of the incident. |
Add or remove related items from the related items tab of an incident record
Description
Add or remove related items from the related items tab of an incident record.
See https://www.paws-r-sdk.com/docs/ssmincidents_update_related_items/ for full documentation.
Usage
ssmincidents_update_related_items(
clientToken = NULL,
incidentRecordArn,
relatedItemsUpdate
)
Arguments
clientToken |
A token that ensures that a client calls the operation only once with the specified details. |
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident record that contains the related items that you update. |
relatedItemsUpdate |
[required] Details about the item that you are add to, or delete from, an incident. |
Add or delete Regions from your replication set
Description
Add or delete Regions from your replication set.
See https://www.paws-r-sdk.com/docs/ssmincidents_update_replication_set/ for full documentation.
Usage
ssmincidents_update_replication_set(actions, arn, clientToken = NULL)
Arguments
actions |
[required] An action to add or delete a Region. |
arn |
[required] The Amazon Resource Name (ARN) of the replication set you're updating. |
clientToken |
A token that ensures that the operation is called only once with the specified details. |
Updates the specified response plan
Description
Updates the specified response plan.
See https://www.paws-r-sdk.com/docs/ssmincidents_update_response_plan/ for full documentation.
Usage
ssmincidents_update_response_plan(
actions = NULL,
arn,
chatChannel = NULL,
clientToken = NULL,
displayName = NULL,
engagements = NULL,
incidentTemplateDedupeString = NULL,
incidentTemplateImpact = NULL,
incidentTemplateNotificationTargets = NULL,
incidentTemplateSummary = NULL,
incidentTemplateTags = NULL,
incidentTemplateTitle = NULL,
integrations = NULL
)
Arguments
actions |
The actions that this response plan takes at the beginning of an incident. |
arn |
[required] The Amazon Resource Name (ARN) of the response plan. |
chatChannel |
The Chatbot chat channel used for collaboration during an incident. Use the empty structure to remove the chat channel from the response plan. |
clientToken |
A token ensuring that the operation is called only once with the specified details. |
displayName |
The long format name of the response plan. The display name can't contain spaces. |
engagements |
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident. |
incidentTemplateDedupeString |
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account. |
incidentTemplateImpact |
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan. Supported impact codes
|
incidentTemplateNotificationTargets |
The Amazon SNS targets that are notified when updates are made to an incident. |
incidentTemplateSummary |
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps. |
incidentTemplateTags |
Tags to assign to the template. When the
|
incidentTemplateTitle |
The short format name of the incident. The title can't contain spaces. |
integrations |
Information about third-party services integrated into the response plan. |
Updates a timeline event
Description
Updates a timeline event. You can update events of type Custom Event.
See https://www.paws-r-sdk.com/docs/ssmincidents_update_timeline_event/ for full documentation.
Usage
ssmincidents_update_timeline_event(
clientToken = NULL,
eventData = NULL,
eventId,
eventReferences = NULL,
eventTime = NULL,
eventType = NULL,
incidentRecordArn
)
Arguments
clientToken |
A token that ensures that a client calls the operation only once with the specified details. |
eventData |
A short description of the event. |
eventId |
[required] The ID of the event to update. You can use
|
eventReferences |
Updates all existing references in a This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references. |
eventTime |
The timestamp for when the event occurred. |
eventType |
The type of event. You can update events of type |
incidentRecordArn |
[required] The Amazon Resource Name (ARN) of the incident that includes the timeline event. |
AWS Systems Manager for SAP
Description
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.
Usage
ssmsap(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- ssmsap(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| delete_resource_permission | Removes permissions associated with the target database |
| deregister_application | Deregister an SAP application with AWS Systems Manager for SAP |
| get_application | Gets an application registered with AWS Systems Manager for SAP |
| get_component | Gets the component of an application registered with AWS Systems Manager for SAP |
| get_database | Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP |
| get_operation | Gets the details of an operation by specifying the operation ID |
| get_resource_permission | Gets permissions associated with the target database |
| list_applications | Lists all the applications registered with AWS Systems Manager for SAP |
| list_components | Lists all the components registered with AWS Systems Manager for SAP |
| list_databases | Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP |
| list_operation_events | Returns a list of operations events |
| list_operations | Lists the operations performed by AWS Systems Manager for SAP |
| list_tags_for_resource | Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP |
| put_resource_permission | Adds permissions to the target database |
| register_application | Register an SAP application with AWS Systems Manager for SAP |
| start_application | Request is an operation which starts an application |
| start_application_refresh | Refreshes a registered application |
| stop_application | Request is an operation to stop an application |
| tag_resource | Creates tag for a resource by specifying the ARN |
| untag_resource | Delete the tags for a resource |
| update_application_settings | Updates the settings of an application registered with AWS Systems Manager for SAP |
Examples
## Not run:
svc <- ssmsap()
svc$delete_resource_permission(
Foo = 123
)
## End(Not run)
Removes permissions associated with the target database
Description
Removes permissions associated with the target database.
See https://www.paws-r-sdk.com/docs/ssmsap_delete_resource_permission/ for full documentation.
Usage
ssmsap_delete_resource_permission(
ActionType = NULL,
SourceResourceArn = NULL,
ResourceArn
)
Arguments
ActionType |
Delete or restore the permissions on the target database. |
SourceResourceArn |
The Amazon Resource Name (ARN) of the source resource. |
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Deregister an SAP application with AWS Systems Manager for SAP
Description
Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
See https://www.paws-r-sdk.com/docs/ssmsap_deregister_application/ for full documentation.
Usage
ssmsap_deregister_application(ApplicationId)
Arguments
ApplicationId |
[required] The ID of the application. |
Gets an application registered with AWS Systems Manager for SAP
Description
Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
See https://www.paws-r-sdk.com/docs/ssmsap_get_application/ for full documentation.
Usage
ssmsap_get_application(
ApplicationId = NULL,
ApplicationArn = NULL,
AppRegistryArn = NULL
)
Arguments
ApplicationId |
The ID of the application. |
ApplicationArn |
The Amazon Resource Name (ARN) of the application. |
AppRegistryArn |
The Amazon Resource Name (ARN) of the application registry. |
Gets the component of an application registered with AWS Systems Manager for SAP
Description
Gets the component of an application registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_get_component/ for full documentation.
Usage
ssmsap_get_component(ApplicationId, ComponentId)
Arguments
ApplicationId |
[required] The ID of the application. |
ComponentId |
[required] The ID of the component. |
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP
Description
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_get_database/ for full documentation.
Usage
ssmsap_get_database(
ApplicationId = NULL,
ComponentId = NULL,
DatabaseId = NULL,
DatabaseArn = NULL
)
Arguments
ApplicationId |
The ID of the application. |
ComponentId |
The ID of the component. |
DatabaseId |
The ID of the database. |
DatabaseArn |
The Amazon Resource Name (ARN) of the database. |
Gets the details of an operation by specifying the operation ID
Description
Gets the details of an operation by specifying the operation ID.
See https://www.paws-r-sdk.com/docs/ssmsap_get_operation/ for full documentation.
Usage
ssmsap_get_operation(OperationId)
Arguments
OperationId |
[required] The ID of the operation. |
Gets permissions associated with the target database
Description
Gets permissions associated with the target database.
See https://www.paws-r-sdk.com/docs/ssmsap_get_resource_permission/ for full documentation.
Usage
ssmsap_get_resource_permission(ActionType = NULL, ResourceArn)
Arguments
ActionType |
|
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Lists all the applications registered with AWS Systems Manager for SAP
Description
Lists all the applications registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_list_applications/ for full documentation.
Usage
ssmsap_list_applications(NextToken = NULL, MaxResults = NULL, Filters = NULL)
Arguments
NextToken |
The token for the next page of results. |
MaxResults |
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. |
Filters |
The filter of name, value, and operator. |
Lists all the components registered with AWS Systems Manager for SAP
Description
Lists all the components registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_list_components/ for full documentation.
Usage
ssmsap_list_components(
ApplicationId = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ApplicationId |
The ID of the application. |
NextToken |
The token for the next page of results. |
MaxResults |
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default. |
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP
Description
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_list_databases/ for full documentation.
Usage
ssmsap_list_databases(
ApplicationId = NULL,
ComponentId = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ApplicationId |
The ID of the application. |
ComponentId |
The ID of the component. |
NextToken |
The token for the next page of results. |
MaxResults |
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default. |
Returns a list of operations events
Description
Returns a list of operations events.
See https://www.paws-r-sdk.com/docs/ssmsap_list_operation_events/ for full documentation.
Usage
ssmsap_list_operation_events(
OperationId,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
OperationId |
[required] The ID of the operation. |
MaxResults |
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for |
NextToken |
The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
Filters |
Optionally specify filters to narrow the returned operation event items. Valid filter names include |
Lists the operations performed by AWS Systems Manager for SAP
Description
Lists the operations performed by AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_list_operations/ for full documentation.
Usage
ssmsap_list_operations(
ApplicationId,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
ApplicationId |
[required] The ID of the application. |
MaxResults |
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default. |
NextToken |
The token for the next page of results. |
Filters |
The filters of an operation. |
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP
Description
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_list_tags_for_resource/ for full documentation.
Usage
ssmsap_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Adds permissions to the target database
Description
Adds permissions to the target database.
See https://www.paws-r-sdk.com/docs/ssmsap_put_resource_permission/ for full documentation.
Usage
ssmsap_put_resource_permission(ActionType, SourceResourceArn, ResourceArn)
Arguments
ActionType |
[required] |
SourceResourceArn |
[required] |
ResourceArn |
[required] |
Register an SAP application with AWS Systems Manager for SAP
Description
Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
See https://www.paws-r-sdk.com/docs/ssmsap_register_application/ for full documentation.
Usage
ssmsap_register_application(
ApplicationId,
ApplicationType,
Instances,
SapInstanceNumber = NULL,
Sid = NULL,
Tags = NULL,
Credentials = NULL,
DatabaseArn = NULL,
ComponentsInfo = NULL
)
Arguments
ApplicationId |
[required] The ID of the application. |
ApplicationType |
[required] The type of the application. |
Instances |
[required] The Amazon EC2 instances on which your SAP application is running. |
SapInstanceNumber |
The SAP instance number of the application. |
Sid |
The System ID of the application. |
Tags |
The tags to be attached to the SAP application. |
Credentials |
The credentials of the SAP application. |
DatabaseArn |
The Amazon Resource Name of the SAP HANA database. |
ComponentsInfo |
This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher. This is an array of ApplicationComponent objects. You may input 0 to 5 items. |
Request is an operation which starts an application
Description
Request is an operation which starts an application.
See https://www.paws-r-sdk.com/docs/ssmsap_start_application/ for full documentation.
Usage
ssmsap_start_application(ApplicationId)
Arguments
ApplicationId |
[required] The ID of the application. |
Refreshes a registered application
Description
Refreshes a registered application.
See https://www.paws-r-sdk.com/docs/ssmsap_start_application_refresh/ for full documentation.
Usage
ssmsap_start_application_refresh(ApplicationId)
Arguments
ApplicationId |
[required] The ID of the application. |
Request is an operation to stop an application
Description
Request is an operation to stop an application.
See https://www.paws-r-sdk.com/docs/ssmsap_stop_application/ for full documentation.
Usage
ssmsap_stop_application(
ApplicationId,
StopConnectedEntity = NULL,
IncludeEc2InstanceShutdown = NULL
)
Arguments
ApplicationId |
[required] The ID of the application. |
StopConnectedEntity |
Specify the If this parameter is included, the connected DBMS (Database Management System) will be stopped. |
IncludeEc2InstanceShutdown |
Boolean. If included and if set to |
Creates tag for a resource by specifying the ARN
Description
Creates tag for a resource by specifying the ARN.
See https://www.paws-r-sdk.com/docs/ssmsap_tag_resource/ for full documentation.
Usage
ssmsap_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tags |
[required] The tags on a resource. |
Delete the tags for a resource
Description
Delete the tags for a resource.
See https://www.paws-r-sdk.com/docs/ssmsap_untag_resource/ for full documentation.
Usage
ssmsap_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tagKeys |
[required] Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP. |
Updates the settings of an application registered with AWS Systems Manager for SAP
Description
Updates the settings of an application registered with AWS Systems Manager for SAP.
See https://www.paws-r-sdk.com/docs/ssmsap_update_application_settings/ for full documentation.
Usage
ssmsap_update_application_settings(
ApplicationId,
CredentialsToAddOrUpdate = NULL,
CredentialsToRemove = NULL,
Backint = NULL,
DatabaseArn = NULL
)
Arguments
ApplicationId |
[required] The ID of the application. |
CredentialsToAddOrUpdate |
The credentials to be added or updated. |
CredentialsToRemove |
The credentials to be removed. |
Backint |
Installation of AWS Backint Agent for SAP HANA. |
DatabaseArn |
The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application. |
AWS Support
Description
Amazon Web Services Support
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:
The
create_case,describe_cases,describe_attachment, andresolve_caseoperations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.The
describe_communications,add_communication_to_case, andadd_attachments_to_setoperations retrieve and add communications and attachments to Amazon Web Services Support cases.The
describe_servicesanddescribe_severity_levelsoperations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call thecreate_caseoperation.
You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
Usage
support(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- support(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| add_attachments_to_set | Adds one or more attachments to an attachment set |
| add_communication_to_case | Adds additional customer communication to an Amazon Web Services Support case |
| create_case | Creates a case in the Amazon Web Services Support Center |
| describe_attachment | Returns the attachment that has the specified ID |
| describe_cases | Returns a list of cases that you specify by passing one or more case IDs |
| describe_communications | Returns communications and attachments for one or more support cases |
| describe_create_case_options | Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability |
| describe_services | Returns the current list of Amazon Web Services services and a list of service categories for each service |
| describe_severity_levels | Returns the list of severity levels that you can assign to a support case |
| describe_supported_languages | Returns a list of supported languages for a specified categoryCode, issueType and serviceCode |
| describe_trusted_advisor_check_refresh_statuses | Returns the refresh status of the Trusted Advisor checks that have the specified check IDs |
| describe_trusted_advisor_check_result | Returns the results of the Trusted Advisor check that has the specified check ID |
| describe_trusted_advisor_checks | Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata |
| describe_trusted_advisor_check_summaries | Returns the results for the Trusted Advisor check summaries for the check IDs that you specified |
| refresh_trusted_advisor_check | Refreshes the Trusted Advisor check that you specify using the check ID |
| resolve_case | Resolves a support case |
Examples
## Not run:
svc <- support()
svc$add_attachments_to_set(
Foo = 123
)
## End(Not run)
Adds one or more attachments to an attachment set
Description
Adds one or more attachments to an attachment set.
See https://www.paws-r-sdk.com/docs/support_add_attachments_to_set/ for full documentation.
Usage
support_add_attachments_to_set(attachmentSetId = NULL, attachments)
Arguments
attachmentSetId |
The ID of the attachment set. If an |
attachments |
[required] One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment. In the |
Adds additional customer communication to an Amazon Web Services Support case
Description
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.
See https://www.paws-r-sdk.com/docs/support_add_communication_to_case/ for full documentation.
Usage
support_add_communication_to_case(
caseId = NULL,
communicationBody,
ccEmailAddresses = NULL,
attachmentSetId = NULL
)
Arguments
caseId |
The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 |
communicationBody |
[required] The body of an email communication to add to the support case. |
ccEmailAddresses |
The email addresses in the CC line of an email to be added to the support case. |
attachmentSetId |
The ID of a set of one or more attachments for the communication to add
to the case. Create the set by calling
|
Creates a case in the Amazon Web Services Support Center
Description
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
See https://www.paws-r-sdk.com/docs/support_create_case/ for full documentation.
Usage
support_create_case(
subject,
serviceCode = NULL,
severityCode = NULL,
categoryCode = NULL,
communicationBody,
ccEmailAddresses = NULL,
language = NULL,
issueType = NULL,
attachmentSetId = NULL
)
Arguments
subject |
[required] The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page. |
serviceCode |
The code for the Amazon Web Services service. You can use the
|
severityCode |
A value that indicates the urgency of the case. This value determines
the response time according to your service level agreement with Amazon
Web Services Support. You can use the
For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide. The availability of severity levels depends on the support plan for the Amazon Web Services account. |
categoryCode |
The category of problem for the support case. You also use the
|
communicationBody |
[required] The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page. |
ccEmailAddresses |
A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs. |
language |
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports Chinese (“zh”), English
("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO
639-1 code for the |
issueType |
The type of issue for the case. You can specify |
attachmentSetId |
The ID of a set of one or more attachments for the case. Create the set
by using the |
Returns the attachment that has the specified ID
Description
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the describe_communications operation.
See https://www.paws-r-sdk.com/docs/support_describe_attachment/ for full documentation.
Usage
support_describe_attachment(attachmentId)
Arguments
attachmentId |
[required] The ID of the attachment to return. Attachment IDs are returned by the
|
Returns a list of cases that you specify by passing one or more case IDs
Description
Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.
See https://www.paws-r-sdk.com/docs/support_describe_cases/ for full documentation.
Usage
support_describe_cases(
caseIdList = NULL,
displayId = NULL,
afterTime = NULL,
beforeTime = NULL,
includeResolvedCases = NULL,
nextToken = NULL,
maxResults = NULL,
language = NULL,
includeCommunications = NULL
)
Arguments
caseIdList |
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. |
displayId |
The ID displayed for a case in the Amazon Web Services Support Center user interface. |
afterTime |
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. |
beforeTime |
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. |
includeResolvedCases |
Specifies whether to include resolved support cases in the
|
nextToken |
A resumption point for pagination. |
maxResults |
The maximum number of results to return before paginating. |
language |
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports Chinese (“zh”), English
("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO
639-1 code for the |
includeCommunications |
Specifies whether to include communications in the
|
Returns communications and attachments for one or more support cases
Description
Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.
See https://www.paws-r-sdk.com/docs/support_describe_communications/ for full documentation.
Usage
support_describe_communications(
caseId,
beforeTime = NULL,
afterTime = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
caseId |
[required] The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 |
beforeTime |
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. |
afterTime |
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. |
nextToken |
A resumption point for pagination. |
maxResults |
The maximum number of results to return before paginating. |
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability
Description
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.
See https://www.paws-r-sdk.com/docs/support_describe_create_case_options/ for full documentation.
Usage
support_describe_create_case_options(
issueType,
serviceCode,
language,
categoryCode
)
Arguments
issueType |
[required] The type of issue for the case. You can specify |
serviceCode |
[required] The code for the Amazon Web Services service. You can use the
|
language |
[required] The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports Chinese (“zh”), English
("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO
639-1 code for the |
categoryCode |
[required] The category of problem for the support case. You also use the
|
Returns the current list of Amazon Web Services services and a list of service categories for each service
Description
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your create_case requests. Each Amazon Web Services service has its own set of categories.
See https://www.paws-r-sdk.com/docs/support_describe_services/ for full documentation.
Usage
support_describe_services(serviceCodeList = NULL, language = NULL)
Arguments
serviceCodeList |
A JSON-formatted list of service codes available for Amazon Web Services services. |
language |
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports Chinese (“zh”), English
("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO
639-1 code for the |
Returns the list of severity levels that you can assign to a support case
Description
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a create_case request.
See https://www.paws-r-sdk.com/docs/support_describe_severity_levels/ for full documentation.
Usage
support_describe_severity_levels(language = NULL)
Arguments
language |
The language in which Amazon Web Services Support handles the case.
Amazon Web Services Support currently supports Chinese (“zh”), English
("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO
639-1 code for the |
Returns a list of supported languages for a specified categoryCode, issueType and serviceCode
Description
Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.
See https://www.paws-r-sdk.com/docs/support_describe_supported_languages/ for full documentation.
Usage
support_describe_supported_languages(issueType, serviceCode, categoryCode)
Arguments
issueType |
[required] The type of issue for the case. You can specify |
serviceCode |
[required] The code for the Amazon Web Services service. You can use the
|
categoryCode |
[required] The category of problem for the support case. You also use the
|
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs
Description
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the describe_trusted_advisor_checks operation.
See https://www.paws-r-sdk.com/docs/support_describe_trusted_advisor_check_refresh_statuses/ for full documentation.
Usage
support_describe_trusted_advisor_check_refresh_statuses(checkIds)
Arguments
checkIds |
[required] The IDs of the Trusted Advisor checks to get the status. If you specify the check ID of a check that is automatically refreshed,
you might see an |
Returns the results of the Trusted Advisor check that has the specified check ID
Description
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the describe_trusted_advisor_checks operation.
See https://www.paws-r-sdk.com/docs/support_describe_trusted_advisor_check_result/ for full documentation.
Usage
support_describe_trusted_advisor_check_result(checkId, language = NULL)
Arguments
checkId |
[required] The unique identifier for the Trusted Advisor check. |
language |
The ISO 639-1 code for the language that you want your check results to appear in. The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:
|
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified
Description
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the describe_trusted_advisor_checks operation.
See https://www.paws-r-sdk.com/docs/support_describe_trusted_advisor_check_summaries/ for full documentation.
Usage
support_describe_trusted_advisor_check_summaries(checkIds)
Arguments
checkIds |
[required] The IDs of the Trusted Advisor checks. |
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata
Description
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.
See https://www.paws-r-sdk.com/docs/support_describe_trusted_advisor_checks/ for full documentation.
Usage
support_describe_trusted_advisor_checks(language)
Arguments
language |
[required] The ISO 639-1 code for the language that you want your checks to appear in. The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:
|
Refreshes the Trusted Advisor check that you specify using the check ID
Description
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the describe_trusted_advisor_checks operation.
See https://www.paws-r-sdk.com/docs/support_refresh_trusted_advisor_check/ for full documentation.
Usage
support_refresh_trusted_advisor_check(checkId)
Arguments
checkId |
[required] The unique identifier for the Trusted Advisor check to refresh. Specifying the check ID of a check that is automatically refreshed
causes an |
Resolves a support case
Description
Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.
See https://www.paws-r-sdk.com/docs/support_resolve_case/ for full documentation.
Usage
support_resolve_case(caseId = NULL)
Arguments
caseId |
The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 |
AWS Support App
Description
Amazon Web Services Support App in Slack
You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:
Create, search, update, and resolve your support cases
Request service quota increases for your account
Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases
For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:
You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.
You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.
For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General Reference.
Usage
supportapp(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- supportapp(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| create_slack_channel_configuration | Creates a Slack channel configuration for your Amazon Web Services account |
| delete_account_alias | Deletes an alias for an Amazon Web Services account ID |
| delete_slack_channel_configuration | Deletes a Slack channel configuration from your Amazon Web Services account |
| delete_slack_workspace_configuration | Deletes a Slack workspace configuration from your Amazon Web Services account |
| get_account_alias | Retrieves the alias from an Amazon Web Services account ID |
| list_slack_channel_configurations | Lists the Slack channel configurations for an Amazon Web Services account |
| list_slack_workspace_configurations | Lists the Slack workspace configurations for an Amazon Web Services account |
| put_account_alias | Creates or updates an individual alias for each Amazon Web Services account ID |
| register_slack_workspace_for_organization | Registers a Slack workspace for your Amazon Web Services account |
| update_slack_channel_configuration | Updates the configuration for a Slack channel, such as case update notifications |
Examples
## Not run:
svc <- supportapp()
svc$create_slack_channel_configuration(
Foo = 123
)
## End(Not run)
Creates a Slack channel configuration for your Amazon Web Services account
Description
Creates a Slack channel configuration for your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/supportapp_create_slack_channel_configuration/ for full documentation.
Usage
supportapp_create_slack_channel_configuration(
channelId,
channelName = NULL,
channelRoleArn,
notifyOnAddCorrespondenceToCase = NULL,
notifyOnCaseSeverity,
notifyOnCreateOrReopenCase = NULL,
notifyOnResolveCase = NULL,
teamId
)
Arguments
channelId |
[required] The channel ID in Slack. This ID identifies a channel within a Slack workspace. |
channelName |
The name of the Slack channel that you configure for the Amazon Web Services Support App. |
channelRoleArn |
[required] The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide. |
notifyOnAddCorrespondenceToCase |
Whether you want to get notified when a support case has a new correspondence. |
notifyOnCaseSeverity |
[required] The case severity for a support case that you want to receive notifications. If you specify
If you specify
If you don't specify these parameters in your request, they default to
|
notifyOnCreateOrReopenCase |
Whether you want to get notified when a support case is created or reopened. |
notifyOnResolveCase |
Whether you want to get notified when a support case is resolved. |
teamId |
[required] The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as |
Deletes an alias for an Amazon Web Services account ID
Description
Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
See https://www.paws-r-sdk.com/docs/supportapp_delete_account_alias/ for full documentation.
Usage
supportapp_delete_account_alias()
Deletes a Slack channel configuration from your Amazon Web Services account
Description
Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.
See https://www.paws-r-sdk.com/docs/supportapp_delete_slack_channel_configuration/ for full documentation.
Usage
supportapp_delete_slack_channel_configuration(channelId, teamId)
Arguments
channelId |
[required] The channel ID in Slack. This ID identifies a channel within a Slack workspace. |
teamId |
[required] The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as |
Deletes a Slack workspace configuration from your Amazon Web Services account
Description
Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.
See https://www.paws-r-sdk.com/docs/supportapp_delete_slack_workspace_configuration/ for full documentation.
Usage
supportapp_delete_slack_workspace_configuration(teamId)
Arguments
teamId |
[required] The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as |
Retrieves the alias from an Amazon Web Services account ID
Description
Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
See https://www.paws-r-sdk.com/docs/supportapp_get_account_alias/ for full documentation.
Usage
supportapp_get_account_alias()
Lists the Slack channel configurations for an Amazon Web Services account
Description
Lists the Slack channel configurations for an Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/supportapp_list_slack_channel_configurations/ for full documentation.
Usage
supportapp_list_slack_channel_configurations(nextToken = NULL)
Arguments
nextToken |
If the results of a search are large, the API only returns a portion of
the results and includes a |
Lists the Slack workspace configurations for an Amazon Web Services account
Description
Lists the Slack workspace configurations for an Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/supportapp_list_slack_workspace_configurations/ for full documentation.
Usage
supportapp_list_slack_workspace_configurations(nextToken = NULL)
Arguments
nextToken |
If the results of a search are large, the API only returns a portion of
the results and includes a |
Creates or updates an individual alias for each Amazon Web Services account ID
Description
Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
See https://www.paws-r-sdk.com/docs/supportapp_put_account_alias/ for full documentation.
Usage
supportapp_put_account_alias(accountAlias)
Arguments
accountAlias |
[required] An alias or short name for an Amazon Web Services account. |
Registers a Slack workspace for your Amazon Web Services account
Description
Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.
See https://www.paws-r-sdk.com/docs/supportapp_register_slack_workspace_for_organization/ for full documentation.
Usage
supportapp_register_slack_workspace_for_organization(teamId)
Arguments
teamId |
[required] The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as |
Updates the configuration for a Slack channel, such as case update notifications
Description
Updates the configuration for a Slack channel, such as case update notifications.
See https://www.paws-r-sdk.com/docs/supportapp_update_slack_channel_configuration/ for full documentation.
Usage
supportapp_update_slack_channel_configuration(
channelId,
channelName = NULL,
channelRoleArn = NULL,
notifyOnAddCorrespondenceToCase = NULL,
notifyOnCaseSeverity = NULL,
notifyOnCreateOrReopenCase = NULL,
notifyOnResolveCase = NULL,
teamId
)
Arguments
channelId |
[required] The channel ID in Slack. This ID identifies a channel within a Slack workspace. |
channelName |
The Slack channel name that you want to update. |
channelRoleArn |
The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide. |
notifyOnAddCorrespondenceToCase |
Whether you want to get notified when a support case has a new correspondence. |
notifyOnCaseSeverity |
The case severity for a support case that you want to receive notifications. If you specify
If you specify
If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default. |
notifyOnCreateOrReopenCase |
Whether you want to get notified when a support case is created or reopened. |
notifyOnResolveCase |
Whether you want to get notified when a support case is resolved. |
teamId |
[required] The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as |
Synthetics
Description
Amazon CloudWatch Synthetics
You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.
Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.
Usage
synthetics(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- synthetics(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations
| associate_resource | Associates a canary with a group |
| create_canary | Creates a canary |
| create_group | Creates a group which you can use to associate canaries with each other, including cross-Region canaries |
| delete_canary | Permanently deletes the specified canary |
| delete_group | Deletes a group |
| describe_canaries | This operation returns a list of the canaries in your account, along with full details about each canary |
| describe_canaries_last_run | Use this operation to see information from the most recent run of each canary that you have created |
| describe_runtime_versions | Returns a list of Synthetics canary runtime versions |
| disassociate_resource | Removes a canary from a group |
| get_canary | Retrieves complete information about one canary |
| get_canary_runs | Retrieves a list of runs for a specified canary |
| get_group | Returns information about one group |
| list_associated_groups | Returns a list of the groups that the specified canary is associated with |
| list_group_resources | This operation returns a list of the ARNs of the canaries that are associated with the specified group |
| list_groups | Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs |
| list_tags_for_resource | Displays the tags associated with a canary or group |
| start_canary | Use this operation to run a canary that has already been created |
| stop_canary | Stops the canary to prevent all future runs |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified canary or group |
| untag_resource | Removes one or more tags from the specified resource |
| update_canary | Updates the configuration of a canary that has already been created |
Examples
## Not run:
svc <- synthetics()
svc$associate_resource(
Foo = 123
)
## End(Not run)
Associates a canary with a group
Description
Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
See https://www.paws-r-sdk.com/docs/synthetics_associate_resource/ for full documentation.
Usage
synthetics_associate_resource(GroupIdentifier, ResourceArn)
Arguments
GroupIdentifier |
[required] Specifies the group. You can specify the group name, the ARN, or the
group ID as the |
ResourceArn |
[required] The ARN of the canary that you want to associate with the specified group. |
Creates a canary
Description
Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
See https://www.paws-r-sdk.com/docs/synthetics_create_canary/ for full documentation.
Usage
synthetics_create_canary(
Name,
Code,
ArtifactS3Location,
ExecutionRoleArn,
Schedule,
RunConfig = NULL,
SuccessRetentionPeriodInDays = NULL,
FailureRetentionPeriodInDays = NULL,
RuntimeVersion,
VpcConfig = NULL,
ResourcesToReplicateTags = NULL,
ProvisionedResourceCleanup = NULL,
Tags = NULL,
ArtifactConfig = NULL
)
Arguments
Name |
[required] The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries. |
Code |
[required] A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. |
ArtifactS3Location |
[required] The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.). |
ExecutionRoleArn |
[required] The ARN of the IAM role to be used to run the canary. This role must
already exist, and must include
|
Schedule |
[required] A structure that contains information about how often the canary is to run and when these test runs are to stop. |
RunConfig |
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables. The environment variables keys and values are not encrypted. Do not store sensitive information in this field. |
SuccessRetentionPeriodInDays |
The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. |
FailureRetentionPeriodInDays |
The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. |
RuntimeVersion |
[required] Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions. |
VpcConfig |
If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. |
ResourcesToReplicateTags |
To have the tags that you apply to this canary also be applied to the
Lambda function that the canary uses, specify this parameter with the
value If you specify this parameter and don't specify any tags in the |
ProvisionedResourceCleanup |
Specifies whether to also delete the Lambda functions and layers used by
this canary when the canary is deleted. If you omit this parameter, the
default of If the value of this parameter is |
Tags |
A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. To have the tags that you apply to this canary also be applied to the
Lambda function that the canary uses, specify this parameter with the
value |
ArtifactConfig |
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. |
Creates a group which you can use to associate canaries with each other, including cross-Region canaries
Description
Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
See https://www.paws-r-sdk.com/docs/synthetics_create_group/ for full documentation.
Usage
synthetics_create_group(Name, Tags = NULL)
Arguments
Name |
[required] The name for the group. It can include any Unicode characters. The names for all groups in your account, across all Regions, must be unique. |
Tags |
A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. |
Permanently deletes the specified canary
Description
Permanently deletes the specified canary.
See https://www.paws-r-sdk.com/docs/synthetics_delete_canary/ for full documentation.
Usage
synthetics_delete_canary(Name, DeleteLambda = NULL)
Arguments
Name |
[required] The name of the canary that you want to delete. To find the names of
your canaries, use |
DeleteLambda |
Specifies whether to also delete the Lambda functions and layers used by
this canary. The default is Your setting for this parameter is used only if the canary doesn't have
Type: Boolean |
Deletes a group
Description
Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.
See https://www.paws-r-sdk.com/docs/synthetics_delete_group/ for full documentation.
Usage
synthetics_delete_group(GroupIdentifier)
Arguments
GroupIdentifier |
[required] Specifies which group to delete. You can specify the group name, the
ARN, or the group ID as the |
This operation returns a list of the canaries in your account, along with full details about each canary
Description
This operation returns a list of the canaries in your account, along with full details about each canary.
See https://www.paws-r-sdk.com/docs/synthetics_describe_canaries/ for full documentation.
Usage
synthetics_describe_canaries(NextToken = NULL, MaxResults = NULL, Names = NULL)
Arguments
NextToken |
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. |
MaxResults |
Specify this parameter to limit how many canaries are returned each time
you use the |
Names |
Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names. If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries. |
Use this operation to see information from the most recent run of each canary that you have created
Description
Use this operation to see information from the most recent run of each canary that you have created.
See https://www.paws-r-sdk.com/docs/synthetics_describe_canaries_last_run/ for full documentation.
Usage
synthetics_describe_canaries_last_run(
NextToken = NULL,
MaxResults = NULL,
Names = NULL
)
Arguments
NextToken |
A token that indicates that there is more data available. You can use
this token in a subsequent
|
MaxResults |
Specify this parameter to limit how many runs are returned each time you
use the |
Names |
Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names. If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the |
Returns a list of Synthetics canary runtime versions
Description
Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
See https://www.paws-r-sdk.com/docs/synthetics_describe_runtime_versions/ for full documentation.
Usage
synthetics_describe_runtime_versions(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
A token that indicates that there is more data available. You can use
this token in a subsequent
|
MaxResults |
Specify this parameter to limit how many runs are returned each time you
use the
|
Removes a canary from a group
Description
Removes a canary from a group. You must run this operation in the Region where the canary exists.
See https://www.paws-r-sdk.com/docs/synthetics_disassociate_resource/ for full documentation.
Usage
synthetics_disassociate_resource(GroupIdentifier, ResourceArn)
Arguments
GroupIdentifier |
[required] Specifies the group. You can specify the group name, the ARN, or the
group ID as the |
ResourceArn |
[required] The ARN of the canary that you want to remove from the specified group. |
Retrieves complete information about one canary
Description
Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use describe_canaries.
See https://www.paws-r-sdk.com/docs/synthetics_get_canary/ for full documentation.
Usage
synthetics_get_canary(Name)
Arguments
Name |
[required] The name of the canary that you want details for. |
Retrieves a list of runs for a specified canary
Description
Retrieves a list of runs for a specified canary.
See https://www.paws-r-sdk.com/docs/synthetics_get_canary_runs/ for full documentation.
Usage
synthetics_get_canary_runs(Name, NextToken = NULL, MaxResults = NULL)
Arguments
Name |
[required] The name of the canary that you want to see runs for. |
NextToken |
A token that indicates that there is more data available. You can use
this token in a subsequent
|
MaxResults |
Specify this parameter to limit how many runs are returned each time you
use the |
Returns information about one group
Description
Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
See https://www.paws-r-sdk.com/docs/synthetics_get_group/ for full documentation.
Usage
synthetics_get_group(GroupIdentifier)
Arguments
GroupIdentifier |
[required] Specifies the group to return information for. You can specify the group
name, the ARN, or the group ID as the |
Returns a list of the groups that the specified canary is associated with
Description
Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
See https://www.paws-r-sdk.com/docs/synthetics_list_associated_groups/ for full documentation.
Usage
synthetics_list_associated_groups(
NextToken = NULL,
MaxResults = NULL,
ResourceArn
)
Arguments
NextToken |
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. |
MaxResults |
Specify this parameter to limit how many groups are returned each time
you use the
|
ResourceArn |
[required] The ARN of the canary that you want to view groups for. |
This operation returns a list of the ARNs of the canaries that are associated with the specified group
Description
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
See https://www.paws-r-sdk.com/docs/synthetics_list_group_resources/ for full documentation.
Usage
synthetics_list_group_resources(
NextToken = NULL,
MaxResults = NULL,
GroupIdentifier
)
Arguments
NextToken |
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. |
MaxResults |
Specify this parameter to limit how many canary ARNs are returned each
time you use the
|
GroupIdentifier |
[required] Specifies the group to return information for. You can specify the group
name, the ARN, or the group ID as the |
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs
Description
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
See https://www.paws-r-sdk.com/docs/synthetics_list_groups/ for full documentation.
Usage
synthetics_list_groups(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. |
MaxResults |
Specify this parameter to limit how many groups are returned each time
you use the |
Displays the tags associated with a canary or group
Description
Displays the tags associated with a canary or group.
See https://www.paws-r-sdk.com/docs/synthetics_list_tags_for_resource/ for full documentation.
Usage
synthetics_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The ARN of the canary or group that you want to view tags for. The ARN format of a canary is
The ARN format of a group is
|
Use this operation to run a canary that has already been created
Description
Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use get_canary.
See https://www.paws-r-sdk.com/docs/synthetics_start_canary/ for full documentation.
Usage
synthetics_start_canary(Name)
Arguments
Name |
[required] The name of the canary that you want to run. To find canary names, use
|
Stops the canary to prevent all future runs
Description
Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
See https://www.paws-r-sdk.com/docs/synthetics_stop_canary/ for full documentation.
Usage
synthetics_stop_canary(Name)
Arguments
Name |
[required] The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries. |
Assigns one or more tags (key-value pairs) to the specified canary or group
Description
Assigns one or more tags (key-value pairs) to the specified canary or group.
See https://www.paws-r-sdk.com/docs/synthetics_tag_resource/ for full documentation.
Usage
synthetics_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The ARN of the canary or group that you're adding tags to. The ARN format of a canary is
The ARN format of a group is
|
Tags |
[required] The list of key-value pairs to associate with the resource. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/synthetics_untag_resource/ for full documentation.
Usage
synthetics_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The ARN of the canary or group that you're removing tags from. The ARN format of a canary is
The ARN format of a group is
|
TagKeys |
[required] The list of tag keys to remove from the resource. |
Updates the configuration of a canary that has already been created
Description
Updates the configuration of a canary that has already been created.
See https://www.paws-r-sdk.com/docs/synthetics_update_canary/ for full documentation.
Usage
synthetics_update_canary(
Name,
Code = NULL,
ExecutionRoleArn = NULL,
RuntimeVersion = NULL,
Schedule = NULL,
RunConfig = NULL,
SuccessRetentionPeriodInDays = NULL,
FailureRetentionPeriodInDays = NULL,
VpcConfig = NULL,
VisualReference = NULL,
ArtifactS3Location = NULL,
ArtifactConfig = NULL,
ProvisionedResourceCleanup = NULL
)
Arguments
Name |
[required] The name of the canary that you want to update. To find the names of
your canaries, use You cannot change the name of a canary that has already been created. |
Code |
A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. |
ExecutionRoleArn |
The ARN of the IAM role to be used to run the canary. This role must
already exist, and must include
|
RuntimeVersion |
Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions. |
Schedule |
A structure that contains information about how often the canary is to run, and when these runs are to stop. |
RunConfig |
A structure that contains the timeout value that is used for each individual run of the canary. The environment variables keys and values are not encrypted. Do not store sensitive information in this field. |
SuccessRetentionPeriodInDays |
The number of days to retain data about successful runs of this canary. |
FailureRetentionPeriodInDays |
The number of days to retain data about failed runs of this canary. |
VpcConfig |
If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. |
VisualReference |
Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint |
ArtifactS3Location |
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.). |
ArtifactConfig |
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. |
ProvisionedResourceCleanup |
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is |