Learn R Programming

paws.analytics (version 0.7.0)

datazone: Amazon DataZone

Description

Amazon DataZone is a data management service that enables you to catalog, discover, govern, share, and analyze your data. With Amazon DataZone, you can share and access your data across accounts and supported regions. Amazon DataZone simplifies your experience across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation.

Usage

datazone(config = list(), credentials = list(), endpoint = NULL, region = NULL)

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.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- datazone(
  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_predictionsAccepts automatically generated business-friendly metadata for your Amazon DataZone assets
accept_subscription_requestAccepts a subscription request to a specific asset
add_entity_ownerAdds the owner of an entity (a domain unit)
add_policy_grantAdds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles
associate_environment_roleAssociates the environment role in Amazon DataZone
cancel_metadata_generation_runCancels the metadata generation run
cancel_subscriptionCancels the subscription to the specified asset
create_assetCreates an asset in Amazon DataZone catalog
create_asset_filterCreates a data asset filter
create_asset_revisionCreates a revision of the asset
create_asset_typeCreates a custom asset type
create_data_productCreates a data product
create_data_product_revisionCreates a data product revision
create_data_sourceCreates an Amazon DataZone data source
create_domainCreates an Amazon DataZone domain
create_domain_unitCreates a domain unit in Amazon DataZone
create_environmentCreate an Amazon DataZone environment
create_environment_actionCreates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment
create_environment_profileCreates an Amazon DataZone environment profile
create_form_typeCreates a metadata form type
create_glossaryCreates an Amazon DataZone business glossary
create_glossary_termCreates a business glossary term
create_group_profileCreates a group profile in Amazon DataZone
create_listing_change_setPublishes a listing (a record of an asset at a given time) or removes a listing from the catalog
create_projectCreates an Amazon DataZone project
create_project_membershipCreates a project membership in Amazon DataZone
create_subscription_grantCreates a subsscription grant in Amazon DataZone
create_subscription_requestCreates a subscription request in Amazon DataZone
create_subscription_targetCreates a subscription target in Amazon DataZone
create_user_profileCreates a user profile in Amazon DataZone
delete_assetDeletes an asset in Amazon DataZone
delete_asset_filterDeletes an asset filter
delete_asset_typeDeletes an asset type in Amazon DataZone
delete_data_productDeletes a data product in Amazon DataZone
delete_data_sourceDeletes a data source in Amazon DataZone
delete_domainDeletes a Amazon DataZone domain
delete_domain_unitDeletes a domain unit
delete_environmentDeletes an environment in Amazon DataZone
delete_environment_actionDeletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment
delete_environment_blueprint_configurationDeletes the blueprint configuration in Amazon DataZone
delete_environment_profileDeletes an environment profile in Amazon DataZone
delete_form_typeDelets and metadata form type in Amazon DataZone
delete_glossaryDeletes a business glossary in Amazon DataZone
delete_glossary_termDeletes a business glossary term in Amazon DataZone
delete_listingDeletes a listing (a record of an asset at a given time)
delete_projectDeletes a project in Amazon DataZone
delete_project_membershipDeletes project membership in Amazon DataZone
delete_subscription_grantDeletes and subscription grant in Amazon DataZone
delete_subscription_requestDeletes a subscription request in Amazon DataZone
delete_subscription_targetDeletes a subscription target in Amazon DataZone
delete_time_series_data_pointsDeletes the specified time series form for the specified asset
disassociate_environment_roleDisassociates the environment role in Amazon DataZone
get_assetGets an Amazon DataZone asset
get_asset_filterGets an asset filter
get_asset_typeGets an Amazon DataZone asset type
get_data_productGets the data product
get_data_sourceGets an Amazon DataZone data source
get_data_source_runGets an Amazon DataZone data source run
get_domainGets an Amazon DataZone domain
get_domain_unitGets the details of the specified domain unit
get_environmentGets an Amazon DataZone environment
get_environment_actionGets the specified environment action
get_environment_blueprintGets an Amazon DataZone blueprint
get_environment_blueprint_configurationGets the blueprint configuration in Amazon DataZone
get_environment_credentialsGets the credentials of an environment in Amazon DataZone
get_environment_profileGets an evinronment profile in Amazon DataZone
get_form_typeGets a metadata form type in Amazon DataZone
get_glossaryGets a business glossary in Amazon DataZone
get_glossary_termGets a business glossary term in Amazon DataZone
get_group_profileGets a group profile in Amazon DataZone
get_iam_portal_login_urlGets the data portal URL for the specified Amazon DataZone domain
get_lineage_nodeGets the data lineage node
get_listingGets a listing (a record of an asset at a given time)
get_metadata_generation_runGets a metadata generation run in Amazon DataZone
get_projectGets a project in Amazon DataZone
get_subscriptionGets a subscription in Amazon DataZone
get_subscription_grantGets the subscription grant in Amazon DataZone
get_subscription_request_detailsGets the details of the specified subscription request
get_subscription_targetGets the subscription target in Amazon DataZone
get_time_series_data_pointGets the existing data point for the asset
get_user_profileGets a user profile in Amazon DataZone
list_asset_filtersLists asset filters
list_asset_revisionsLists the revisions for the asset
list_data_product_revisionsLists data product revisions
list_data_source_run_activitiesLists data source run activities
list_data_source_runsLists data source runs in Amazon DataZone
list_data_sourcesLists data sources in Amazon DataZone
list_domainsLists Amazon DataZone domains
list_domain_units_for_parentLists child domain units for the specified parent domain unit
list_entity_ownersLists the entity (domain units) owners
list_environment_actionsLists existing environment actions
list_environment_blueprint_configurationsLists blueprint configurations for a Amazon DataZone environment
list_environment_blueprintsLists blueprints in an Amazon DataZone environment
list_environment_profilesLists Amazon DataZone environment profiles
list_environmentsLists Amazon DataZone environments
list_lineage_node_historyLists the history of the specified data lineage node
list_metadata_generation_runsLists all metadata generation runs
list_notificationsLists all Amazon DataZone notifications
list_policy_grantsLists policy grants
list_project_membershipsLists all members of the specified project
list_projectsLists Amazon DataZone projects
list_subscription_grantsLists subscription grants
list_subscription_requestsLists Amazon DataZone subscription requests
list_subscriptionsLists subscriptions in Amazon DataZone
list_subscription_targetsLists subscription targets in Amazon DataZone
list_tags_for_resourceLists tags for the specified resource in Amazon DataZone
list_time_series_data_pointsLists time series data points
post_lineage_eventPosts a data lineage event
post_time_series_data_pointsPosts time series data points to Amazon DataZone for the specified asset
put_environment_blueprint_configurationWrites the configuration for the specified environment blueprint in Amazon DataZone
reject_predictionsRejects automatically generated business-friendly metadata for your Amazon DataZone assets
reject_subscription_requestRejects the specified subscription request
remove_entity_ownerRemoves an owner from an entity
remove_policy_grantRemoves a policy grant
revoke_subscriptionRevokes a specified subscription in Amazon DataZone
searchSearches for assets in Amazon DataZone
search_group_profilesSearches group profiles in Amazon DataZone
search_listingsSearches listings (records of an asset at a given time) in Amazon DataZone
search_typesSearches for types in Amazon DataZone
search_user_profilesSearches user profiles in Amazon DataZone
start_data_source_runStart the run of the specified data source in Amazon DataZone
start_metadata_generation_runStarts the metadata generation run
tag_resourceTags a resource in Amazon DataZone
untag_resourceUntags a resource in Amazon DataZone
update_asset_filterUpdates an asset filter
update_data_sourceUpdates the specified data source in Amazon DataZone
update_domainUpdates a Amazon DataZone domain
update_domain_unitUpdates the domain unit
update_environmentUpdates the specified environment in Amazon DataZone
update_environment_actionUpdates an environment action
update_environment_profileUpdates the specified environment profile in Amazon DataZone
update_glossaryUpdates the business glossary in Amazon DataZone
update_glossary_termUpdates a business glossary term in Amazon DataZone
update_group_profileUpdates the specified group profile in Amazon DataZone
update_projectUpdates the specified project in Amazon DataZone
update_subscription_grant_statusUpdates the status of the specified subscription grant status in Amazon DataZone
update_subscription_requestUpdates a specified subscription request in Amazon DataZone
update_subscription_targetUpdates the specified subscription target in Amazon DataZone
update_user_profileUpdates the specified user profile in Amazon DataZone

Examples

Run this code
if (FALSE) {
svc <- datazone()
svc$accept_predictions(
  Foo = 123
)
}

Run the code above in your browser using DataLab