Skip to content

Client

datazone R Documentation

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)

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.

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 <- 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_predictions
Accepts automatically generated business-friendly metadata for your Amazon DataZone assets
accept_subscription_request
Accepts a subscription request to a specific asset
add_entity_owner
Adds the owner of an entity (a domain unit)
add_policy_grant
Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles
associate_environment_role
Associates the environment role in Amazon DataZone
cancel_metadata_generation_run
Cancels the metadata generation run
cancel_subscription
Cancels the subscription to the specified asset
create_asset
Creates an asset in Amazon DataZone catalog
create_asset_filter
Creates a data asset filter
create_asset_revision
Creates a revision of the asset
create_asset_type
Creates a custom asset type
create_data_product
Creates a data product
create_data_product_revision
Creates a data product revision
create_data_source
Creates an Amazon DataZone data source
create_domain
Creates an Amazon DataZone domain
create_domain_unit
Creates a domain unit in Amazon DataZone
create_environment
Create an Amazon DataZone environment
create_environment_action
Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment
create_environment_profile
Creates an Amazon DataZone environment profile
create_form_type
Creates a metadata form type
create_glossary
Creates an Amazon DataZone business glossary
create_glossary_term
Creates a business glossary term
create_group_profile
Creates a group profile in Amazon DataZone
create_listing_change_set
Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog
create_project
Creates an Amazon DataZone project
create_project_membership
Creates a project membership in Amazon DataZone
create_subscription_grant
Creates a subsscription grant in Amazon DataZone
create_subscription_request
Creates a subscription request in Amazon DataZone
create_subscription_target
Creates a subscription target in Amazon DataZone
create_user_profile
Creates a user profile in Amazon DataZone
delete_asset
Deletes an asset in Amazon DataZone
delete_asset_filter
Deletes an asset filter
delete_asset_type
Deletes an asset type in Amazon DataZone
delete_data_product
Deletes a data product in Amazon DataZone
delete_data_source
Deletes a data source in Amazon DataZone
delete_domain
Deletes a Amazon DataZone domain
delete_domain_unit
Deletes a domain unit
delete_environment
Deletes an environment in Amazon DataZone
delete_environment_action
Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment
delete_environment_blueprint_configuration
Deletes the blueprint configuration in Amazon DataZone
delete_environment_profile
Deletes an environment profile in Amazon DataZone
delete_form_type
Delets and metadata form type in Amazon DataZone
delete_glossary
Deletes a business glossary in Amazon DataZone
delete_glossary_term
Deletes a business glossary term in Amazon DataZone
delete_listing
Deletes a listing (a record of an asset at a given time)
delete_project
Deletes a project in Amazon DataZone
delete_project_membership
Deletes project membership in Amazon DataZone
delete_subscription_grant
Deletes and subscription grant in Amazon DataZone
delete_subscription_request
Deletes a subscription request in Amazon DataZone
delete_subscription_target
Deletes a subscription target in Amazon DataZone
delete_time_series_data_points
Deletes the specified time series form for the specified asset
disassociate_environment_role
Disassociates the environment role in Amazon DataZone
get_asset
Gets an Amazon DataZone asset
get_asset_filter
Gets an asset filter
get_asset_type
Gets an Amazon DataZone asset type
get_data_product
Gets the data product
get_data_source
Gets an Amazon DataZone data source
get_data_source_run
Gets an Amazon DataZone data source run
get_domain
Gets an Amazon DataZone domain
get_domain_unit
Gets the details of the specified domain unit
get_environment
Gets an Amazon DataZone environment
get_environment_action
Gets the specified environment action
get_environment_blueprint
Gets an Amazon DataZone blueprint
get_environment_blueprint_configuration
Gets the blueprint configuration in Amazon DataZone
get_environment_credentials
Gets the credentials of an environment in Amazon DataZone
get_environment_profile
Gets an evinronment profile in Amazon DataZone
get_form_type
Gets a metadata form type in Amazon DataZone
get_glossary
Gets a business glossary in Amazon DataZone
get_glossary_term
Gets a business glossary term in Amazon DataZone
get_group_profile
Gets a group profile in Amazon DataZone
get_iam_portal_login_url
Gets the data portal URL for the specified Amazon DataZone domain
get_lineage_node
Gets the data lineage node
get_listing
Gets a listing (a record of an asset at a given time)
get_metadata_generation_run
Gets a metadata generation run in Amazon DataZone
get_project
Gets a project in Amazon DataZone
get_subscription
Gets a subscription in Amazon DataZone
get_subscription_grant
Gets the subscription grant in Amazon DataZone
get_subscription_request_details
Gets the details of the specified subscription request
get_subscription_target
Gets the subscription target in Amazon DataZone
get_time_series_data_point
Gets the existing data point for the asset
get_user_profile
Gets a user profile in Amazon DataZone
list_asset_filters
Lists asset filters
list_asset_revisions
Lists the revisions for the asset
list_data_product_revisions
Lists data product revisions
list_data_source_run_activities
Lists data source run activities
list_data_source_runs
Lists data source runs in Amazon DataZone
list_data_sources
Lists data sources in Amazon DataZone
list_domains
Lists Amazon DataZone domains
list_domain_units_for_parent
Lists child domain units for the specified parent domain unit
list_entity_owners
Lists the entity (domain units) owners
list_environment_actions
Lists existing environment actions
list_environment_blueprint_configurations
Lists blueprint configurations for a Amazon DataZone environment
list_environment_blueprints
Lists blueprints in an Amazon DataZone environment
list_environment_profiles
Lists Amazon DataZone environment profiles
list_environments
Lists Amazon DataZone environments
list_lineage_node_history
Lists the history of the specified data lineage node
list_metadata_generation_runs
Lists all metadata generation runs
list_notifications
Lists all Amazon DataZone notifications
list_policy_grants
Lists policy grants
list_project_memberships
Lists all members of the specified project
list_projects
Lists Amazon DataZone projects
list_subscription_grants
Lists subscription grants
list_subscription_requests
Lists Amazon DataZone subscription requests
list_subscriptions
Lists subscriptions in Amazon DataZone
list_subscription_targets
Lists subscription targets in Amazon DataZone
list_tags_for_resource
Lists tags for the specified resource in Amazon DataZone
list_time_series_data_points
Lists time series data points
post_lineage_event
Posts a data lineage event
post_time_series_data_points
Posts time series data points to Amazon DataZone for the specified asset
put_environment_blueprint_configuration
Writes the configuration for the specified environment blueprint in Amazon DataZone
reject_predictions
Rejects automatically generated business-friendly metadata for your Amazon DataZone assets
reject_subscription_request
Rejects the specified subscription request
remove_entity_owner
Removes an owner from an entity
remove_policy_grant
Removes a policy grant
revoke_subscription
Revokes a specified subscription in Amazon DataZone
search
Searches for assets in Amazon DataZone
search_group_profiles
Searches group profiles in Amazon DataZone
search_listings
Searches listings (records of an asset at a given time) in Amazon DataZone
search_types
Searches for types in Amazon DataZone
search_user_profiles
Searches user profiles in Amazon DataZone
start_data_source_run
Start the run of the specified data source in Amazon DataZone
start_metadata_generation_run
Starts the metadata generation run
tag_resource
Tags a resource in Amazon DataZone
untag_resource
Untags a resource in Amazon DataZone
update_asset_filter
Updates an asset filter
update_data_source
Updates the specified data source in Amazon DataZone
update_domain
Updates a Amazon DataZone domain
update_domain_unit
Updates the domain unit
update_environment
Updates the specified environment in Amazon DataZone
update_environment_action
Updates an environment action
update_environment_profile
Updates the specified environment profile in Amazon DataZone
update_glossary
Updates the business glossary in Amazon DataZone
update_glossary_term
Updates a business glossary term in Amazon DataZone
update_group_profile
Updates the specified group profile in Amazon DataZone
update_project
Updates the specified project in Amazon DataZone
update_subscription_grant_status
Updates the status of the specified subscription grant status in Amazon DataZone
update_subscription_request
Updates a specified subscription request in Amazon DataZone
update_subscription_target
Updates the specified subscription target in Amazon DataZone
update_user_profile
Updates the specified user profile in Amazon DataZone

Examples

## Not run: 
svc <- datazone()
svc$accept_predictions(
  Foo = 123
)

## End(Not run)