Class: Aws::Pipes::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Pipes::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb
Overview
An API client for Pipes. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Pipes::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_pipe(params = {}) ⇒ Types::CreatePipeResponse
Create a pipe.
-
#delete_pipe(params = {}) ⇒ Types::DeletePipeResponse
Delete an existing pipe.
-
#describe_pipe(params = {}) ⇒ Types::DescribePipeResponse
Get the information about an existing pipe.
-
#list_pipes(params = {}) ⇒ Types::ListPipesResponse
Get the pipes associated with this account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with a pipe.
-
#start_pipe(params = {}) ⇒ Types::StartPipeResponse
Start an existing pipe.
-
#stop_pipe(params = {}) ⇒ Types::StopPipeResponse
Stop an existing pipe.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified pipe.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified pipes.
-
#update_pipe(params = {}) ⇒ Types::UpdatePipeResponse
Update an existing pipe.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
Parameters:
- options (Hash)
Options Hash (options):
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials. This can be an instance of any one of the following classes:
Aws::Credentials
- Used for configuring static, non-refreshing credentials.Aws::SharedCredentials
- Used for loading static credentials from a shared file, such as~/.aws/config
.Aws::AssumeRoleCredentials
- Used when you need to assume a role.Aws::AssumeRoleWebIdentityCredentials
- Used when you need to assume a role after providing credentials via the web.Aws::SSOCredentials
- Used for loading credentials from AWS SSO using an access token generated fromaws login
.Aws::ProcessCredentials
- Used for loading credentials from a process that outputs to stdout.Aws::InstanceProfileCredentials
- Used for loading credentials from an EC2 IMDS on an EC2 instance.Aws::ECSCredentials
- Used for loading credentials from instances running in ECS.Aws::CognitoIdentityCredentials
- Used for loading credentials from the Cognito Identity service.
When
:credentials
are not configured directly, the following locations will be searched for credentials:Aws.config[:credentials]
- The
:access_key_id
,:secret_access_key
, and:session_token
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
~/.aws/credentials
~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts
are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentails
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:region
is used to determine the service:endpoint
. When not passed, a default:region
is searched for in the following locations:Aws.config[:region]
ENV['AWS_REGION']
ENV['AMAZON_REGION']
ENV['AWS_DEFAULT_REGION']
~/.aws/credentials
~/.aws/config
- :access_key_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to
true
, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults tofalse
. -
:adaptive_retry_wait_to_fill
(Boolean)
— default:
true
—
Used only in
adaptive
retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableError
and will not retry instead of sleeping. -
:client_side_monitoring
(Boolean)
— default:
false
—
When
true
, client-side metrics will be collected for all API requests from this client. -
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_host
(String)
— default:
"127.0.0.1"
—
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When
true
, an attempt is made to coerce request parameters into the required types. -
:correct_clock_skew
(Boolean)
— default:
true
—
Used only in
standard
and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:disable_request_compression
(Boolean)
— default:
false
—
When set to 'true' the request body will not be compressed for supported operations.
-
:endpoint
(String)
—
The client endpoint is normally constructed from the
:region
option. You should only configure an:endpoint
when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. -
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to
true
, endpoint discovery will be enabled for operations when available. -
:ignore_configured_endpoint_urls
(Boolean)
—
Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
-
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the
:logger
at. -
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:max_attempts
(Integer)
— default:
3
—
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in
standard
andadaptive
retry modes. -
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
-
:request_min_compression_size_bytes
(Integer)
— default:
10240
—
The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacy
retry mode. -
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the
legacy
retry mode.@see https://www.awsarchitectureblog.com/2015/03/backoff.html
-
:retry_limit
(Integer)
— default:
3
—
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the
legacy
retry mode. -
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_mode
(String)
— default:
"legacy"
—
Specifies which retry algorithm to use. Values are:
legacy
- The pre-existing retry behavior. This is default value if no retry mode is provided.standard
- A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.adaptive
- An experimental retry mode that includes all the functionality ofstandard
mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
-
:sdk_ua_app_id
(String)
—
A unique and opaque application ID that is appended to the User-Agent header as app/
. It should have a maximum length of 50. - :secret_access_key (String)
- :session_token (String)
-
:stub_responses
(Boolean)
— default:
false
—
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.
Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
-
:token_provider
(Aws::TokenProvider)
—
A Bearer Token Provider. This can be an instance of any one of the following classes:
Aws::StaticTokenProvider
- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider
- Used for loading tokens from AWS SSO using an access token generated fromaws login
.
When
:token_provider
is not configured directly, theAws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true
, dualstack enabled endpoints (with.aws
TLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true
, fips compatible endpoints will be used if available. When afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::Pipes::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::Pipes::EndpointParameters
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_open_timeout
(Float)
— default:
15
—
The number of seconds to wait when opening a HTTP session before raising a
Timeout::Error
. -
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_idle_timeout
(Float)
— default:
5
—
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
-
:http_continue_timeout
(Float)
— default:
1
—
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to
nil
which disables this behaviour. This value can safely be set per request on the session. -
:ssl_timeout
(Float)
— default:
nil
—
Sets the SSL timeout in seconds.
-
:http_wire_trace
(Boolean)
— default:
false
—
When
true
, HTTP debug output will be sent to the:logger
. -
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true
, SSL peer certificates are verified when establishing a connection. -
:ssl_ca_bundle
(String)
—
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_directory
(String)
—
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available.
385 386 387 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_pipe(params = {}) ⇒ Types::CreatePipeResponse
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_pipe({
description: "PipeDescription",
desired_state: "RUNNING", # accepts RUNNING, STOPPED
enrichment: "OptionalArn",
enrichment_parameters: {
http_parameters: {
header_parameters: {
"HeaderKey" => "HeaderValue",
},
path_parameter_values: ["PathParameter"],
query_string_parameters: {
"QueryStringKey" => "QueryStringValue",
},
},
input_template: "InputTemplate",
},
log_configuration: {
cloudwatch_logs_log_destination: {
log_group_arn: "CloudwatchLogGroupArn", # required
},
firehose_log_destination: {
delivery_stream_arn: "FirehoseArn", # required
},
include_execution_data: ["ALL"], # accepts ALL
level: "OFF", # required, accepts OFF, ERROR, INFO, TRACE
s3_log_destination: {
bucket_name: "S3LogDestinationParametersBucketNameString", # required
bucket_owner: "S3LogDestinationParametersBucketOwnerString", # required
output_format: "json", # accepts json, plain, w3c
prefix: "S3LogDestinationParametersPrefixString",
},
},
name: "PipeName", # required
role_arn: "RoleArn", # required
source: "ArnOrUrl", # required
source_parameters: {
active_mq_broker_parameters: {
batch_size: 1,
credentials: { # required
basic_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
queue_name: "MQBrokerQueueName", # required
},
dynamo_db_stream_parameters: {
batch_size: 1,
dead_letter_config: {
arn: "Arn",
},
maximum_batching_window_in_seconds: 1,
maximum_record_age_in_seconds: 1,
maximum_retry_attempts: 1,
on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
parallelization_factor: 1,
starting_position: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST
},
filter_criteria: {
filters: [
{
pattern: "EventPattern",
},
],
},
kinesis_stream_parameters: {
batch_size: 1,
dead_letter_config: {
arn: "Arn",
},
maximum_batching_window_in_seconds: 1,
maximum_record_age_in_seconds: 1,
maximum_retry_attempts: 1,
on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
parallelization_factor: 1,
starting_position: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST, AT_TIMESTAMP
starting_position_timestamp: Time.now,
},
managed_streaming_kafka_parameters: {
batch_size: 1,
consumer_group_id: "URI",
credentials: {
client_certificate_tls_auth: "SecretManagerArn",
sasl_scram_512_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST
topic_name: "KafkaTopicName", # required
},
rabbit_mq_broker_parameters: {
batch_size: 1,
credentials: { # required
basic_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
queue_name: "MQBrokerQueueName", # required
virtual_host: "URI",
},
self_managed_kafka_parameters: {
additional_bootstrap_servers: ["EndpointString"],
batch_size: 1,
consumer_group_id: "URI",
credentials: {
basic_auth: "SecretManagerArn",
client_certificate_tls_auth: "SecretManagerArn",
sasl_scram_256_auth: "SecretManagerArn",
sasl_scram_512_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
server_root_ca_certificate: "SecretManagerArn",
starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST
topic_name: "KafkaTopicName", # required
vpc: {
security_group: ["SecurityGroupId"],
subnets: ["SubnetId"],
},
},
sqs_queue_parameters: {
batch_size: 1,
maximum_batching_window_in_seconds: 1,
},
},
tags: {
"TagKey" => "TagValue",
},
target: "Arn", # required
target_parameters: {
batch_job_parameters: {
array_properties: {
size: 1,
},
container_overrides: {
command: ["String"],
environment: [
{
name: "String",
value: "String",
},
],
instance_type: "String",
resource_requirements: [
{
type: "GPU", # required, accepts GPU, MEMORY, VCPU
value: "String", # required
},
],
},
depends_on: [
{
job_id: "String",
type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
},
],
job_definition: "String", # required
job_name: "String", # required
parameters: {
"String" => "String",
},
retry_strategy: {
attempts: 1,
},
},
cloud_watch_logs_parameters: {
log_stream_name: "LogStreamName",
timestamp: "JsonPath",
},
ecs_task_parameters: {
capacity_provider_strategy: [
{
base: 1,
capacity_provider: "CapacityProvider", # required
weight: 1,
},
],
enable_ecs_managed_tags: false,
enable_execute_command: false,
group: "String",
launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
network_configuration: {
awsvpc_configuration: {
assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
security_groups: ["SecurityGroup"],
subnets: ["Subnet"], # required
},
},
overrides: {
container_overrides: [
{
command: ["String"],
cpu: 1,
environment: [
{
name: "String",
value: "String",
},
],
environment_files: [
{
type: "s3", # required, accepts s3
value: "String", # required
},
],
memory: 1,
memory_reservation: 1,
name: "String",
resource_requirements: [
{
type: "GPU", # required, accepts GPU, InferenceAccelerator
value: "String", # required
},
],
},
],
cpu: "String",
ephemeral_storage: {
size_in_gi_b: 1, # required
},
execution_role_arn: "ArnOrJsonPath",
inference_accelerator_overrides: [
{
device_name: "String",
device_type: "String",
},
],
memory: "String",
task_role_arn: "ArnOrJsonPath",
},
placement_constraints: [
{
expression: "PlacementConstraintExpression",
type: "distinctInstance", # accepts distinctInstance, memberOf
},
],
placement_strategy: [
{
field: "PlacementStrategyField",
type: "random", # accepts random, spread, binpack
},
],
platform_version: "String",
propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
reference_id: "ReferenceId",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
task_count: 1,
task_definition_arn: "ArnOrJsonPath", # required
},
event_bridge_event_bus_parameters: {
detail_type: "EventBridgeDetailType",
endpoint_id: "EventBridgeEndpointId",
resources: ["ArnOrJsonPath"],
source: "EventBridgeEventSource",
time: "JsonPath",
},
http_parameters: {
header_parameters: {
"HeaderKey" => "HeaderValue",
},
path_parameter_values: ["PathParameter"],
query_string_parameters: {
"QueryStringKey" => "QueryStringValue",
},
},
input_template: "InputTemplate",
kinesis_stream_parameters: {
partition_key: "KinesisPartitionKey", # required
},
lambda_function_parameters: {
invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
},
redshift_data_parameters: {
database: "Database", # required
db_user: "DbUser",
secret_manager_arn: "SecretManagerArnOrJsonPath",
sqls: ["Sql"], # required
statement_name: "StatementName",
with_event: false,
},
sage_maker_pipeline_parameters: {
pipeline_parameter_list: [
{
name: "SageMakerPipelineParameterName", # required
value: "SageMakerPipelineParameterValue", # required
},
],
},
sqs_queue_parameters: {
message_deduplication_id: "MessageDeduplicationId",
message_group_id: "MessageGroupId",
},
step_function_state_machine_parameters: {
invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
},
},
})
Response structure
Response structure
resp.arn #=> String
resp.creation_time #=> Time
resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.desired_state #=> String, one of "RUNNING", "STOPPED"
resp.last_modified_time #=> Time
resp.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:description
(String)
—
A description of the pipe.
-
:desired_state
(String)
—
The state the pipe should be in.
-
:enrichment
(String)
—
The ARN of the enrichment resource.
-
:enrichment_parameters
(Types::PipeEnrichmentParameters)
—
The parameters required to set up enrichment on your pipe.
-
:log_configuration
(Types::PipeLogConfigurationParameters)
—
The logging configuration settings for the pipe.
-
:name
(required, String)
—
The name of the pipe.
-
:role_arn
(required, String)
—
The ARN of the role that allows the pipe to send data to the target.
-
:source
(required, String)
—
The ARN of the source resource.
-
:source_parameters
(Types::PipeSourceParameters)
—
The parameters required to set up a source for your pipe.
-
:tags
(Hash<String,String>)
—
The list of key-value pairs to associate with the pipe.
-
:target
(required, String)
—
The ARN of the target resource.
-
:target_parameters
(Types::PipeTargetParameters)
—
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Returns:
-
(Types::CreatePipeResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #creation_time => Time
- #current_state => String
- #desired_state => String
- #last_modified_time => Time
- #name => String
See Also:
761 762 763 764 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 761 def create_pipe(params = {}, options = {}) req = build_request(:create_pipe, params) req.send_request(options) end |
#delete_pipe(params = {}) ⇒ Types::DeletePipeResponse
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_pipe({
name: "PipeName", # required
})
Response structure
Response structure
resp.arn #=> String
resp.creation_time #=> Time
resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.desired_state #=> String, one of "RUNNING", "STOPPED", "DELETED"
resp.last_modified_time #=> Time
resp.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the pipe.
Returns:
-
(Types::DeletePipeResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #creation_time => Time
- #current_state => String
- #desired_state => String
- #last_modified_time => Time
- #name => String
See Also:
804 805 806 807 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 804 def delete_pipe(params = {}, options = {}) req = build_request(:delete_pipe, params) req.send_request(options) end |
#describe_pipe(params = {}) ⇒ Types::DescribePipeResponse
Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_pipe({
name: "PipeName", # required
})
Response structure
Response structure
resp.arn #=> String
resp.creation_time #=> Time
resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.description #=> String
resp.desired_state #=> String, one of "RUNNING", "STOPPED", "DELETED"
resp.enrichment #=> String
resp.enrichment_parameters.http_parameters.header_parameters #=> Hash
resp.enrichment_parameters.http_parameters.header_parameters["HeaderKey"] #=> String
resp.enrichment_parameters.http_parameters.path_parameter_values #=> Array
resp.enrichment_parameters.http_parameters.path_parameter_values[0] #=> String
resp.enrichment_parameters.http_parameters.query_string_parameters #=> Hash
resp.enrichment_parameters.http_parameters.query_string_parameters["QueryStringKey"] #=> String
resp.enrichment_parameters.input_template #=> String
resp.last_modified_time #=> Time
resp.log_configuration.cloudwatch_logs_log_destination.log_group_arn #=> String
resp.log_configuration.firehose_log_destination.delivery_stream_arn #=> String
resp.log_configuration.include_execution_data #=> Array
resp.log_configuration.include_execution_data[0] #=> String, one of "ALL"
resp.log_configuration.level #=> String, one of "OFF", "ERROR", "INFO", "TRACE"
resp.log_configuration.s3_log_destination.bucket_name #=> String
resp.log_configuration.s3_log_destination.bucket_owner #=> String
resp.log_configuration.s3_log_destination.output_format #=> String, one of "json", "plain", "w3c"
resp.log_configuration.s3_log_destination.prefix #=> String
resp.name #=> String
resp.role_arn #=> String
resp.source #=> String
resp.source_parameters.active_mq_broker_parameters.batch_size #=> Integer
resp.source_parameters.active_mq_broker_parameters.credentials.basic_auth #=> String
resp.source_parameters.active_mq_broker_parameters.maximum_batching_window_in_seconds #=> Integer
resp.source_parameters.active_mq_broker_parameters.queue_name #=> String
resp.source_parameters.dynamo_db_stream_parameters.batch_size #=> Integer
resp.source_parameters.dynamo_db_stream_parameters.dead_letter_config.arn #=> String
resp.source_parameters.dynamo_db_stream_parameters.maximum_batching_window_in_seconds #=> Integer
resp.source_parameters.dynamo_db_stream_parameters.maximum_record_age_in_seconds #=> Integer
resp.source_parameters.dynamo_db_stream_parameters.maximum_retry_attempts #=> Integer
resp.source_parameters.dynamo_db_stream_parameters.on_partial_batch_item_failure #=> String, one of "AUTOMATIC_BISECT"
resp.source_parameters.dynamo_db_stream_parameters.parallelization_factor #=> Integer
resp.source_parameters.dynamo_db_stream_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST"
resp.source_parameters.filter_criteria.filters #=> Array
resp.source_parameters.filter_criteria.filters[0].pattern #=> String
resp.source_parameters.kinesis_stream_parameters.batch_size #=> Integer
resp.source_parameters.kinesis_stream_parameters.dead_letter_config.arn #=> String
resp.source_parameters.kinesis_stream_parameters.maximum_batching_window_in_seconds #=> Integer
resp.source_parameters.kinesis_stream_parameters.maximum_record_age_in_seconds #=> Integer
resp.source_parameters.kinesis_stream_parameters.maximum_retry_attempts #=> Integer
resp.source_parameters.kinesis_stream_parameters.on_partial_batch_item_failure #=> String, one of "AUTOMATIC_BISECT"
resp.source_parameters.kinesis_stream_parameters.parallelization_factor #=> Integer
resp.source_parameters.kinesis_stream_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
resp.source_parameters.kinesis_stream_parameters.starting_position_timestamp #=> Time
resp.source_parameters.managed_streaming_kafka_parameters.batch_size #=> Integer
resp.source_parameters.managed_streaming_kafka_parameters.consumer_group_id #=> String
resp.source_parameters.managed_streaming_kafka_parameters.credentials.client_certificate_tls_auth #=> String
resp.source_parameters.managed_streaming_kafka_parameters.credentials.sasl_scram_512_auth #=> String
resp.source_parameters.managed_streaming_kafka_parameters.maximum_batching_window_in_seconds #=> Integer
resp.source_parameters.managed_streaming_kafka_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST"
resp.source_parameters.managed_streaming_kafka_parameters.topic_name #=> String
resp.source_parameters.rabbit_mq_broker_parameters.batch_size #=> Integer
resp.source_parameters.rabbit_mq_broker_parameters.credentials.basic_auth #=> String
resp.source_parameters.rabbit_mq_broker_parameters.maximum_batching_window_in_seconds #=> Integer
resp.source_parameters.rabbit_mq_broker_parameters.queue_name #=> String
resp.source_parameters.rabbit_mq_broker_parameters.virtual_host #=> String
resp.source_parameters.self_managed_kafka_parameters.additional_bootstrap_servers #=> Array
resp.source_parameters.self_managed_kafka_parameters.additional_bootstrap_servers[0] #=> String
resp.source_parameters.self_managed_kafka_parameters.batch_size #=> Integer
resp.source_parameters.self_managed_kafka_parameters.consumer_group_id #=> String
resp.source_parameters.self_managed_kafka_parameters.credentials.basic_auth #=> String
resp.source_parameters.self_managed_kafka_parameters.credentials.client_certificate_tls_auth #=> String
resp.source_parameters.self_managed_kafka_parameters.credentials.sasl_scram_256_auth #=> String
resp.source_parameters.self_managed_kafka_parameters.credentials.sasl_scram_512_auth #=> String
resp.source_parameters.self_managed_kafka_parameters.maximum_batching_window_in_seconds #=> Integer
resp.source_parameters.self_managed_kafka_parameters.server_root_ca_certificate #=> String
resp.source_parameters.self_managed_kafka_parameters.starting_position #=> String, one of "TRIM_HORIZON", "LATEST"
resp.source_parameters.self_managed_kafka_parameters.topic_name #=> String
resp.source_parameters.self_managed_kafka_parameters.vpc.security_group #=> Array
resp.source_parameters.self_managed_kafka_parameters.vpc.security_group[0] #=> String
resp.source_parameters.self_managed_kafka_parameters.vpc.subnets #=> Array
resp.source_parameters.self_managed_kafka_parameters.vpc.subnets[0] #=> String
resp.source_parameters.sqs_queue_parameters.batch_size #=> Integer
resp.source_parameters.sqs_queue_parameters.maximum_batching_window_in_seconds #=> Integer
resp.state_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.target #=> String
resp.target_parameters.batch_job_parameters.array_properties.size #=> Integer
resp.target_parameters.batch_job_parameters.container_overrides.command #=> Array
resp.target_parameters.batch_job_parameters.container_overrides.command[0] #=> String
resp.target_parameters.batch_job_parameters.container_overrides.environment #=> Array
resp.target_parameters.batch_job_parameters.container_overrides.environment[0].name #=> String
resp.target_parameters.batch_job_parameters.container_overrides.environment[0].value #=> String
resp.target_parameters.batch_job_parameters.container_overrides.instance_type #=> String
resp.target_parameters.batch_job_parameters.container_overrides.resource_requirements #=> Array
resp.target_parameters.batch_job_parameters.container_overrides.resource_requirements[0].type #=> String, one of "GPU", "MEMORY", "VCPU"
resp.target_parameters.batch_job_parameters.container_overrides.resource_requirements[0].value #=> String
resp.target_parameters.batch_job_parameters.depends_on #=> Array
resp.target_parameters.batch_job_parameters.depends_on[0].job_id #=> String
resp.target_parameters.batch_job_parameters.depends_on[0].type #=> String, one of "N_TO_N", "SEQUENTIAL"
resp.target_parameters.batch_job_parameters.job_definition #=> String
resp.target_parameters.batch_job_parameters.job_name #=> String
resp.target_parameters.batch_job_parameters.parameters #=> Hash
resp.target_parameters.batch_job_parameters.parameters["String"] #=> String
resp.target_parameters.batch_job_parameters.retry_strategy.attempts #=> Integer
resp.target_parameters.cloud_watch_logs_parameters.log_stream_name #=> String
resp.target_parameters.cloud_watch_logs_parameters.timestamp #=> String
resp.target_parameters.ecs_task_parameters.capacity_provider_strategy #=> Array
resp.target_parameters.ecs_task_parameters.capacity_provider_strategy[0].base #=> Integer
resp.target_parameters.ecs_task_parameters.capacity_provider_strategy[0].capacity_provider #=> String
resp.target_parameters.ecs_task_parameters.capacity_provider_strategy[0].weight #=> Integer
resp.target_parameters.ecs_task_parameters.enable_ecs_managed_tags #=> Boolean
resp.target_parameters.ecs_task_parameters.enable_execute_command #=> Boolean
resp.target_parameters.ecs_task_parameters.group #=> String
resp.target_parameters.ecs_task_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
resp.target_parameters.ecs_task_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.target_parameters.ecs_task_parameters.overrides.container_overrides #=> Array
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].command #=> Array
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].command[0] #=> String
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].cpu #=> Integer
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment #=> Array
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment[0].name #=> String
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment[0].value #=> String
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment_files #=> Array
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].environment_files[0].value #=> String
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].memory #=> Integer
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].memory_reservation #=> Integer
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].name #=> String
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].resource_requirements #=> Array
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.target_parameters.ecs_task_parameters.overrides.container_overrides[0].resource_requirements[0].value #=> String
resp.target_parameters.ecs_task_parameters.overrides.cpu #=> String
resp.target_parameters.ecs_task_parameters.overrides.ephemeral_storage.size_in_gi_b #=> Integer
resp.target_parameters.ecs_task_parameters.overrides.execution_role_arn #=> String
resp.target_parameters.ecs_task_parameters.overrides.inference_accelerator_overrides #=> Array
resp.target_parameters.ecs_task_parameters.overrides.inference_accelerator_overrides[0].device_name #=> String
resp.target_parameters.ecs_task_parameters.overrides.inference_accelerator_overrides[0].device_type #=> String
resp.target_parameters.ecs_task_parameters.overrides.memory #=> String
resp.target_parameters.ecs_task_parameters.overrides.task_role_arn #=> String
resp.target_parameters.ecs_task_parameters.placement_constraints #=> Array
resp.target_parameters.ecs_task_parameters.placement_constraints[0].expression #=> String
resp.target_parameters.ecs_task_parameters.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.target_parameters.ecs_task_parameters.placement_strategy #=> Array
resp.target_parameters.ecs_task_parameters.placement_strategy[0].field #=> String
resp.target_parameters.ecs_task_parameters.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.target_parameters.ecs_task_parameters.platform_version #=> String
resp.target_parameters.ecs_task_parameters.propagate_tags #=> String, one of "TASK_DEFINITION"
resp.target_parameters.ecs_task_parameters.reference_id #=> String
resp.target_parameters.ecs_task_parameters.tags #=> Array
resp.target_parameters.ecs_task_parameters.tags[0].key #=> String
resp.target_parameters.ecs_task_parameters.tags[0].value #=> String
resp.target_parameters.ecs_task_parameters.task_count #=> Integer
resp.target_parameters.ecs_task_parameters.task_definition_arn #=> String
resp.target_parameters.event_bridge_event_bus_parameters.detail_type #=> String
resp.target_parameters.event_bridge_event_bus_parameters.endpoint_id #=> String
resp.target_parameters.event_bridge_event_bus_parameters.resources #=> Array
resp.target_parameters.event_bridge_event_bus_parameters.resources[0] #=> String
resp.target_parameters.event_bridge_event_bus_parameters.source #=> String
resp.target_parameters.event_bridge_event_bus_parameters.time #=> String
resp.target_parameters.http_parameters.header_parameters #=> Hash
resp.target_parameters.http_parameters.header_parameters["HeaderKey"] #=> String
resp.target_parameters.http_parameters.path_parameter_values #=> Array
resp.target_parameters.http_parameters.path_parameter_values[0] #=> String
resp.target_parameters.http_parameters.query_string_parameters #=> Hash
resp.target_parameters.http_parameters.query_string_parameters["QueryStringKey"] #=> String
resp.target_parameters.input_template #=> String
resp.target_parameters.kinesis_stream_parameters.partition_key #=> String
resp.target_parameters.lambda_function_parameters.invocation_type #=> String, one of "REQUEST_RESPONSE", "FIRE_AND_FORGET"
resp.target_parameters.redshift_data_parameters.database #=> String
resp.target_parameters.redshift_data_parameters.db_user #=> String
resp.target_parameters.redshift_data_parameters.secret_manager_arn #=> String
resp.target_parameters.redshift_data_parameters.sqls #=> Array
resp.target_parameters.redshift_data_parameters.sqls[0] #=> String
resp.target_parameters.redshift_data_parameters.statement_name #=> String
resp.target_parameters.redshift_data_parameters.with_event #=> Boolean
resp.target_parameters.sage_maker_pipeline_parameters.pipeline_parameter_list #=> Array
resp.target_parameters.sage_maker_pipeline_parameters.pipeline_parameter_list[0].name #=> String
resp.target_parameters.sage_maker_pipeline_parameters.pipeline_parameter_list[0].value #=> String
resp.target_parameters.sqs_queue_parameters.message_deduplication_id #=> String
resp.target_parameters.sqs_queue_parameters.message_group_id #=> String
resp.target_parameters.step_function_state_machine_parameters.invocation_type #=> String, one of "REQUEST_RESPONSE", "FIRE_AND_FORGET"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the pipe.
Returns:
-
(Types::DescribePipeResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #creation_time => Time
- #current_state => String
- #description => String
- #desired_state => String
- #enrichment => String
- #enrichment_parameters => Types::PipeEnrichmentParameters
- #last_modified_time => Time
- #log_configuration => Types::PipeLogConfiguration
- #name => String
- #role_arn => String
- #source => String
- #source_parameters => Types::PipeSourceParameters
- #state_reason => String
- #tags => Hash<String,String>
- #target => String
- #target_parameters => Types::PipeTargetParameters
See Also:
1035 1036 1037 1038 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1035 def describe_pipe(params = {}, options = {}) req = build_request(:describe_pipe, params) req.send_request(options) end |
#list_pipes(params = {}) ⇒ Types::ListPipesResponse
Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_pipes({
current_state: "RUNNING", # accepts RUNNING, STOPPED, CREATING, UPDATING, DELETING, STARTING, STOPPING, CREATE_FAILED, UPDATE_FAILED, START_FAILED, STOP_FAILED, DELETE_FAILED, CREATE_ROLLBACK_FAILED, DELETE_ROLLBACK_FAILED, UPDATE_ROLLBACK_FAILED
desired_state: "RUNNING", # accepts RUNNING, STOPPED
limit: 1,
name_prefix: "PipeName",
next_token: "NextToken",
source_prefix: "ResourceArn",
target_prefix: "ResourceArn",
})
Response structure
Response structure
resp.next_token #=> String
resp.pipes #=> Array
resp.pipes[0].arn #=> String
resp.pipes[0].creation_time #=> Time
resp.pipes[0].current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.pipes[0].desired_state #=> String, one of "RUNNING", "STOPPED"
resp.pipes[0].enrichment #=> String
resp.pipes[0].last_modified_time #=> Time
resp.pipes[0].name #=> String
resp.pipes[0].source #=> String
resp.pipes[0].state_reason #=> String
resp.pipes[0].target #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:current_state
(String)
—
The state the pipe is in.
-
:desired_state
(String)
—
The state the pipe should be in.
-
:limit
(Integer)
—
The maximum number of pipes to include in the response.
-
:name_prefix
(String)
—
A value that will return a subset of the pipes associated with this account. For example,
"NamePrefix": "ABC"
will return all endpoints with "ABC" in the name. -
:next_token
(String)
—
If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. -
:source_prefix
(String)
—
The prefix matching the pipe source.
-
:target_prefix
(String)
—
The prefix matching the pipe target.
Returns:
-
(Types::ListPipesResponse)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #pipes => Array<Types::Pipe>
See Also:
1114 1115 1116 1117 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1114 def list_pipes(params = {}, options = {}) req = build_request(:list_pipes, params) req.send_request(options) end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with a pipe.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_tags_for_resource({
resource_arn: "PipeArn", # required
})
Response structure
Response structure
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The ARN of the pipe for which you want to view tags.
Returns:
See Also:
1143 1144 1145 1146 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1143 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end |
#start_pipe(params = {}) ⇒ Types::StartPipeResponse
Start an existing pipe.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.start_pipe({
name: "PipeName", # required
})
Response structure
Response structure
resp.arn #=> String
resp.creation_time #=> Time
resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.desired_state #=> String, one of "RUNNING", "STOPPED"
resp.last_modified_time #=> Time
resp.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the pipe.
Returns:
-
(Types::StartPipeResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #creation_time => Time
- #current_state => String
- #desired_state => String
- #last_modified_time => Time
- #name => String
See Also:
1181 1182 1183 1184 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1181 def start_pipe(params = {}, options = {}) req = build_request(:start_pipe, params) req.send_request(options) end |
#stop_pipe(params = {}) ⇒ Types::StopPipeResponse
Stop an existing pipe.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.stop_pipe({
name: "PipeName", # required
})
Response structure
Response structure
resp.arn #=> String
resp.creation_time #=> Time
resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.desired_state #=> String, one of "RUNNING", "STOPPED"
resp.last_modified_time #=> Time
resp.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the pipe.
Returns:
-
(Types::StopPipeResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #creation_time => Time
- #current_state => String
- #desired_state => String
- #last_modified_time => Time
- #name => String
See Also:
1219 1220 1221 1222 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1219 def stop_pipe(params = {}, options = {}) req = build_request(:stop_pipe, params) req.send_request(options) end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified pipe. 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 use the TagResource
action with a pipe that already has
tags. If you specify a new tag key, this tag is appended to the list
of tags associated with the pipe. If you specify a tag key that is
already associated with the pipe, the new tag value that you specify
replaces the previous value for that tag.
You can associate as many as 50 tags with a pipe.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.tag_resource({
resource_arn: "PipeArn", # required
tags: { # required
"TagKey" => "TagValue",
},
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The ARN of the pipe.
-
:tags
(required, Hash<String,String>)
—
The list of key-value pairs associated with the pipe.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
1261 1262 1263 1264 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1261 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified pipes.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.untag_resource({
resource_arn: "PipeArn", # required
tag_keys: ["TagKey"], # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The ARN of the pipe.
-
:tag_keys
(required, Array<String>)
—
The list of tag keys to remove from the pipe.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
1287 1288 1289 1290 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1287 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end |
#update_pipe(params = {}) ⇒ Types::UpdatePipeResponse
Update an existing pipe. When you call UpdatePipe
, EventBridge only
the updates fields you have specified in the request; the rest remain
unchanged. The exception to this is if you modify any Amazon Web
Services-service specific fields in the SourceParameters
,
EnrichmentParameters
, or TargetParameters
objects. For example,
DynamoDBStreamParameters
or EventBridgeEventBusParameters
.
EventBridge updates the fields in these objects atomically as one and
overrides existing values. This is by design, and means that if you
don't specify an optional field in one of these Parameters
objects,
EventBridge sets that field to its system-default value during the
update.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_pipe({
description: "PipeDescription",
desired_state: "RUNNING", # accepts RUNNING, STOPPED
enrichment: "OptionalArn",
enrichment_parameters: {
http_parameters: {
header_parameters: {
"HeaderKey" => "HeaderValue",
},
path_parameter_values: ["PathParameter"],
query_string_parameters: {
"QueryStringKey" => "QueryStringValue",
},
},
input_template: "InputTemplate",
},
log_configuration: {
cloudwatch_logs_log_destination: {
log_group_arn: "CloudwatchLogGroupArn", # required
},
firehose_log_destination: {
delivery_stream_arn: "FirehoseArn", # required
},
include_execution_data: ["ALL"], # accepts ALL
level: "OFF", # required, accepts OFF, ERROR, INFO, TRACE
s3_log_destination: {
bucket_name: "S3LogDestinationParametersBucketNameString", # required
bucket_owner: "S3LogDestinationParametersBucketOwnerString", # required
output_format: "json", # accepts json, plain, w3c
prefix: "S3LogDestinationParametersPrefixString",
},
},
name: "PipeName", # required
role_arn: "RoleArn", # required
source_parameters: {
active_mq_broker_parameters: {
batch_size: 1,
credentials: { # required
basic_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
},
dynamo_db_stream_parameters: {
batch_size: 1,
dead_letter_config: {
arn: "Arn",
},
maximum_batching_window_in_seconds: 1,
maximum_record_age_in_seconds: 1,
maximum_retry_attempts: 1,
on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
parallelization_factor: 1,
},
filter_criteria: {
filters: [
{
pattern: "EventPattern",
},
],
},
kinesis_stream_parameters: {
batch_size: 1,
dead_letter_config: {
arn: "Arn",
},
maximum_batching_window_in_seconds: 1,
maximum_record_age_in_seconds: 1,
maximum_retry_attempts: 1,
on_partial_batch_item_failure: "AUTOMATIC_BISECT", # accepts AUTOMATIC_BISECT
parallelization_factor: 1,
},
managed_streaming_kafka_parameters: {
batch_size: 1,
credentials: {
client_certificate_tls_auth: "SecretManagerArn",
sasl_scram_512_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
},
rabbit_mq_broker_parameters: {
batch_size: 1,
credentials: { # required
basic_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
},
self_managed_kafka_parameters: {
batch_size: 1,
credentials: {
basic_auth: "SecretManagerArn",
client_certificate_tls_auth: "SecretManagerArn",
sasl_scram_256_auth: "SecretManagerArn",
sasl_scram_512_auth: "SecretManagerArn",
},
maximum_batching_window_in_seconds: 1,
server_root_ca_certificate: "SecretManagerArn",
vpc: {
security_group: ["SecurityGroupId"],
subnets: ["SubnetId"],
},
},
sqs_queue_parameters: {
batch_size: 1,
maximum_batching_window_in_seconds: 1,
},
},
target: "Arn",
target_parameters: {
batch_job_parameters: {
array_properties: {
size: 1,
},
container_overrides: {
command: ["String"],
environment: [
{
name: "String",
value: "String",
},
],
instance_type: "String",
resource_requirements: [
{
type: "GPU", # required, accepts GPU, MEMORY, VCPU
value: "String", # required
},
],
},
depends_on: [
{
job_id: "String",
type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
},
],
job_definition: "String", # required
job_name: "String", # required
parameters: {
"String" => "String",
},
retry_strategy: {
attempts: 1,
},
},
cloud_watch_logs_parameters: {
log_stream_name: "LogStreamName",
timestamp: "JsonPath",
},
ecs_task_parameters: {
capacity_provider_strategy: [
{
base: 1,
capacity_provider: "CapacityProvider", # required
weight: 1,
},
],
enable_ecs_managed_tags: false,
enable_execute_command: false,
group: "String",
launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
network_configuration: {
awsvpc_configuration: {
assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
security_groups: ["SecurityGroup"],
subnets: ["Subnet"], # required
},
},
overrides: {
container_overrides: [
{
command: ["String"],
cpu: 1,
environment: [
{
name: "String",
value: "String",
},
],
environment_files: [
{
type: "s3", # required, accepts s3
value: "String", # required
},
],
memory: 1,
memory_reservation: 1,
name: "String",
resource_requirements: [
{
type: "GPU", # required, accepts GPU, InferenceAccelerator
value: "String", # required
},
],
},
],
cpu: "String",
ephemeral_storage: {
size_in_gi_b: 1, # required
},
execution_role_arn: "ArnOrJsonPath",
inference_accelerator_overrides: [
{
device_name: "String",
device_type: "String",
},
],
memory: "String",
task_role_arn: "ArnOrJsonPath",
},
placement_constraints: [
{
expression: "PlacementConstraintExpression",
type: "distinctInstance", # accepts distinctInstance, memberOf
},
],
placement_strategy: [
{
field: "PlacementStrategyField",
type: "random", # accepts random, spread, binpack
},
],
platform_version: "String",
propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
reference_id: "ReferenceId",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
task_count: 1,
task_definition_arn: "ArnOrJsonPath", # required
},
event_bridge_event_bus_parameters: {
detail_type: "EventBridgeDetailType",
endpoint_id: "EventBridgeEndpointId",
resources: ["ArnOrJsonPath"],
source: "EventBridgeEventSource",
time: "JsonPath",
},
http_parameters: {
header_parameters: {
"HeaderKey" => "HeaderValue",
},
path_parameter_values: ["PathParameter"],
query_string_parameters: {
"QueryStringKey" => "QueryStringValue",
},
},
input_template: "InputTemplate",
kinesis_stream_parameters: {
partition_key: "KinesisPartitionKey", # required
},
lambda_function_parameters: {
invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
},
redshift_data_parameters: {
database: "Database", # required
db_user: "DbUser",
secret_manager_arn: "SecretManagerArnOrJsonPath",
sqls: ["Sql"], # required
statement_name: "StatementName",
with_event: false,
},
sage_maker_pipeline_parameters: {
pipeline_parameter_list: [
{
name: "SageMakerPipelineParameterName", # required
value: "SageMakerPipelineParameterValue", # required
},
],
},
sqs_queue_parameters: {
message_deduplication_id: "MessageDeduplicationId",
message_group_id: "MessageGroupId",
},
step_function_state_machine_parameters: {
invocation_type: "REQUEST_RESPONSE", # accepts REQUEST_RESPONSE, FIRE_AND_FORGET
},
},
})
Response structure
Response structure
resp.arn #=> String
resp.creation_time #=> Time
resp.current_state #=> String, one of "RUNNING", "STOPPED", "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPING", "CREATE_FAILED", "UPDATE_FAILED", "START_FAILED", "STOP_FAILED", "DELETE_FAILED", "CREATE_ROLLBACK_FAILED", "DELETE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_FAILED"
resp.desired_state #=> String, one of "RUNNING", "STOPPED"
resp.last_modified_time #=> Time
resp.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:description
(String)
—
A description of the pipe.
-
:desired_state
(String)
—
The state the pipe should be in.
-
:enrichment
(String)
—
The ARN of the enrichment resource.
-
:enrichment_parameters
(Types::PipeEnrichmentParameters)
—
The parameters required to set up enrichment on your pipe.
-
:log_configuration
(Types::PipeLogConfigurationParameters)
—
The logging configuration settings for the pipe.
-
:name
(required, String)
—
The name of the pipe.
-
:role_arn
(required, String)
—
The ARN of the role that allows the pipe to send data to the target.
-
:source_parameters
(Types::UpdatePipeSourceParameters)
—
The parameters required to set up a source for your pipe.
-
:target
(String)
—
The ARN of the target resource.
-
:target_parameters
(Types::PipeTargetParameters)
—
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Returns:
-
(Types::UpdatePipeResponse)
—
Returns a response object which responds to the following methods:
- #arn => String
- #creation_time => Time
- #current_state => String
- #desired_state => String
- #last_modified_time => Time
- #name => String
See Also:
1654 1655 1656 1657 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/client.rb', line 1654 def update_pipe(params = {}, options = {}) req = build_request(:update_pipe, params) req.send_request(options) end |