Title: | 'Amazon Web Services' Cost Management Services |
---|---|
Description: | Interface to 'Amazon Web Services' cost management services, including cost and usage reports, budgets, pricing, and more <https://aws.amazon.com/>. |
Authors: | David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph] |
Maintainer: | Dyfan Jones <[email protected]> |
License: | Apache License (>= 2.0) |
Version: | 0.7.0 |
Built: | 2024-11-03 05:53:45 UTC |
Source: | https://github.com/paws-r/paws |
Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a proforma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.
billingconductor( config = list(), credentials = list(), endpoint = NULL, region = NULL )
billingconductor( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- billingconductor( 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" )
associate_accounts | Connects an array of account IDs in a consolidated billing family to a predefined billing group |
associate_pricing_rules | Connects an array of PricingRuleArns to a defined PricingPlan |
batch_associate_resources_to_custom_line_item | Associates a batch of resources to a percentage custom line item |
batch_disassociate_resources_from_custom_line_item | Disassociates a batch of resources from a percentage custom line item |
create_billing_group | Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation |
create_custom_line_item | Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period |
create_pricing_plan | Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups |
create_pricing_rule | Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans |
delete_billing_group | Deletes a billing group |
delete_custom_line_item | Deletes the custom line item identified by the given ARN in the current, or previous billing period |
delete_pricing_plan | Deletes a pricing plan |
delete_pricing_rule | Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN) |
disassociate_accounts | Removes the specified list of account IDs from the given billing group |
disassociate_pricing_rules | Disassociates a list of pricing rules from a pricing plan |
get_billing_group_cost_report | Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group |
list_account_associations | This is a paginated call to list linked accounts that are linked to the payer account for the specified time period |
list_billing_group_cost_reports | A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group |
list_billing_groups | A paginated call to retrieve a list of billing groups for the given billing period |
list_custom_line_items | A paginated call to get a list of all custom line items (FFLIs) for the given billing period |
list_custom_line_item_versions | A paginated call to get a list of all custom line item versions |
list_pricing_plans | A paginated call to get pricing plans for the given billing period |
list_pricing_plans_associated_with_pricing_rule | A list of the pricing plans that are associated with a pricing rule |
list_pricing_rules | Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans |
list_pricing_rules_associated_to_pricing_plan | Lists the pricing rules that are associated with a pricing plan |
list_resources_associated_to_custom_line_item | List the resources that are associated to a custom line item |
list_tags_for_resource | A list the tags for a resource |
tag_resource | Associates the specified tags to a resource with the specified resourceArn |
untag_resource | Deletes specified tags from a resource |
update_billing_group | This updates an existing billing group |
update_custom_line_item | Update an existing custom line item in the current or previous billing period |
update_pricing_plan | This updates an existing pricing plan |
update_pricing_rule | Updates an existing pricing rule |
## Not run: svc <- billingconductor() svc$associate_accounts( Foo = 123 ) ## End(Not run)
## Not run: svc <- billingconductor() svc$associate_accounts( Foo = 123 ) ## End(Not run)
Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.
Budgets provide you with a way to see the following information:
How close your plan is to your budgeted amount or to the free tier limits
Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
Cost budgets - Plan how much you want to spend on a service.
Usage budgets - Plan how much you want to use one or more services.
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The Amazon Web Services Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
budgets(config = list(), credentials = list(), endpoint = NULL, region = NULL)
budgets(config = list(), credentials = list(), endpoint = NULL, region = NULL)
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. |
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.
svc <- budgets( 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" )
create_budget | Creates a budget and, if included, notifications and subscribers |
create_budget_action | Creates a budget action |
create_notification | Creates a notification |
create_subscriber | Creates a subscriber |
delete_budget | Deletes a budget |
delete_budget_action | Deletes a budget action |
delete_notification | Deletes a notification |
delete_subscriber | Deletes a subscriber |
describe_budget | Describes a budget |
describe_budget_action | Describes a budget action detail |
describe_budget_action_histories | Describes a budget action history detail |
describe_budget_actions_for_account | Describes all of the budget actions for an account |
describe_budget_actions_for_budget | Describes all of the budget actions for a budget |
describe_budget_notifications_for_account | Lists the budget names and notifications that are associated with an account |
describe_budget_performance_history | Describes the history for DAILY, MONTHLY, and QUARTERLY budgets |
describe_budgets | Lists the budgets that are associated with an account |
describe_notifications_for_budget | Lists the notifications that are associated with a budget |
describe_subscribers_for_notification | Lists the subscribers that are associated with a notification |
execute_budget_action | Executes a budget action |
list_tags_for_resource | Lists tags associated with a budget or budget action resource |
tag_resource | Creates tags for a budget or budget action resource |
untag_resource | Deletes tags associated with a budget or budget action resource |
update_budget | Updates a budget |
update_budget_action | Updates a budget action |
update_notification | Updates a notification |
update_subscriber | Updates a subscriber |
## Not run: svc <- budgets() svc$create_budget( Foo = 123 ) ## End(Not run)
## Not run: svc <- budgets() svc$create_budget( Foo = 123 ) ## End(Not run)
You can use the Amazon Web Services Cost and Usage Report API to programmatically create, query, and delete Amazon Web Services Cost and Usage Report definitions.
Amazon Web Services Cost and Usage Report track the monthly Amazon Web Services costs and usage associated with your Amazon Web Services account. The report contains line items for each unique combination of Amazon Web Services product, usage type, and operation that your Amazon Web Services account uses. You can configure the Amazon Web Services Cost and Usage Report to show only the data that you want, using the Amazon Web Services Cost and Usage Report API.
Service Endpoint
The Amazon Web Services Cost and Usage Report API provides the following endpoint:
cur.us-east-1.amazonaws.com
costandusagereportservice( config = list(), credentials = list(), endpoint = NULL, region = NULL )
costandusagereportservice( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- costandusagereportservice( 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" )
delete_report_definition | Deletes the specified report |
describe_report_definitions | Lists the Amazon Web Services Cost and Usage Report available to this account |
list_tags_for_resource | Lists the tags associated with the specified report definition |
modify_report_definition | Allows you to programmatically update your report preferences |
put_report_definition | Creates a new report using the description that you provide |
tag_resource | Associates a set of tags with a report definition |
untag_resource | Disassociates a set of tags from a report definition |
## Not run: svc <- costandusagereportservice() # The following example deletes the AWS Cost and Usage report named # ExampleReport. svc$delete_report_definition( ReportName = "ExampleReport" ) ## End(Not run)
## Not run: svc <- costandusagereportservice() # The following example deletes the AWS Cost and Usage report named # ExampleReport. svc$delete_report_definition( ReportName = "ExampleReport" ) ## End(Not run)
You can use the Cost Explorer API to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data. This might include the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
For information about the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.
costexplorer( config = list(), credentials = list(), endpoint = NULL, region = NULL )
costexplorer( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- costexplorer( 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" )
create_anomaly_monitor | Creates a new cost anomaly detection monitor with the requested type and monitor specification |
create_anomaly_subscription | Adds an alert subscription to a cost anomaly detection monitor |
create_cost_category_definition | Creates a new Cost Category with the requested name and rules |
delete_anomaly_monitor | Deletes a cost anomaly monitor |
delete_anomaly_subscription | Deletes a cost anomaly subscription |
delete_cost_category_definition | Deletes a Cost Category |
describe_cost_category_definition | Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account |
get_anomalies | Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object |
get_anomaly_monitors | Retrieves the cost anomaly monitor definitions for your account |
get_anomaly_subscriptions | Retrieves the cost anomaly subscription objects for your account |
get_approximate_usage_records | Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity |
get_cost_and_usage | Retrieves cost and usage metrics for your account |
get_cost_and_usage_with_resources | Retrieves cost and usage metrics with resources for your account |
get_cost_categories | Retrieves an array of Cost Category names and values incurred cost |
get_cost_forecast | Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs |
get_dimension_values | Retrieves all available filter values for a specified filter over a period of time |
get_reservation_coverage | Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation |
get_reservation_purchase_recommendation | Gets recommendations for reservation purchases |
get_reservation_utilization | Retrieves the reservation utilization for your account |
get_rightsizing_recommendation | Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances |
get_savings_plan_purchase_recommendation_details | Retrieves the details for a Savings Plan recommendation |
get_savings_plans_coverage | Retrieves the Savings Plans covered for your account |
get_savings_plans_purchase_recommendation | Retrieves the Savings Plans recommendations for your account |
get_savings_plans_utilization | Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity |
get_savings_plans_utilization_details | Retrieves attribute data along with aggregate utilization and savings data for a given time period |
get_tags | Queries for available tag keys and tag values for a specified period |
get_usage_forecast | Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage |
list_cost_allocation_tag_backfill_history | Retrieves a list of your historical cost allocation tag backfill requests |
list_cost_allocation_tags | Get a list of cost allocation tags |
list_cost_category_definitions | Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account |
list_savings_plans_purchase_recommendation_generation | Retrieves a list of your historical recommendation generations within the past 30 days |
list_tags_for_resource | Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN) |
provide_anomaly_feedback | Modifies the feedback property of a given cost anomaly |
start_cost_allocation_tag_backfill | Request a cost allocation tag backfill |
start_savings_plans_purchase_recommendation_generation | Requests a Savings Plans recommendation generation |
tag_resource | An API operation for adding one or more tags (key-value pairs) to a resource |
untag_resource | Removes one or more tags from a resource |
update_anomaly_monitor | Updates an existing cost anomaly monitor |
update_anomaly_subscription | Updates an existing cost anomaly subscription |
update_cost_allocation_tags_status | Updates status for cost allocation tags in bulk, with maximum batch size of 20 |
update_cost_category_definition | Updates an existing Cost Category |
## Not run: svc <- costexplorer() svc$create_anomaly_monitor( Foo = 123 ) ## End(Not run)
## Not run: svc <- costexplorer() svc$create_anomaly_monitor( Foo = 123 ) ## End(Not run)
Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.
You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.
marketplacecatalog( config = list(), credentials = list(), endpoint = NULL, region = NULL )
marketplacecatalog( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- marketplacecatalog( 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" )
batch_describe_entities | Returns metadata and content for multiple entities |
cancel_change_set | Used to cancel an open change request |
delete_resource_policy | Deletes a resource-based policy on an entity that is identified by its resource ARN |
describe_change_set | Provides information about a given change set |
describe_entity | Returns the metadata and content of the entity |
get_resource_policy | Gets a resource-based policy of an entity that is identified by its resource ARN |
list_change_sets | Returns the list of change sets owned by the account being used to make the call |
list_entities | Provides the list of entities of a given type |
list_tags_for_resource | Lists all tags that have been added to a resource (either an entity or change set) |
put_resource_policy | Attaches a resource-based policy to an entity |
start_change_set | Allows you to request changes for your entities |
tag_resource | Tags a resource (either an entity or change set) |
untag_resource | Removes a tag or list of tags from a resource (either an entity or change set) |
## Not run: svc <- marketplacecatalog() svc$batch_describe_entities( Foo = 123 ) ## End(Not run)
## Not run: svc <- marketplacecatalog() svc$batch_describe_entities( Foo = 123 ) ## End(Not run)
Provides AWS Marketplace business intelligence data on-demand.
marketplacecommerceanalytics( config = list(), credentials = list(), endpoint = NULL, region = NULL )
marketplacecommerceanalytics( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- marketplacecommerceanalytics( 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" )
generate_data_set | Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available |
start_support_data_export | This target has been deprecated |
## Not run: svc <- marketplacecommerceanalytics() svc$generate_data_set( Foo = 123 ) ## End(Not run)
## Not run: svc <- marketplacecommerceanalytics() svc$generate_data_set( Foo = 123 ) ## End(Not run)
This reference provides descriptions of the AWS Marketplace Entitlement Service API.
AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.
Getting Entitlement Records
GetEntitlements- Gets the entitlements for a Marketplace product.
marketplaceentitlementservice( config = list(), credentials = list(), endpoint = NULL, region = NULL )
marketplaceentitlementservice( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- marketplaceentitlementservice( 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" )
get_entitlements | GetEntitlements retrieves entitlement values for a given product |
## Not run: svc <- marketplaceentitlementservice() svc$get_entitlements( Foo = 123 ) ## End(Not run)
## Not run: svc <- marketplaceentitlementservice() svc$get_entitlements( Foo = 123 ) ## End(Not run)
AWS Marketplace Metering Service
This reference provides descriptions of the low-level AWS Marketplace Metering Service API.
AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.
For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the AWS Marketplace Seller Guide.
Submitting Metering Records
MeterUsage - Submits the metering record for an AWS Marketplace
product. meter_usage
is called
from an EC2 instance or a container running on EKS or ECS.
BatchMeterUsage - Submits the metering record for a set of
customers.
batch_meter_usage
is
called from a software-as-a-service (SaaS) application.
Accepting New Customers
ResolveCustomer - Called by a SaaS application during the
registration process. When a buyer visits your website during the
registration process, the buyer submits a Registration Token through
the browser. The Registration Token is resolved through this API to
obtain a CustomerIdentifier
along with the CustomerAWSAccountId
and ProductCode
.
Entitlement and Metering for Paid Container Products
Paid container software products sold through AWS Marketplace must
integrate with the AWS Marketplace Metering Service and call the
register_usage
operation for
software entitlement and metering. Free and BYOL products for Amazon
ECS or Amazon EKS aren't required to call
register_usage
, but you can
do so if you want to receive usage data in your seller reports. For
more information on using the
register_usage
operation,
see Container-Based Products.
batch_meter_usage
API calls
are captured by AWS CloudTrail. You can use Cloudtrail to verify that
the SaaS metering records that you sent are accurate by searching for
records with the eventName
of
batch_meter_usage
. You can
also use CloudTrail to audit records over time. For more information,
see the AWS CloudTrail User Guide.
marketplacemetering( config = list(), credentials = list(), endpoint = NULL, region = NULL )
marketplacemetering( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- marketplacemetering( 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" )
batch_meter_usage | BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers |
meter_usage | API to emit metering records |
register_usage | Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering |
resolve_customer | ResolveCustomer is called by a SaaS application during the registration process |
## Not run: svc <- marketplacemetering() svc$batch_meter_usage( Foo = 123 ) ## End(Not run)
## Not run: svc <- marketplacemetering() svc$batch_meter_usage( Foo = 123 ) ## End(Not run)
Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.
To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.
All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.
Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
paymentcryptographycontrolplane( config = list(), credentials = list(), endpoint = NULL, region = NULL )
paymentcryptographycontrolplane( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- paymentcryptographycontrolplane( 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" )
create_alias | Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key |
create_key | Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region |
delete_alias | Deletes the alias, but doesn't affect the underlying key |
delete_key | Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key |
export_key | Exports a key from Amazon Web Services Payment Cryptography |
get_alias | Gets the Amazon Web Services Payment Cryptography key associated with the alias |
get_key | Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created |
get_parameters_for_export | Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography |
get_parameters_for_import | Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography |
get_public_key_certificate | Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography |
import_key | Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography |
list_aliases | Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region |
list_keys | Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region |
list_tags_for_resource | Lists the tags for an Amazon Web Services resource |
restore_key | Cancels a scheduled key deletion during the waiting period |
start_key_usage | Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography |
stop_key_usage | Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography |
tag_resource | Adds or edits tags on an Amazon Web Services Payment Cryptography key |
untag_resource | Deletes a tag from an Amazon Web Services Payment Cryptography key |
update_alias | Associates an existing Amazon Web Services Payment Cryptography alias with a different key |
## Not run: svc <- paymentcryptographycontrolplane() svc$create_alias( Foo = 123 ) ## End(Not run)
## Not run: svc <- paymentcryptographycontrolplane() svc$create_alias( Foo = 123 ) ## End(Not run)
You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see Data operations in the Amazon Web Services Payment Cryptography User Guide.
To manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.
paymentcryptographydataplane( config = list(), credentials = list(), endpoint = NULL, region = NULL )
paymentcryptographydataplane( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- paymentcryptographydataplane( 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" )
decrypt_data | Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme |
encrypt_data | Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme |
generate_card_validation_data | Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC) |
generate_mac | Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography |
generate_pin_data | Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance |
re_encrypt_data | Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys |
translate_pin_data | Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4 |
verify_auth_request_cryptogram | Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization |
verify_card_validation_data | Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC) |
verify_mac | Verifies a Message Authentication Code (MAC) |
verify_pin_data | Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624 |
## Not run: svc <- paymentcryptographydataplane() svc$decrypt_data( Foo = 123 ) ## End(Not run)
## Not run: svc <- paymentcryptographydataplane() svc$decrypt_data( Foo = 123 ) ## End(Not run)
The Amazon Web Services Price List API is a centralized and convenient
way to programmatically query Amazon Web Services for services,
products, and pricing information. The Amazon Web Services Price List
uses standardized product attributes such as Location
,
Storage Class
, and Operating System
, and provides prices at the SKU
level. You can use the Amazon Web Services Price List to do the
following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices
without a service code to retrieve the service codes
for all Amazon Web Services, then GetServices
with a service code to
retrieve the attribute names for that service. After you have the
service code and attribute names, you can use
get_attribute_values
to see what
values are available for an attribute. With the service code and an
attribute name and value, you can use
get_products
to find specific products that
you're interested in, such as an AmazonEC2
instance, with a
Provisioned IOPS
volumeType
.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
pricing(config = list(), credentials = list(), endpoint = NULL, region = NULL)
pricing(config = list(), credentials = list(), endpoint = NULL, region = NULL)
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. |
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.
svc <- pricing( 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" )
describe_services | Returns the metadata for one service or a list of the metadata for all services |
get_attribute_values | Returns a list of attribute values |
get_price_list_file_url | This feature is in preview release and is subject to change |
get_products | Returns a list of all products that match the filter criteria |
list_price_lists | This feature is in preview release and is subject to change |
## Not run: svc <- pricing() svc$describe_services( Foo = 123 ) ## End(Not run)
## Not run: svc <- pricing() svc$describe_services( Foo = 123 ) ## End(Not run)
Savings Plans are a pricing model that offer significant savings on Amazon Web Services usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage per hour, in the specified currency, for a term of one or three years, and receive a lower price for that usage. For more information, see the Amazon Web Services Savings Plans User Guide.
savingsplans( config = list(), credentials = list(), endpoint = NULL, region = NULL )
savingsplans( config = list(), credentials = list(), endpoint = NULL, region = NULL )
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. |
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.
svc <- savingsplans( 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" )
create_savings_plan | Creates a Savings Plan |
delete_queued_savings_plan | Deletes the queued purchase for the specified Savings Plan |
describe_savings_plan_rates | Describes the rates for the specified Savings Plan |
describe_savings_plans | Describes the specified Savings Plans |
describe_savings_plans_offering_rates | Describes the offering rates for the specified Savings Plans |
describe_savings_plans_offerings | Describes the offerings for the specified Savings Plans |
list_tags_for_resource | Lists the tags for the specified resource |
return_savings_plan | Returns the specified Savings Plan |
tag_resource | Adds the specified tags to the specified resource |
untag_resource | Removes the specified tags from the specified resource |
## Not run: svc <- savingsplans() svc$create_savings_plan( Foo = 123 ) ## End(Not run)
## Not run: svc <- savingsplans() svc$create_savings_plan( Foo = 123 ) ## End(Not run)