licenses
sequencelengths 1
3
| version
stringclasses 677
values | tree_hash
stringlengths 40
40
| path
stringclasses 1
value | type
stringclasses 2
values | size
stringlengths 2
8
| text
stringlengths 25
67.1M
| package_name
stringlengths 2
41
| repo
stringlengths 33
86
|
|---|---|---|---|---|---|---|---|---|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 16626 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotdeviceadvisor
using AWS.Compat
using AWS.UUIDs
"""
create_suite_definition(suite_definition_configuration)
create_suite_definition(suite_definition_configuration, params::Dict{String,<:Any})
Creates a Device Advisor test suite. Requires permission to access the
CreateSuiteDefinition action.
# Arguments
- `suite_definition_configuration`: Creates a Device Advisor test suite with suite
definition configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags to be attached to the suite definition.
"""
function create_suite_definition(
suiteDefinitionConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"POST",
"/suiteDefinitions",
Dict{String,Any}("suiteDefinitionConfiguration" => suiteDefinitionConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_suite_definition(
suiteDefinitionConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"POST",
"/suiteDefinitions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"suiteDefinitionConfiguration" => suiteDefinitionConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_suite_definition(suite_definition_id)
delete_suite_definition(suite_definition_id, params::Dict{String,<:Any})
Deletes a Device Advisor test suite. Requires permission to access the
DeleteSuiteDefinition action.
# Arguments
- `suite_definition_id`: Suite definition ID of the test suite to be deleted.
"""
function delete_suite_definition(
suiteDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"DELETE",
"/suiteDefinitions/$(suiteDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_suite_definition(
suiteDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"DELETE",
"/suiteDefinitions/$(suiteDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_endpoint()
get_endpoint(params::Dict{String,<:Any})
Gets information about an Device Advisor endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authenticationMethod"`: The authentication method used during the device connection.
- `"certificateArn"`: The certificate ARN of the device. This is an optional parameter.
- `"deviceRoleArn"`: The device role ARN of the device. This is an optional parameter.
- `"thingArn"`: The thing ARN of the device. This is an optional parameter.
"""
function get_endpoint(; aws_config::AbstractAWSConfig=global_aws_config())
return iotdeviceadvisor(
"GET", "/endpoint"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_endpoint(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET", "/endpoint", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_suite_definition(suite_definition_id)
get_suite_definition(suite_definition_id, params::Dict{String,<:Any})
Gets information about a Device Advisor test suite. Requires permission to access the
GetSuiteDefinition action.
# Arguments
- `suite_definition_id`: Suite definition ID of the test suite to get.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"suiteDefinitionVersion"`: Suite definition version of the test suite to get.
"""
function get_suite_definition(
suiteDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions/$(suiteDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_suite_definition(
suiteDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions/$(suiteDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_suite_run(suite_definition_id, suite_run_id)
get_suite_run(suite_definition_id, suite_run_id, params::Dict{String,<:Any})
Gets information about a Device Advisor test suite run. Requires permission to access the
GetSuiteRun action.
# Arguments
- `suite_definition_id`: Suite definition ID for the test suite run.
- `suite_run_id`: Suite run ID for the test suite run.
"""
function get_suite_run(
suiteDefinitionId, suiteRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns/$(suiteRunId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_suite_run(
suiteDefinitionId,
suiteRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns/$(suiteRunId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_suite_run_report(suite_definition_id, suite_run_id)
get_suite_run_report(suite_definition_id, suite_run_id, params::Dict{String,<:Any})
Gets a report download link for a successful Device Advisor qualifying test suite run.
Requires permission to access the GetSuiteRunReport action.
# Arguments
- `suite_definition_id`: Suite definition ID of the test suite.
- `suite_run_id`: Suite run ID of the test suite run.
"""
function get_suite_run_report(
suiteDefinitionId, suiteRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns/$(suiteRunId)/report";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_suite_run_report(
suiteDefinitionId,
suiteRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns/$(suiteRunId)/report",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_suite_definitions()
list_suite_definitions(params::Dict{String,<:Any})
Lists the Device Advisor test suites you have created. Requires permission to access the
ListSuiteDefinitions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at once.
- `"nextToken"`: A token used to get the next set of results.
"""
function list_suite_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return iotdeviceadvisor(
"GET", "/suiteDefinitions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_suite_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET",
"/suiteDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_suite_runs()
list_suite_runs(params::Dict{String,<:Any})
Lists runs of the specified Device Advisor test suite. You can list all runs of the test
suite, or the runs of a specific version of the test suite. Requires permission to access
the ListSuiteRuns action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at once.
- `"nextToken"`: A token to retrieve the next set of results.
- `"suiteDefinitionId"`: Lists the test suite runs of the specified test suite based on
suite definition ID.
- `"suiteDefinitionVersion"`: Must be passed along with suiteDefinitionId. Lists the test
suite runs of the specified test suite based on suite definition version.
"""
function list_suite_runs(; aws_config::AbstractAWSConfig=global_aws_config())
return iotdeviceadvisor(
"GET", "/suiteRuns"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_suite_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET", "/suiteRuns", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags attached to an IoT Device Advisor resource. Requires permission to access
the ListTagsForResource action.
# Arguments
- `resource_arn`: The resource ARN of the IoT Device Advisor resource. This can be
SuiteDefinition ARN or SuiteRun ARN.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_suite_run(suite_definition_id, suite_run_configuration)
start_suite_run(suite_definition_id, suite_run_configuration, params::Dict{String,<:Any})
Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun
action.
# Arguments
- `suite_definition_id`: Suite definition ID of the test suite.
- `suite_run_configuration`: Suite run configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"suiteDefinitionVersion"`: Suite definition version of the test suite.
- `"tags"`: The tags to be attached to the suite run.
"""
function start_suite_run(
suiteDefinitionId,
suiteRunConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"POST",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns",
Dict{String,Any}("suiteRunConfiguration" => suiteRunConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_suite_run(
suiteDefinitionId,
suiteRunConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"POST",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("suiteRunConfiguration" => suiteRunConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_suite_run(suite_definition_id, suite_run_id)
stop_suite_run(suite_definition_id, suite_run_id, params::Dict{String,<:Any})
Stops a Device Advisor test suite run that is currently running. Requires permission to
access the StopSuiteRun action.
# Arguments
- `suite_definition_id`: Suite definition ID of the test suite run to be stopped.
- `suite_run_id`: Suite run ID of the test suite run to be stopped.
"""
function stop_suite_run(
suiteDefinitionId, suiteRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"POST",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns/$(suiteRunId)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_suite_run(
suiteDefinitionId,
suiteRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"POST",
"/suiteDefinitions/$(suiteDefinitionId)/suiteRuns/$(suiteRunId)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission
to access the TagResource action.
# Arguments
- `resource_arn`: The resource ARN of an IoT Device Advisor resource. This can be
SuiteDefinition ARN or SuiteRun ARN.
- `tags`: The tags to be attached to the IoT Device Advisor resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotdeviceadvisor(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from an IoT Device Advisor resource. Requires permission to access the
UntagResource action.
# Arguments
- `resource_arn`: The resource ARN of an IoT Device Advisor resource. This can be
SuiteDefinition ARN or SuiteRun ARN.
- `tag_keys`: List of tag keys to remove from the IoT Device Advisor resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotdeviceadvisor(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_suite_definition(suite_definition_configuration, suite_definition_id)
update_suite_definition(suite_definition_configuration, suite_definition_id, params::Dict{String,<:Any})
Updates a Device Advisor test suite. Requires permission to access the
UpdateSuiteDefinition action.
# Arguments
- `suite_definition_configuration`: Updates a Device Advisor test suite with suite
definition configuration.
- `suite_definition_id`: Suite definition ID of the test suite to be updated.
"""
function update_suite_definition(
suiteDefinitionConfiguration,
suiteDefinitionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"PATCH",
"/suiteDefinitions/$(suiteDefinitionId)",
Dict{String,Any}("suiteDefinitionConfiguration" => suiteDefinitionConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_suite_definition(
suiteDefinitionConfiguration,
suiteDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotdeviceadvisor(
"PATCH",
"/suiteDefinitions/$(suiteDefinitionId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"suiteDefinitionConfiguration" => suiteDefinitionConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 9759 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotfleethub
using AWS.Compat
using AWS.UUIDs
"""
create_application(application_name, role_arn)
create_application(application_name, role_arn, params::Dict{String,<:Any})
Creates a Fleet Hub for IoT Device Management web application. When creating a Fleet Hub
application, you must create an organization instance of IAM Identity Center if you don't
already have one. The Fleet Hub application you create must also be in the same Amazon Web
Services Region of the organization instance of IAM Identity Center. For more information
see Enabling IAM Identity Center and Organization instances of IAM Identity Center.
# Arguments
- `application_name`: The name of the web application.
- `role_arn`: The ARN of the role that the web application assumes when it interacts with
Amazon Web Services IoT Core. The name of the role must be in the form
AWSIotFleetHub_random_string .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationDescription"`: An optional description of the web application.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"tags"`: A set of key/value pairs that you can use to manage the web application
resource.
"""
function create_application(
applicationName, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"POST",
"/applications",
Dict{String,Any}(
"applicationName" => applicationName,
"roleArn" => roleArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
applicationName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicationName" => applicationName,
"roleArn" => roleArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Deletes a Fleet Hub for IoT Device Management web application.
# Arguments
- `application_id`: The unique Id of the web application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"DELETE",
"/applications/$(applicationId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"DELETE",
"/applications/$(applicationId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application(application_id)
describe_application(application_id, params::Dict{String,<:Any})
Gets information about a Fleet Hub for IoT Device Management web application.
# Arguments
- `application_id`: The unique Id of the web application.
"""
function describe_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"GET",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"GET",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token used to get the next set of results.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleethub(
"GET", "/applications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for the specified resource.
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds to or modifies the tags of the specified resource. Tags are metadata which can be used
to manage a resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tags`: The new or modified tags for the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleethub(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags (metadata) from the resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tag_keys`: A list of the keys of the tags to be removed from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_id)
update_application(application_id, params::Dict{String,<:Any})
Updates information about a Fleet Hub for IoT Device Management web application.
# Arguments
- `application_id`: The unique Id of the web application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationDescription"`: An optional description of the web application.
- `"applicationName"`: The name of the web application.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function update_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleethub(
"PATCH",
"/applications/$(applicationId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleethub(
"PATCH",
"/applications/$(applicationId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 72639 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotfleetwise
using AWS.Compat
using AWS.UUIDs
"""
associate_vehicle_fleet(fleet_id, vehicle_name)
associate_vehicle_fleet(fleet_id, vehicle_name, params::Dict{String,<:Any})
Adds, or associates, a vehicle with a fleet.
# Arguments
- `fleet_id`: The ID of a fleet.
- `vehicle_name`: The unique ID of the vehicle to associate with the fleet.
"""
function associate_vehicle_fleet(
fleetId, vehicleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"AssociateVehicleFleet",
Dict{String,Any}("fleetId" => fleetId, "vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_vehicle_fleet(
fleetId,
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"AssociateVehicleFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("fleetId" => fleetId, "vehicleName" => vehicleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_create_vehicle(vehicles)
batch_create_vehicle(vehicles, params::Dict{String,<:Any})
Creates a group, or batch, of vehicles. You must specify a decoder manifest and a
vehicle model (model manifest) for each vehicle. For more information, see Create
multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
# Arguments
- `vehicles`: A list of information about each vehicle to create. For more information,
see the API data type.
"""
function batch_create_vehicle(vehicles; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"BatchCreateVehicle",
Dict{String,Any}("vehicles" => vehicles);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_vehicle(
vehicles,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"BatchCreateVehicle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicles" => vehicles), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_vehicle(vehicles)
batch_update_vehicle(vehicles, params::Dict{String,<:Any})
Updates a group, or batch, of vehicles. You must specify a decoder manifest and a
vehicle model (model manifest) for each vehicle. For more information, see Update
multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
# Arguments
- `vehicles`: A list of information about the vehicles to update. For more information,
see the API data type.
"""
function batch_update_vehicle(vehicles; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"BatchUpdateVehicle",
Dict{String,Any}("vehicles" => vehicles);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_vehicle(
vehicles,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"BatchUpdateVehicle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicles" => vehicles), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_campaign(collection_scheme, name, signal_catalog_arn, target_arn)
create_campaign(collection_scheme, name, signal_catalog_arn, target_arn, params::Dict{String,<:Any})
Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise
Edge Agent software running in vehicles uses campaigns to decide how to collect and
transfer data to the cloud. You create campaigns in the cloud. After you or your team
approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to
vehicles. For more information, see Collect and transfer data with campaigns in the Amazon
Web Services IoT FleetWise Developer Guide.
# Arguments
- `collection_scheme`: The data collection scheme associated with the campaign. You can
specify a scheme that collects data based on time or an event.
- `name`: The name of the campaign to create.
- `signal_catalog_arn`: The Amazon Resource Name (ARN) of the signal catalog to associate
with the campaign.
- `target_arn`: The ARN of the vehicle or fleet to deploy a campaign to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compression"`: (Optional) Whether to compress signals before transmitting data to
Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If
it's not specified, SNAPPY is used. Default: SNAPPY
- `"dataDestinationConfigs"`: The destination where the campaign sends data. You can choose
to send data to be stored in Amazon S3 or Amazon Timestream. Amazon S3 optimizes the cost
of data storage and provides additional mechanisms to use vehicle data, such as data lakes,
centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT
FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on
multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to
query vehicle data so that you can identify trends and patterns.
- `"dataExtraDimensions"`: (Optional) A list of vehicle attributes to associate with a
campaign. Enrich the data with specified vehicle attributes. For example, add make and
model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with
those attributes as dimensions in Amazon Timestream. You can then query the data against
make and model. Default: An empty array
- `"description"`: An optional description of the campaign to help identify its purpose.
- `"diagnosticsMode"`: (Optional) Option for a vehicle to send diagnostic trouble codes to
Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use
SEND_ACTIVE_DTCS. If it's not specified, OFF is used. Default: OFF
- `"expiryTime"`: (Optional) The time the campaign expires, in seconds since epoch
(January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign
expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
- `"postTriggerCollectionDuration"`: (Optional) How long (in milliseconds) to collect raw
data after a triggering event initiates the collection. If it's not specified, 0 is used.
Default: 0
- `"priority"`: (Optional) A number indicating the priority of one campaign over another
campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to
vehicles before any other campaigns. If it's not specified, 0 is used. Default: 0
- `"signalsToCollect"`: (Optional) A list of information about signals to collect.
- `"spoolingMode"`: (Optional) Whether to store collected data after a vehicle lost a
connection with the cloud. After a connection is re-established, the data is automatically
forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a
vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.
Default: OFF
- `"startTime"`: (Optional) The time, in milliseconds, to deliver a campaign after it was
approved. If it's not specified, 0 is used. Default: 0
- `"tags"`: Metadata that can be used to manage the campaign.
"""
function create_campaign(
collectionScheme,
name,
signalCatalogArn,
targetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateCampaign",
Dict{String,Any}(
"collectionScheme" => collectionScheme,
"name" => name,
"signalCatalogArn" => signalCatalogArn,
"targetArn" => targetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_campaign(
collectionScheme,
name,
signalCatalogArn,
targetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateCampaign",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"collectionScheme" => collectionScheme,
"name" => name,
"signalCatalogArn" => signalCatalogArn,
"targetArn" => targetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_decoder_manifest(model_manifest_arn, name)
create_decoder_manifest(model_manifest_arn, name, params::Dict{String,<:Any})
Creates the decoder manifest associated with a model manifest. To create a decoder
manifest, the following must be true: Every signal decoder has a unique name. Each
signal decoder is associated with a network interface. Each network interface has a
unique ID. The signal decoders are specified in the model manifest.
# Arguments
- `model_manifest_arn`: The Amazon Resource Name (ARN) of the vehicle model (model
manifest).
- `name`: The unique name of the decoder manifest to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the decoder manifest.
- `"networkInterfaces"`: A list of information about available network interfaces.
- `"signalDecoders"`: A list of information about signal decoders.
- `"tags"`: Metadata that can be used to manage the decoder manifest.
"""
function create_decoder_manifest(
modelManifestArn, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"CreateDecoderManifest",
Dict{String,Any}("modelManifestArn" => modelManifestArn, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_decoder_manifest(
modelManifestArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateDecoderManifest",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("modelManifestArn" => modelManifestArn, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet(fleet_id, signal_catalog_arn)
create_fleet(fleet_id, signal_catalog_arn, params::Dict{String,<:Any})
Creates a fleet that represents a group of vehicles. You must create both a signal
catalog and vehicles before you can create a fleet. For more information, see Fleets in
the Amazon Web Services IoT FleetWise Developer Guide.
# Arguments
- `fleet_id`: The unique ID of the fleet to create.
- `signal_catalog_arn`: The Amazon Resource Name (ARN) of a signal catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the fleet to create.
- `"tags"`: Metadata that can be used to manage the fleet.
"""
function create_fleet(
fleetId, signalCatalogArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"CreateFleet",
Dict{String,Any}("fleetId" => fleetId, "signalCatalogArn" => signalCatalogArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet(
fleetId,
signalCatalogArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fleetId" => fleetId, "signalCatalogArn" => signalCatalogArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_manifest(name, nodes, signal_catalog_arn)
create_model_manifest(name, nodes, signal_catalog_arn, params::Dict{String,<:Any})
Creates a vehicle model (model manifest) that specifies signals (attributes, branches,
sensors, and actuators). For more information, see Vehicle models in the Amazon Web
Services IoT FleetWise Developer Guide.
# Arguments
- `name`: The name of the vehicle model to create.
- `nodes`: A list of nodes, which are a general abstraction of signals.
- `signal_catalog_arn`: The Amazon Resource Name (ARN) of a signal catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the vehicle model.
- `"tags"`: Metadata that can be used to manage the vehicle model.
"""
function create_model_manifest(
name, nodes, signalCatalogArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"CreateModelManifest",
Dict{String,Any}(
"name" => name, "nodes" => nodes, "signalCatalogArn" => signalCatalogArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_manifest(
name,
nodes,
signalCatalogArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateModelManifest",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "nodes" => nodes, "signalCatalogArn" => signalCatalogArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_signal_catalog(name)
create_signal_catalog(name, params::Dict{String,<:Any})
Creates a collection of standardized signals that can be reused to create vehicle models.
# Arguments
- `name`: The name of the signal catalog to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the signal catalog.
- `"nodes"`: A list of information about nodes, which are a general abstraction of
signals. For more information, see the API data type.
- `"tags"`: Metadata that can be used to manage the signal catalog.
"""
function create_signal_catalog(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"CreateSignalCatalog",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_signal_catalog(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"CreateSignalCatalog",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vehicle(decoder_manifest_arn, model_manifest_arn, vehicle_name)
create_vehicle(decoder_manifest_arn, model_manifest_arn, vehicle_name, params::Dict{String,<:Any})
Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles
created from the same vehicle model consist of the same signals inherited from the vehicle
model. If you have an existing Amazon Web Services IoT thing, you can use Amazon Web
Services IoT FleetWise to create a vehicle and collect data from your thing. For more
information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise
Developer Guide.
# Arguments
- `decoder_manifest_arn`: The ARN of a decoder manifest.
- `model_manifest_arn`: The Amazon Resource Name ARN of a vehicle model.
- `vehicle_name`: The unique ID of the vehicle to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associationBehavior"`: An option to create a new Amazon Web Services IoT thing when
creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.
Default:
- `"attributes"`: Static information about a vehicle in a key-value pair. For example:
\"engineType\" : \"1.3 L R2\" A campaign must include the keys (attribute names) in
dataExtraDimensions for them to display in Amazon Timestream.
- `"tags"`: Metadata that can be used to manage the vehicle.
"""
function create_vehicle(
decoderManifestArn,
modelManifestArn,
vehicleName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateVehicle",
Dict{String,Any}(
"decoderManifestArn" => decoderManifestArn,
"modelManifestArn" => modelManifestArn,
"vehicleName" => vehicleName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vehicle(
decoderManifestArn,
modelManifestArn,
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"CreateVehicle",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"decoderManifestArn" => decoderManifestArn,
"modelManifestArn" => modelManifestArn,
"vehicleName" => vehicleName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_campaign(name)
delete_campaign(name, params::Dict{String,<:Any})
Deletes a data collection campaign. Deleting a campaign suspends all data collection and
removes it from any vehicles.
# Arguments
- `name`: The name of the campaign to delete.
"""
function delete_campaign(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"DeleteCampaign",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_campaign(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"DeleteCampaign",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_decoder_manifest(name)
delete_decoder_manifest(name, params::Dict{String,<:Any})
Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles
associated with it. If the decoder manifest is successfully deleted, Amazon Web Services
IoT FleetWise sends back an HTTP 200 response with an empty body.
# Arguments
- `name`: The name of the decoder manifest to delete.
"""
function delete_decoder_manifest(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"DeleteDecoderManifest",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_decoder_manifest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"DeleteDecoderManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet(fleet_id)
delete_fleet(fleet_id, params::Dict{String,<:Any})
Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the
fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT
FleetWise Developer Guide. If the fleet is successfully deleted, Amazon Web Services IoT
FleetWise sends back an HTTP 200 response with an empty body.
# Arguments
- `fleet_id`: The ID of the fleet to delete.
"""
function delete_fleet(fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"DeleteFleet",
Dict{String,Any}("fleetId" => fleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet(
fleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"DeleteFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fleetId" => fleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_manifest(name)
delete_model_manifest(name, params::Dict{String,<:Any})
Deletes a vehicle model (model manifest). If the vehicle model is successfully deleted,
Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
# Arguments
- `name`: The name of the model manifest to delete.
"""
function delete_model_manifest(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"DeleteModelManifest",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_manifest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"DeleteModelManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_signal_catalog(name)
delete_signal_catalog(name, params::Dict{String,<:Any})
Deletes a signal catalog. If the signal catalog is successfully deleted, Amazon Web
Services IoT FleetWise sends back an HTTP 200 response with an empty body.
# Arguments
- `name`: The name of the signal catalog to delete.
"""
function delete_signal_catalog(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"DeleteSignalCatalog",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_signal_catalog(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"DeleteSignalCatalog",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vehicle(vehicle_name)
delete_vehicle(vehicle_name, params::Dict{String,<:Any})
Deletes a vehicle and removes it from any campaigns. If the vehicle is successfully
deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty
body.
# Arguments
- `vehicle_name`: The ID of the vehicle to delete.
"""
function delete_vehicle(vehicleName; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"DeleteVehicle",
Dict{String,Any}("vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vehicle(
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"DeleteVehicle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicleName" => vehicleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_vehicle_fleet(fleet_id, vehicle_name)
disassociate_vehicle_fleet(fleet_id, vehicle_name, params::Dict{String,<:Any})
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet
doesn't delete the vehicle. If the vehicle is successfully dissociated from a fleet,
Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
# Arguments
- `fleet_id`: The unique ID of a fleet.
- `vehicle_name`: The unique ID of the vehicle to disassociate from the fleet.
"""
function disassociate_vehicle_fleet(
fleetId, vehicleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"DisassociateVehicleFleet",
Dict{String,Any}("fleetId" => fleetId, "vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_vehicle_fleet(
fleetId,
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"DisassociateVehicleFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("fleetId" => fleetId, "vehicleName" => vehicleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign(name)
get_campaign(name, params::Dict{String,<:Any})
Retrieves information about a campaign.
# Arguments
- `name`: The name of the campaign to retrieve information about.
"""
function get_campaign(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetCampaign",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetCampaign",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_decoder_manifest(name)
get_decoder_manifest(name, params::Dict{String,<:Any})
Retrieves information about a created decoder manifest.
# Arguments
- `name`: The name of the decoder manifest to retrieve information about.
"""
function get_decoder_manifest(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetDecoderManifest",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_decoder_manifest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetDecoderManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_encryption_configuration()
get_encryption_configuration(params::Dict{String,<:Any})
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT
FleetWise.
"""
function get_encryption_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetEncryptionConfiguration"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_encryption_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetEncryptionConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_fleet(fleet_id)
get_fleet(fleet_id, params::Dict{String,<:Any})
Retrieves information about a fleet.
# Arguments
- `fleet_id`: The ID of the fleet to retrieve information about.
"""
function get_fleet(fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetFleet",
Dict{String,Any}("fleetId" => fleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_fleet(
fleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fleetId" => fleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logging_options()
get_logging_options(params::Dict{String,<:Any})
Retrieves the logging options.
"""
function get_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetLoggingOptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_logging_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetLoggingOptions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_model_manifest(name)
get_model_manifest(name, params::Dict{String,<:Any})
Retrieves information about a vehicle model (model manifest).
# Arguments
- `name`: The name of the vehicle model to retrieve information about.
"""
function get_model_manifest(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetModelManifest",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_model_manifest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetModelManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_register_account_status()
get_register_account_status(params::Dict{String,<:Any})
Retrieves information about the status of registering your Amazon Web Services account,
IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer
your vehicle data to the Amazon Web Services Cloud. For more information, including
step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. This API
operation doesn't require input parameters.
"""
function get_register_account_status(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetRegisterAccountStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_register_account_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetRegisterAccountStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signal_catalog(name)
get_signal_catalog(name, params::Dict{String,<:Any})
Retrieves information about a signal catalog.
# Arguments
- `name`: The name of the signal catalog to retrieve information about.
"""
function get_signal_catalog(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetSignalCatalog",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_signal_catalog(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"GetSignalCatalog",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vehicle(vehicle_name)
get_vehicle(vehicle_name, params::Dict{String,<:Any})
Retrieves information about a vehicle.
# Arguments
- `vehicle_name`: The ID of the vehicle to retrieve information about.
"""
function get_vehicle(vehicleName; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetVehicle",
Dict{String,Any}("vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vehicle(
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"GetVehicle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicleName" => vehicleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vehicle_status(vehicle_name)
get_vehicle_status(vehicle_name, params::Dict{String,<:Any})
Retrieves information about the status of a vehicle with any associated campaigns.
# Arguments
- `vehicle_name`: The ID of the vehicle to retrieve information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function get_vehicle_status(vehicleName; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"GetVehicleStatus",
Dict{String,Any}("vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vehicle_status(
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"GetVehicleStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicleName" => vehicleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_decoder_manifest(name, network_file_definitions)
import_decoder_manifest(name, network_file_definitions, params::Dict{String,<:Any})
Creates a decoder manifest using your existing CAN DBC file from your local device.
# Arguments
- `name`: The name of the decoder manifest to import.
- `network_file_definitions`: The file to load into an Amazon Web Services account.
"""
function import_decoder_manifest(
name, networkFileDefinitions; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ImportDecoderManifest",
Dict{String,Any}(
"name" => name, "networkFileDefinitions" => networkFileDefinitions
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_decoder_manifest(
name,
networkFileDefinitions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"ImportDecoderManifest",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "networkFileDefinitions" => networkFileDefinitions
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_signal_catalog(name)
import_signal_catalog(name, params::Dict{String,<:Any})
Creates a signal catalog using your existing VSS formatted content from your local device.
# Arguments
- `name`: The name of the signal catalog to import.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the signal catalog.
- `"tags"`: Metadata that can be used to manage the signal catalog.
- `"vss"`: The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a
precise language used to describe and model signals in vehicle networks.
"""
function import_signal_catalog(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ImportSignalCatalog",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_signal_catalog(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ImportSignalCatalog",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_campaigns()
list_campaigns(params::Dict{String,<:Any})
Lists information about created campaigns. This API operation uses pagination. Specify
the nextToken parameter in the request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
- `"status"`: Optional parameter to filter the results by the status of each created
campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL,
RUNNING, or SUSPENDED.
"""
function list_campaigns(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListCampaigns"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_campaigns(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListCampaigns", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_decoder_manifest_network_interfaces(name)
list_decoder_manifest_network_interfaces(name, params::Dict{String,<:Any})
Lists the network interfaces specified in a decoder manifest. This API operation uses
pagination. Specify the nextToken parameter in the request to return more results.
# Arguments
- `name`: The name of the decoder manifest to list information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_decoder_manifest_network_interfaces(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListDecoderManifestNetworkInterfaces",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_decoder_manifest_network_interfaces(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListDecoderManifestNetworkInterfaces",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_decoder_manifest_signals(name)
list_decoder_manifest_signals(name, params::Dict{String,<:Any})
A list of information about signal decoders specified in a decoder manifest. This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Arguments
- `name`: The name of the decoder manifest to list information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_decoder_manifest_signals(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListDecoderManifestSignals",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_decoder_manifest_signals(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListDecoderManifestSignals",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_decoder_manifests()
list_decoder_manifests(params::Dict{String,<:Any})
Lists decoder manifests. This API operation uses pagination. Specify the nextToken
parameter in the request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"modelManifestArn"`: The Amazon Resource Name (ARN) of a vehicle model (model manifest)
associated with the decoder manifest.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_decoder_manifests(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListDecoderManifests"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_decoder_manifests(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListDecoderManifests",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fleets()
list_fleets(params::Dict{String,<:Any})
Retrieves information for each created fleet in an Amazon Web Services account. This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_fleets(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListFleets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_fleets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListFleets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_fleets_for_vehicle(vehicle_name)
list_fleets_for_vehicle(vehicle_name, params::Dict{String,<:Any})
Retrieves a list of IDs for all fleets that the vehicle is associated with. This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Arguments
- `vehicle_name`: The ID of the vehicle to retrieve information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_fleets_for_vehicle(
vehicleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListFleetsForVehicle",
Dict{String,Any}("vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fleets_for_vehicle(
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"ListFleetsForVehicle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicleName" => vehicleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_manifest_nodes(name)
list_model_manifest_nodes(name, params::Dict{String,<:Any})
Lists information about nodes specified in a vehicle model (model manifest). This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Arguments
- `name`: The name of the vehicle model to list information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_model_manifest_nodes(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListModelManifestNodes",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_manifest_nodes(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListModelManifestNodes",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_manifests()
list_model_manifests(params::Dict{String,<:Any})
Retrieves a list of vehicle models (model manifests). This API operation uses
pagination. Specify the nextToken parameter in the request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
- `"signalCatalogArn"`: The ARN of a signal catalog. If you specify a signal catalog, only
the vehicle models associated with it are returned.
"""
function list_model_manifests(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListModelManifests"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_model_manifests(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListModelManifests", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_signal_catalog_nodes(name)
list_signal_catalog_nodes(name, params::Dict{String,<:Any})
Lists of information about the signals (nodes) specified in a signal catalog. This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Arguments
- `name`: The name of the signal catalog to list information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
- `"signalNodeType"`: The type of node in the signal catalog.
"""
function list_signal_catalog_nodes(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListSignalCatalogNodes",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_signal_catalog_nodes(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListSignalCatalogNodes",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signal_catalogs()
list_signal_catalogs(params::Dict{String,<:Any})
Lists all the created signal catalogs in an Amazon Web Services account. You can use to
list information about each signal (node) specified in a signal catalog. This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_signal_catalogs(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListSignalCatalogs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_signal_catalogs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListSignalCatalogs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags (metadata) you have assigned to the resource.
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vehicles()
list_vehicles(params::Dict{String,<:Any})
Retrieves a list of summaries of created vehicles. This API operation uses pagination.
Specify the nextToken parameter in the request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributeNames"`: The fully qualified names of the attributes. For example, the fully
qualified name of an attribute might be Vehicle.Body.Engine.Type.
- `"attributeValues"`: Static information about a vehicle attribute value in string format.
For example: \"1.3 L R2\"
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"modelManifestArn"`: The Amazon Resource Name (ARN) of a vehicle model (model
manifest). You can use this optional parameter to list only the vehicles created from a
certain vehicle model.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_vehicles(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListVehicles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_vehicles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListVehicles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_vehicles_in_fleet(fleet_id)
list_vehicles_in_fleet(fleet_id, params::Dict{String,<:Any})
Retrieves a list of summaries of all vehicles associated with a fleet. This API
operation uses pagination. Specify the nextToken parameter in the request to return more
results.
# Arguments
- `fleet_id`: The ID of a fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return, between 1 and 100, inclusive.
- `"nextToken"`: A pagination token for the next set of results. If the results of a search
are large, only a portion of the results are returned, and a nextToken pagination token is
returned in the response. To retrieve the next set of results, reissue the search request
and include the returned token. When all results have been returned, the response does not
contain a pagination token value.
"""
function list_vehicles_in_fleet(fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"ListVehiclesInFleet",
Dict{String,Any}("fleetId" => fleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vehicles_in_fleet(
fleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"ListVehiclesInFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fleetId" => fleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_encryption_configuration(encryption_type)
put_encryption_configuration(encryption_type, params::Dict{String,<:Any})
Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can
encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a
KMS key that you own and manage. For more information, see Data encryption in the Amazon
Web Services IoT FleetWise Developer Guide.
# Arguments
- `encryption_type`: The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key
or FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"kmsKeyId"`: The ID of the KMS key that is used for encryption.
"""
function put_encryption_configuration(
encryptionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"PutEncryptionConfiguration",
Dict{String,Any}("encryptionType" => encryptionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_encryption_configuration(
encryptionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"PutEncryptionConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("encryptionType" => encryptionType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_logging_options(cloud_watch_log_delivery)
put_logging_options(cloud_watch_log_delivery, params::Dict{String,<:Any})
Creates or updates the logging option.
# Arguments
- `cloud_watch_log_delivery`: Creates or updates the log delivery option to Amazon
CloudWatch Logs.
"""
function put_logging_options(
cloudWatchLogDelivery; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"PutLoggingOptions",
Dict{String,Any}("cloudWatchLogDelivery" => cloudWatchLogDelivery);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_logging_options(
cloudWatchLogDelivery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"PutLoggingOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("cloudWatchLogDelivery" => cloudWatchLogDelivery),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_account()
register_account(params::Dict{String,<:Any})
This API operation contains deprecated parameters. Register your account again without the
Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the
Timestream metadata stored. You should then pass the data destination into the
CreateCampaign API operation. You must delete any existing campaigns that include an empty
data destination before you register your account again. For more information, see the
DeleteCampaign API operation. If you want to delete the Timestream inline policy from the
service-linked role, such as to mitigate an overly permissive policy, you must first delete
any existing campaigns. Then delete the service-linked role and register your account again
to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the
Identity and Access Management API Reference. Registers your Amazon Web Services account,
IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your
vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step
procedures, see Setting up Amazon Web Services IoT FleetWise. An Amazon Web Services
account is not the same thing as a \"user.\" An Amazon Web Services user is an identity
that you create using Identity and Access Management (IAM) and takes the form of either an
IAM user or an IAM role, both with credentials. A single Amazon Web Services account can,
and typically does, contain many users and roles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"iamResources"`: The IAM resource that allows Amazon Web Services IoT FleetWise to send
data to Amazon Timestream.
- `"timestreamResources"`:
"""
function register_account(; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"RegisterAccount"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function register_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"RegisterAccount", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to
manage a resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tags`: The new or modified tags for the resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"TagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the given tags (metadata) from the resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tag_keys`: A list of the keys of the tags to be removed from the resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"UntagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_campaign(action, name)
update_campaign(action, name, params::Dict{String,<:Any})
Updates a campaign.
# Arguments
- `action`: Specifies how to update a campaign. The action can be one of the following:
APPROVE - To approve delivering a data collection scheme to vehicles. SUSPEND - To
suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in
the suspended campaign will stop sending data. RESUME - To reactivate the SUSPEND
campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending
data. UPDATE - To update a campaign.
- `name`: The name of the campaign to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataExtraDimensions"`: A list of vehicle attributes to associate with a signal.
Default: An empty array
- `"description"`: The description of the campaign.
"""
function update_campaign(action, name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"UpdateCampaign",
Dict{String,Any}("action" => action, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_campaign(
action,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"UpdateCampaign",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("action" => action, "name" => name), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_decoder_manifest(name)
update_decoder_manifest(name, params::Dict{String,<:Any})
Updates a decoder manifest. A decoder manifest can only be updated when the status is
DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.
# Arguments
- `name`: The name of the decoder manifest to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the decoder manifest to update.
- `"networkInterfacesToAdd"`: A list of information about the network interfaces to add to
the decoder manifest.
- `"networkInterfacesToRemove"`: A list of network interfaces to remove from the decoder
manifest.
- `"networkInterfacesToUpdate"`: A list of information about the network interfaces to
update in the decoder manifest.
- `"signalDecodersToAdd"`: A list of information about decoding additional signals to add
to the decoder manifest.
- `"signalDecodersToRemove"`: A list of signal decoders to remove from the decoder
manifest.
- `"signalDecodersToUpdate"`: A list of updated information about decoding signals to
update in the decoder manifest.
- `"status"`: The state of the decoder manifest. If the status is ACTIVE, the decoder
manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
"""
function update_decoder_manifest(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"UpdateDecoderManifest",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_decoder_manifest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"UpdateDecoderManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fleet(fleet_id)
update_fleet(fleet_id, params::Dict{String,<:Any})
Updates the description of an existing fleet. If the fleet is successfully updated,
Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
# Arguments
- `fleet_id`: The ID of the fleet to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An updated description of the fleet.
"""
function update_fleet(fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"UpdateFleet",
Dict{String,Any}("fleetId" => fleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fleet(
fleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"UpdateFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fleetId" => fleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model_manifest(name)
update_model_manifest(name, params::Dict{String,<:Any})
Updates a vehicle model (model manifest). If created vehicles are associated with a
vehicle model, it can't be updated.
# Arguments
- `name`: The name of the vehicle model to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the vehicle model.
- `"nodesToAdd"`: A list of fullyQualifiedName of nodes, which are a general abstraction
of signals, to add to the vehicle model.
- `"nodesToRemove"`: A list of fullyQualifiedName of nodes, which are a general
abstraction of signals, to remove from the vehicle model.
- `"status"`: The state of the vehicle model. If the status is ACTIVE, the vehicle model
can't be edited. If the status is DRAFT, you can edit the vehicle model.
"""
function update_model_manifest(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"UpdateModelManifest",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model_manifest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"UpdateModelManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_signal_catalog(name)
update_signal_catalog(name, params::Dict{String,<:Any})
Updates a signal catalog.
# Arguments
- `name`: The name of the signal catalog to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the signal catalog to update.
- `"nodesToAdd"`: A list of information about nodes to add to the signal catalog.
- `"nodesToRemove"`: A list of fullyQualifiedName of nodes to remove from the signal
catalog.
- `"nodesToUpdate"`: A list of information about nodes to update in the signal catalog.
"""
function update_signal_catalog(name; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"UpdateSignalCatalog",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_signal_catalog(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotfleetwise(
"UpdateSignalCatalog",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vehicle(vehicle_name)
update_vehicle(vehicle_name, params::Dict{String,<:Any})
Updates a vehicle.
# Arguments
- `vehicle_name`: The unique ID of the vehicle to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributeUpdateMode"`: The method the specified attributes will update the existing
attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified
attributes. Or use Merge to combine all attributes. This is required if attributes are
present in the input.
- `"attributes"`: Static information about a vehicle in a key-value pair. For example:
\"engineType\" : \"1.3 L R2\"
- `"decoderManifestArn"`: The ARN of the decoder manifest associated with this vehicle.
- `"modelManifestArn"`: The ARN of a vehicle model (model manifest) associated with the
vehicle.
"""
function update_vehicle(vehicleName; aws_config::AbstractAWSConfig=global_aws_config())
return iotfleetwise(
"UpdateVehicle",
Dict{String,Any}("vehicleName" => vehicleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vehicle(
vehicleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotfleetwise(
"UpdateVehicle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vehicleName" => vehicleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 9331 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotsecuretunneling
using AWS.Compat
using AWS.UUIDs
"""
close_tunnel(tunnel_id)
close_tunnel(tunnel_id, params::Dict{String,<:Any})
Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received,
we close the WebSocket connections between the client and proxy server so no data can be
transmitted. Requires permission to access the CloseTunnel action.
# Arguments
- `tunnel_id`: The ID of the tunnel to close.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"delete"`: When set to true, IoT Secure Tunneling deletes the tunnel data immediately.
"""
function close_tunnel(tunnelId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsecuretunneling(
"CloseTunnel",
Dict{String,Any}("tunnelId" => tunnelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function close_tunnel(
tunnelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsecuretunneling(
"CloseTunnel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("tunnelId" => tunnelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tunnel(tunnel_id)
describe_tunnel(tunnel_id, params::Dict{String,<:Any})
Gets information about a tunnel identified by the unique tunnel id. Requires permission to
access the DescribeTunnel action.
# Arguments
- `tunnel_id`: The tunnel to describe.
"""
function describe_tunnel(tunnelId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsecuretunneling(
"DescribeTunnel",
Dict{String,Any}("tunnelId" => tunnelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tunnel(
tunnelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsecuretunneling(
"DescribeTunnel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("tunnelId" => tunnelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for the specified resource.
# Arguments
- `resource_arn`: The resource ARN.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsecuretunneling(
"ListTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsecuretunneling(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tunnels()
list_tunnels(params::Dict{String,<:Any})
List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in
descending order, newer tunnels will be listed before older tunnels. Requires permission to
access the ListTunnels action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at once.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"thingName"`: The name of the IoT thing associated with the destination device.
"""
function list_tunnels(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsecuretunneling(
"ListTunnels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tunnels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsecuretunneling(
"ListTunnels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
open_tunnel()
open_tunnel(params::Dict{String,<:Any})
Creates a new tunnel, and returns two client access tokens for clients to use to connect to
the IoT Secure Tunneling proxy server. Requires permission to access the OpenTunnel action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A short text description of the tunnel.
- `"destinationConfig"`: The destination configuration for the OpenTunnel request.
- `"tags"`: A collection of tag metadata.
- `"timeoutConfig"`: Timeout configuration for a tunnel.
"""
function open_tunnel(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsecuretunneling(
"OpenTunnel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function open_tunnel(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsecuretunneling(
"OpenTunnel", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
rotate_tunnel_access_token(client_mode, tunnel_id)
rotate_tunnel_access_token(client_mode, tunnel_id, params::Dict{String,<:Any})
Revokes the current client access token (CAT) and returns new CAT for clients to use when
reconnecting to secure tunneling to access the same tunnel. Requires permission to access
the RotateTunnelAccessToken action. Rotating the CAT doesn't extend the tunnel duration.
For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4
hours. When you rotate the access tokens, the new tokens that are generated can only be
used for the remaining 8 hours.
# Arguments
- `client_mode`: The mode of the client that will use the client token, which can be either
the source or destination, or both source and destination.
- `tunnel_id`: The tunnel for which you want to rotate the access tokens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationConfig"`:
"""
function rotate_tunnel_access_token(
clientMode, tunnelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsecuretunneling(
"RotateTunnelAccessToken",
Dict{String,Any}("clientMode" => clientMode, "tunnelId" => tunnelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_tunnel_access_token(
clientMode,
tunnelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsecuretunneling(
"RotateTunnelAccessToken",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("clientMode" => clientMode, "tunnelId" => tunnelId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
A resource tag.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tags`: The tags for the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotsecuretunneling(
"TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsecuretunneling(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from a resource.
# Arguments
- `resource_arn`: The resource ARN.
- `tag_keys`: The keys of the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsecuretunneling(
"UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsecuretunneling(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 155723 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotsitewise
using AWS.Compat
using AWS.UUIDs
"""
associate_assets(asset_id, child_asset_id, hierarchy_id)
associate_assets(asset_id, child_asset_id, hierarchy_id, params::Dict{String,<:Any})
Associates a child asset with the given parent asset through a hierarchy defined in the
parent asset's model. For more information, see Associating assets in the IoT SiteWise User
Guide.
# Arguments
- `asset_id`: The ID of the parent asset. This can be either the actual ID in UUID format,
or else externalId: followed by the external ID, if it has one. For more information, see
Referencing objects with external IDs in the IoT SiteWise User Guide.
- `child_asset_id`: The ID of the child asset to be associated. This can be either the
actual ID in UUID format, or else externalId: followed by the external ID, if it has one.
For more information, see Referencing objects with external IDs in the IoT SiteWise User
Guide.
- `hierarchy_id`: The ID of a hierarchy in the parent asset's model. (This can be either
the actual ID in UUID format, or else externalId: followed by the external ID, if it has
one. For more information, see Referencing objects with external IDs in the IoT SiteWise
User Guide.) Hierarchies allow different groupings of assets to be formed that all come
from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise
User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function associate_assets(
assetId, childAssetId, hierarchyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/assets/$(assetId)/associate",
Dict{String,Any}(
"childAssetId" => childAssetId,
"hierarchyId" => hierarchyId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_assets(
assetId,
childAssetId,
hierarchyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/assets/$(assetId)/associate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"childAssetId" => childAssetId,
"hierarchyId" => hierarchyId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_time_series_to_asset_property(alias, asset_id, property_id)
associate_time_series_to_asset_property(alias, asset_id, property_id, params::Dict{String,<:Any})
Associates a time series (data stream) with an asset property.
# Arguments
- `alias`: The alias that identifies the time series.
- `asset_id`: The ID of the asset in which the asset property was created. This can be
either the actual ID in UUID format, or else externalId: followed by the external ID, if it
has one. For more information, see Referencing objects with external IDs in the IoT
SiteWise User Guide.
- `property_id`: The ID of the asset property. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function associate_time_series_to_asset_property(
alias, assetId, propertyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/timeseries/associate/",
Dict{String,Any}(
"alias" => alias,
"assetId" => assetId,
"propertyId" => propertyId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_time_series_to_asset_property(
alias,
assetId,
propertyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/timeseries/associate/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"alias" => alias,
"assetId" => assetId,
"propertyId" => propertyId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_associate_project_assets(asset_ids, project_id)
batch_associate_project_assets(asset_ids, project_id, params::Dict{String,<:Any})
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
# Arguments
- `asset_ids`: The IDs of the assets to be associated to the project.
- `project_id`: The ID of the project to which to associate the assets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function batch_associate_project_assets(
assetIds, projectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/projects/$(projectId)/assets/associate",
Dict{String,Any}("assetIds" => assetIds, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_project_assets(
assetIds,
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/projects/$(projectId)/assets/associate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assetIds" => assetIds, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_project_assets(asset_ids, project_id)
batch_disassociate_project_assets(asset_ids, project_id, params::Dict{String,<:Any})
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
# Arguments
- `asset_ids`: The IDs of the assets to be disassociated from the project.
- `project_id`: The ID of the project from which to disassociate the assets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function batch_disassociate_project_assets(
assetIds, projectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/projects/$(projectId)/assets/disassociate",
Dict{String,Any}("assetIds" => assetIds, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_project_assets(
assetIds,
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/projects/$(projectId)/assets/disassociate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assetIds" => assetIds, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_asset_property_aggregates(entries)
batch_get_asset_property_aggregates(entries, params::Dict{String,<:Any})
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
# Arguments
- `entries`: The list of asset property aggregate entries for the batch get request. You
can specify up to 16 entries per request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request. A
result set is returned in the two cases, whichever occurs first. The size of the result
set is equal to 1 MB. The number of data points in the result set is equal to the value
of maxResults. The maximum value of maxResults is 4000.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function batch_get_asset_property_aggregates(
entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties/batch/aggregates",
Dict{String,Any}("entries" => entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_asset_property_aggregates(
entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties/batch/aggregates",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("entries" => entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_asset_property_value(entries)
batch_get_asset_property_value(entries, params::Dict{String,<:Any})
Gets the current value for one or more asset properties. For more information, see Querying
current values in the IoT SiteWise User Guide.
# Arguments
- `entries`: The list of asset property value entries for the batch get request. You can
specify up to 128 entries per request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function batch_get_asset_property_value(
entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties/batch/latest",
Dict{String,Any}("entries" => entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_asset_property_value(
entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties/batch/latest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("entries" => entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_asset_property_value_history(entries)
batch_get_asset_property_value_history(entries, params::Dict{String,<:Any})
Gets the historical values for one or more asset properties. For more information, see
Querying historical values in the IoT SiteWise User Guide.
# Arguments
- `entries`: The list of asset property historical value entries for the batch get request.
You can specify up to 16 entries per request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request. A
result set is returned in the two cases, whichever occurs first. The size of the result
set is equal to 4 MB. The number of data points in the result set is equal to the value
of maxResults. The maximum value of maxResults is 20000.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function batch_get_asset_property_value_history(
entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties/batch/history",
Dict{String,Any}("entries" => entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_asset_property_value_history(
entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties/batch/history",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("entries" => entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_asset_property_value(entries)
batch_put_asset_property_value(entries, params::Dict{String,<:Any})
Sends a list of asset property values to IoT SiteWise. Each value is a
timestamp-quality-value (TQV) data point. For more information, see Ingesting data using
the API in the IoT SiteWise User Guide. To identify an asset property, you must specify one
of the following: The assetId and propertyId of an asset property. A propertyAlias,
which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To
define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch
time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the
past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of
the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException
error. For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps
unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD,
V1}, then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise authorizes access
to each BatchPutAssetPropertyValue entry individually. For more information, see
BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
# Arguments
- `entries`: The list of asset property value entries for the batch put request. You can
specify up to 10 entries per request.
"""
function batch_put_asset_property_value(
entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties",
Dict{String,Any}("entries" => entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_asset_property_value(
entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/properties",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("entries" => entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_policy(access_policy_identity, access_policy_permission, access_policy_resource)
create_access_policy(access_policy_identity, access_policy_permission, access_policy_resource, params::Dict{String,<:Any})
Creates an access policy that grants the specified identity (IAM Identity Center user, IAM
Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or
project resource.
# Arguments
- `access_policy_identity`: The identity for this access policy. Choose an IAM Identity
Center user, an IAM Identity Center group, or an IAM user.
- `access_policy_permission`: The permission level for this access policy. Note that a
project ADMINISTRATOR is also known as a project owner.
- `access_policy_resource`: The IoT SiteWise Monitor resource for this access policy.
Choose either a portal or a project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"tags"`: A list of key-value pairs that contain metadata for the access policy. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_access_policy(
accessPolicyIdentity,
accessPolicyPermission,
accessPolicyResource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/access-policies",
Dict{String,Any}(
"accessPolicyIdentity" => accessPolicyIdentity,
"accessPolicyPermission" => accessPolicyPermission,
"accessPolicyResource" => accessPolicyResource,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_policy(
accessPolicyIdentity,
accessPolicyPermission,
accessPolicyResource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/access-policies",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accessPolicyIdentity" => accessPolicyIdentity,
"accessPolicyPermission" => accessPolicyPermission,
"accessPolicyResource" => accessPolicyResource,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_asset(asset_model_id, asset_name)
create_asset(asset_model_id, asset_name, params::Dict{String,<:Any})
Creates an asset from an existing asset model. For more information, see Creating assets in
the IoT SiteWise User Guide.
# Arguments
- `asset_model_id`: The ID of the asset model from which to create the asset. This can be
either the actual ID in UUID format, or else externalId: followed by the external ID, if it
has one. For more information, see Referencing objects with external IDs in the IoT
SiteWise User Guide.
- `asset_name`: A friendly name for the asset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetDescription"`: A description for the asset.
- `"assetExternalId"`: An external ID to assign to the asset. The external ID must be
unique within your Amazon Web Services account. For more information, see Using external
IDs in the IoT SiteWise User Guide.
- `"assetId"`: The ID to assign to the asset, if desired. IoT SiteWise automatically
generates a unique ID for you, so this parameter is never required. However, if you prefer
to supply your own ID instead, you can specify it here in UUID format. If you specify your
own ID, it must be globally unique.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"tags"`: A list of key-value pairs that contain metadata for the asset. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_asset(
assetModelId, assetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/assets",
Dict{String,Any}(
"assetModelId" => assetModelId,
"assetName" => assetName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset(
assetModelId,
assetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/assets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assetModelId" => assetModelId,
"assetName" => assetName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_asset_model(asset_model_name)
create_asset_model(asset_model_name, params::Dict{String,<:Any})
Creates an asset model from specified property and hierarchy definitions. You create assets
from asset models. With asset models, you can easily create assets of the same type that
have standardized definitions. Each asset created from a model inherits the asset model's
property and hierarchy definitions. For more information, see Defining asset models in the
IoT SiteWise User Guide. You can create two types of asset models, ASSET_MODEL or
COMPONENT_MODEL. ASSET_MODEL – (default) An asset model that you can use to create
assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A
reusable component that you can include in the composite models of other asset models. You
can't create assets directly from this type of asset model.
# Arguments
- `asset_model_name`: A unique, friendly name for the asset model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetModelCompositeModels"`: The composite models that are part of this asset model. It
groups properties (such as attributes, measurements, transforms, and metrics) and child
composite models that model parts of your industrial equipment. Each composite model has a
type that defines the properties that the composite model supports. Use composite models to
define alarms on this asset model. When creating custom composite models, you need to use
CreateAssetModelCompositeModel. For more information, see <LINK>.
- `"assetModelDescription"`: A description for the asset model.
- `"assetModelExternalId"`: An external ID to assign to the asset model. The external ID
must be unique within your Amazon Web Services account. For more information, see Using
external IDs in the IoT SiteWise User Guide.
- `"assetModelHierarchies"`: The hierarchy definitions of the asset model. Each hierarchy
specifies an asset model whose assets can be children of any other assets created from this
asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in
the IoT SiteWise User Guide.
- `"assetModelId"`: The ID to assign to the asset model, if desired. IoT SiteWise
automatically generates a unique ID for you, so this parameter is never required. However,
if you prefer to supply your own ID instead, you can specify it here in UUID format. If you
specify your own ID, it must be globally unique.
- `"assetModelProperties"`: The property definitions of the asset model. For more
information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200
properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
- `"assetModelType"`: The type of asset model. ASSET_MODEL – (default) An asset model
that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of
other asset models. You can't create assets directly from this type of asset model.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"tags"`: A list of key-value pairs that contain metadata for the asset model. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_asset_model(
assetModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/asset-models",
Dict{String,Any}(
"assetModelName" => assetModelName, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset_model(
assetModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/asset-models",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assetModelName" => assetModelName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_asset_model_composite_model(asset_model_composite_model_name, asset_model_composite_model_type, asset_model_id)
create_asset_model_composite_model(asset_model_composite_model_name, asset_model_composite_model_type, asset_model_id, params::Dict{String,<:Any})
Creates a custom composite model from specified property and hierarchy definitions. There
are two types of custom composite models, inline and component-model-based. Use
component-model-based custom composite models to define standard, reusable components. A
component-model-based custom composite model consists of a name, a description, and the ID
of the component model it references. A component-model-based custom composite model has no
properties of its own; its referenced component model provides its associated properties to
any created assets. For more information, see Custom composite models (Components) in the
IoT SiteWise User Guide. Use inline custom composite models to organize the properties of
an asset model. The properties of inline custom composite models are local to the asset
model where they are included and can't be used to create multiple assets. To create a
component-model-based model, specify the composedAssetModelId of an existing asset model
with assetModelType of COMPONENT_MODEL. To create an inline model, specify the
assetModelCompositeModelProperties and don't include an composedAssetModelId.
# Arguments
- `asset_model_composite_model_name`: A unique, friendly name for the composite model.
- `asset_model_composite_model_type`: The composite model type. Valid values are AWS/ALARM,
CUSTOM, or AWS/L4E_ANOMALY.
- `asset_model_id`: The ID of the asset model this composite model is a part of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetModelCompositeModelDescription"`: A description for the composite model.
- `"assetModelCompositeModelExternalId"`: An external ID to assign to the composite model.
If the composite model is a derived composite model, or one nested inside a component
model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying
the derived ID of the model or property from the created model it's a part of.
- `"assetModelCompositeModelId"`: The ID of the composite model. IoT SiteWise automatically
generates a unique ID for you, so this parameter is never required. However, if you prefer
to supply your own ID instead, you can specify it here in UUID format. If you specify your
own ID, it must be globally unique.
- `"assetModelCompositeModelProperties"`: The property definitions of the composite model.
For more information, see <LINK>. You can specify up to 200 properties per composite
model. For more information, see Quotas in the IoT SiteWise User Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"composedAssetModelId"`: The ID of a composite model on this asset.
- `"parentAssetModelCompositeModelId"`: The ID of the parent composite model in this asset
model relationship.
"""
function create_asset_model_composite_model(
assetModelCompositeModelName,
assetModelCompositeModelType,
assetModelId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/asset-models/$(assetModelId)/composite-models",
Dict{String,Any}(
"assetModelCompositeModelName" => assetModelCompositeModelName,
"assetModelCompositeModelType" => assetModelCompositeModelType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset_model_composite_model(
assetModelCompositeModelName,
assetModelCompositeModelType,
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/asset-models/$(assetModelId)/composite-models",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assetModelCompositeModelName" => assetModelCompositeModelName,
"assetModelCompositeModelType" => assetModelCompositeModelType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bulk_import_job(error_report_location, files, job_configuration, job_name, job_role_arn)
create_bulk_import_job(error_report_location, files, job_configuration, job_name, job_role_arn, params::Dict{String,<:Any})
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see
Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. Before you
create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.
For more information about how to configure storage settings, see PutStorageConfiguration.
Bulk import is designed to store historical data to IoT SiteWise. It does not trigger
computations or notifications on IoT SiteWise warm or cold tier storage.
# Arguments
- `error_report_location`: The Amazon S3 destination where errors associated with the job
creation request are saved.
- `files`: The files in the specified Amazon S3 bucket that contain your data.
- `job_configuration`: Contains the configuration information of a job, such as the file
format used to save data in Amazon S3.
- `job_name`: The unique name that helps identify the job request.
- `job_role_arn`: The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adaptiveIngestion"`: If set to true, ingest new data into IoT SiteWise storage.
Measurements with notifications, metrics and transforms are computed. If set to false,
historical data is ingested into IoT SiteWise as is.
- `"deleteFilesAfterImport"`: If set to true, your data files is deleted from S3, after
ingestion into IoT SiteWise storage.
"""
function create_bulk_import_job(
errorReportLocation,
files,
jobConfiguration,
jobName,
jobRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/jobs",
Dict{String,Any}(
"errorReportLocation" => errorReportLocation,
"files" => files,
"jobConfiguration" => jobConfiguration,
"jobName" => jobName,
"jobRoleArn" => jobRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bulk_import_job(
errorReportLocation,
files,
jobConfiguration,
jobName,
jobRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"errorReportLocation" => errorReportLocation,
"files" => files,
"jobConfiguration" => jobConfiguration,
"jobName" => jobName,
"jobRoleArn" => jobRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dashboard(dashboard_definition, dashboard_name, project_id)
create_dashboard(dashboard_definition, dashboard_name, project_id, params::Dict{String,<:Any})
Creates a dashboard in an IoT SiteWise Monitor project.
# Arguments
- `dashboard_definition`: The dashboard definition specified in a JSON literal. For
detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
- `dashboard_name`: A friendly name for the dashboard.
- `project_id`: The ID of the project in which to create the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"dashboardDescription"`: A description for the dashboard.
- `"tags"`: A list of key-value pairs that contain metadata for the dashboard. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_dashboard(
dashboardDefinition,
dashboardName,
projectId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/dashboards",
Dict{String,Any}(
"dashboardDefinition" => dashboardDefinition,
"dashboardName" => dashboardName,
"projectId" => projectId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dashboard(
dashboardDefinition,
dashboardName,
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/dashboards",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dashboardDefinition" => dashboardDefinition,
"dashboardName" => dashboardName,
"projectId" => projectId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_gateway(gateway_name, gateway_platform)
create_gateway(gateway_name, gateway_platform, params::Dict{String,<:Any})
Creates a gateway, which is a virtual or edge device that delivers industrial data streams
from local servers to IoT SiteWise. For more information, see Ingesting data using a
gateway in the IoT SiteWise User Guide.
# Arguments
- `gateway_name`: A unique, friendly name for the gateway.
- `gateway_platform`: The gateway's platform. You can only specify one platform in a
gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of key-value pairs that contain metadata for the gateway. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_gateway(
gatewayName, gatewayPlatform; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/20200301/gateways",
Dict{String,Any}(
"gatewayName" => gatewayName, "gatewayPlatform" => gatewayPlatform
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_gateway(
gatewayName,
gatewayPlatform,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/20200301/gateways",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"gatewayName" => gatewayName, "gatewayPlatform" => gatewayPlatform
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_portal(portal_contact_email, portal_name, role_arn)
create_portal(portal_contact_email, portal_name, role_arn, params::Dict{String,<:Any})
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM
Identity Center or IAM to authenticate portal users and manage user permissions. Before
you can sign in to a new portal, you must add at least one identity to that portal. For
more information, see Adding or removing portal administrators in the IoT SiteWise User
Guide.
# Arguments
- `portal_contact_email`: The Amazon Web Services administrator's contact email address.
- `portal_name`: A friendly name for the portal.
- `role_arn`: The ARN of a service role that allows the portal's users to access your IoT
SiteWise resources on your behalf. For more information, see Using service roles for IoT
SiteWise Monitor in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alarms"`: Contains the configuration information of an alarm created in an IoT SiteWise
Monitor portal. You can use the alarm to monitor an asset property and get notified when
the asset property value is outside a specified range. For more information, see Monitoring
with alarms in the IoT SiteWise Application Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"notificationSenderEmail"`: The email address that sends alarm notifications. If you
use the IoT Events managed Lambda function to manage your emails, you must verify the
sender email address in Amazon SES.
- `"portalAuthMode"`: The service to use to authenticate users to the portal. Choose from
the following options: SSO – The portal uses IAM Identity Center to authenticate users
and manage user permissions. Before you can create a portal that uses IAM Identity Center,
you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center
in the IoT SiteWise User Guide. This option is only available in Amazon Web Services
Regions other than the China Regions. IAM – The portal uses Identity and Access
Management to authenticate users and manage user permissions. You can't change this value
after you create a portal. Default: SSO
- `"portalDescription"`: A description for the portal.
- `"portalLogoImageFile"`: A logo image to display in the portal. Upload a square,
high-resolution image. The image is displayed on a dark background.
- `"tags"`: A list of key-value pairs that contain metadata for the portal. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_portal(
portalContactEmail,
portalName,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/portals",
Dict{String,Any}(
"portalContactEmail" => portalContactEmail,
"portalName" => portalName,
"roleArn" => roleArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_portal(
portalContactEmail,
portalName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/portals",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"portalContactEmail" => portalContactEmail,
"portalName" => portalName,
"roleArn" => roleArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(portal_id, project_name)
create_project(portal_id, project_name, params::Dict{String,<:Any})
Creates a project in the specified portal. Make sure that the project name and description
don't contain confidential information.
# Arguments
- `portal_id`: The ID of the portal in which to create the project.
- `project_name`: A friendly name for the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"projectDescription"`: A description for the project.
- `"tags"`: A list of key-value pairs that contain metadata for the project. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function create_project(
portalId, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/projects",
Dict{String,Any}(
"portalId" => portalId,
"projectName" => projectName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
portalId,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/projects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"portalId" => portalId,
"projectName" => projectName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_policy(access_policy_id)
delete_access_policy(access_policy_id, params::Dict{String,<:Any})
Deletes an access policy that grants the specified identity access to the specified IoT
SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise
Monitor resource.
# Arguments
- `access_policy_id`: The ID of the access policy to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_access_policy(
accessPolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"DELETE",
"/access-policies/$(accessPolicyId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_policy(
accessPolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/access-policies/$(accessPolicyId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset(asset_id)
delete_asset(asset_id, params::Dict{String,<:Any})
Deletes an asset. This action can't be undone. For more information, see Deleting assets
and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to
another asset. For more information, see DisassociateAssets.
# Arguments
- `asset_id`: The ID of the asset to delete. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_asset(assetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"DELETE",
"/assets/$(assetId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_asset(
assetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"DELETE",
"/assets/$(assetId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset_model(asset_model_id)
delete_asset_model(asset_model_id, params::Dict{String,<:Any})
Deletes an asset model. This action can't be undone. You must delete all assets created
from an asset model before you can delete the model. Also, you can't delete an asset model
if a parent asset model exists that contains a property formula expression that depends on
the asset model that you want to delete. For more information, see Deleting assets and
models in the IoT SiteWise User Guide.
# Arguments
- `asset_model_id`: The ID of the asset model to delete. This can be either the actual ID
in UUID format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_asset_model(assetModelId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"DELETE",
"/asset-models/$(assetModelId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_asset_model(
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/asset-models/$(assetModelId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset_model_composite_model(asset_model_composite_model_id, asset_model_id)
delete_asset_model_composite_model(asset_model_composite_model_id, asset_model_id, params::Dict{String,<:Any})
Deletes a composite model. This action can't be undone. You must delete all assets created
from a composite model before you can delete the model. Also, you can't delete a composite
model if a parent asset model exists that contains a property formula expression that
depends on the asset model that you want to delete. For more information, see Deleting
assets and models in the IoT SiteWise User Guide.
# Arguments
- `asset_model_composite_model_id`: The ID of a composite model on this asset model.
- `asset_model_id`: The ID of the asset model, in UUID format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_asset_model_composite_model(
assetModelCompositeModelId,
assetModelId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/asset-models/$(assetModelId)/composite-models/$(assetModelCompositeModelId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_asset_model_composite_model(
assetModelCompositeModelId,
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/asset-models/$(assetModelId)/composite-models/$(assetModelCompositeModelId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dashboard(dashboard_id)
delete_dashboard(dashboard_id, params::Dict{String,<:Any})
Deletes a dashboard from IoT SiteWise Monitor.
# Arguments
- `dashboard_id`: The ID of the dashboard to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_dashboard(dashboardId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"DELETE",
"/dashboards/$(dashboardId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dashboard(
dashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/dashboards/$(dashboardId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_gateway(gateway_id)
delete_gateway(gateway_id, params::Dict{String,<:Any})
Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files
remain in your gateway's file system.
# Arguments
- `gateway_id`: The ID of the gateway to delete.
"""
function delete_gateway(gatewayId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"DELETE",
"/20200301/gateways/$(gatewayId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_gateway(
gatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/20200301/gateways/$(gatewayId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_portal(portal_id)
delete_portal(portal_id, params::Dict{String,<:Any})
Deletes a portal from IoT SiteWise Monitor.
# Arguments
- `portal_id`: The ID of the portal to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_portal(portalId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"DELETE",
"/portals/$(portalId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_portal(
portalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/portals/$(portalId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(project_id)
delete_project(project_id, params::Dict{String,<:Any})
Deletes a project from IoT SiteWise Monitor.
# Arguments
- `project_id`: The ID of the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function delete_project(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"DELETE",
"/projects/$(projectId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/projects/$(projectId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_time_series()
delete_time_series(params::Dict{String,<:Any})
Deletes a time series (data stream). If you delete a time series that's associated with an
asset property, the asset property still exists, but the time series will no longer be
associated with this asset property. To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time
series. If the time series is associated with an asset property, specify one of the
following: The alias of the time series. The assetId and propertyId that identifies
the asset property.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias"`: The alias that identifies the time series.
- `"assetId"`: The ID of the asset in which the asset property was created. This can be
either the actual ID in UUID format, or else externalId: followed by the external ID, if it
has one. For more information, see Referencing objects with external IDs in the IoT
SiteWise User Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"propertyId"`: The ID of the asset property. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
"""
function delete_time_series(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"POST",
"/timeseries/delete/",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_time_series(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/timeseries/delete/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_access_policy(access_policy_id)
describe_access_policy(access_policy_id, params::Dict{String,<:Any})
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor
portal or project.
# Arguments
- `access_policy_id`: The ID of the access policy.
"""
function describe_access_policy(
accessPolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/access-policies/$(accessPolicyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_access_policy(
accessPolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/access-policies/$(accessPolicyId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_action(action_id)
describe_action(action_id, params::Dict{String,<:Any})
Retrieves information about an action.
# Arguments
- `action_id`: The ID of the action.
"""
function describe_action(actionId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/actions/$(actionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_action(
actionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/actions/$(actionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset(asset_id)
describe_asset(asset_id, params::Dict{String,<:Any})
Retrieves information about an asset.
# Arguments
- `asset_id`: The ID of the asset. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see
Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"excludeProperties"`: Whether or not to exclude asset properties from the response.
"""
function describe_asset(assetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/assets/$(assetId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_asset(
assetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/assets/$(assetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset_composite_model(asset_composite_model_id, asset_id)
describe_asset_composite_model(asset_composite_model_id, asset_id, params::Dict{String,<:Any})
Retrieves information about an asset composite model (also known as an asset component). An
AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see
information about the model this is based on, call DescribeAssetModelCompositeModel.
# Arguments
- `asset_composite_model_id`: The ID of a composite model on this asset. This can be either
the actual ID in UUID format, or else externalId: followed by the external ID, if it has
one. For more information, see Referencing objects with external IDs in the IoT SiteWise
User Guide.
- `asset_id`: The ID of the asset. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see
Referencing objects with external IDs in the IoT SiteWise User Guide.
"""
function describe_asset_composite_model(
assetCompositeModelId, assetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/assets/$(assetId)/composite-models/$(assetCompositeModelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_asset_composite_model(
assetCompositeModelId,
assetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/assets/$(assetId)/composite-models/$(assetCompositeModelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset_model(asset_model_id)
describe_asset_model(asset_model_id, params::Dict{String,<:Any})
Retrieves information about an asset model.
# Arguments
- `asset_model_id`: The ID of the asset model. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"excludeProperties"`: Whether or not to exclude asset model properties from the
response.
"""
function describe_asset_model(
assetModelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_asset_model(
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset_model_composite_model(asset_model_composite_model_id, asset_model_id)
describe_asset_model_composite_model(asset_model_composite_model_id, asset_model_id, params::Dict{String,<:Any})
Retrieves information about an asset model composite model (also known as an asset model
component). For more information, see Custom composite models (Components) in the IoT
SiteWise User Guide.
# Arguments
- `asset_model_composite_model_id`: The ID of a composite model on this asset model. This
can be either the actual ID in UUID format, or else externalId: followed by the external
ID, if it has one. For more information, see Referencing objects with external IDs in the
IoT SiteWise User Guide.
- `asset_model_id`: The ID of the asset model. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
"""
function describe_asset_model_composite_model(
assetModelCompositeModelId,
assetModelId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/composite-models/$(assetModelCompositeModelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_asset_model_composite_model(
assetModelCompositeModelId,
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/composite-models/$(assetModelCompositeModelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset_property(asset_id, property_id)
describe_asset_property(asset_id, property_id, params::Dict{String,<:Any})
Retrieves information about an asset property. When you call this operation for an
attribute property, this response includes the default attribute value that you define in
the asset model. If you update the default value in the model, this operation's response
includes the new default value. This operation doesn't return the value of the asset
property. To get the value of an asset property, use GetAssetPropertyValue.
# Arguments
- `asset_id`: The ID of the asset. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see
Referencing objects with external IDs in the IoT SiteWise User Guide.
- `property_id`: The ID of the asset property. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
"""
function describe_asset_property(
assetId, propertyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/assets/$(assetId)/properties/$(propertyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_asset_property(
assetId,
propertyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/assets/$(assetId)/properties/$(propertyId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bulk_import_job(job_id)
describe_bulk_import_job(job_id, params::Dict{String,<:Any})
Retrieves information about a bulk import job request. For more information, see Describe a
bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
# Arguments
- `job_id`: The ID of the job.
"""
function describe_bulk_import_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/jobs/$(jobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_bulk_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dashboard(dashboard_id)
describe_dashboard(dashboard_id, params::Dict{String,<:Any})
Retrieves information about a dashboard.
# Arguments
- `dashboard_id`: The ID of the dashboard.
"""
function describe_dashboard(dashboardId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/dashboards/$(dashboardId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dashboard(
dashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/dashboards/$(dashboardId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_default_encryption_configuration()
describe_default_encryption_configuration(params::Dict{String,<:Any})
Retrieves information about the default encryption configuration for the Amazon Web
Services account in the default or specified Region. For more information, see Key
management in the IoT SiteWise User Guide.
"""
function describe_default_encryption_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/configuration/account/encryption";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_default_encryption_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/configuration/account/encryption",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_gateway(gateway_id)
describe_gateway(gateway_id, params::Dict{String,<:Any})
Retrieves information about a gateway.
# Arguments
- `gateway_id`: The ID of the gateway device.
"""
function describe_gateway(gatewayId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/20200301/gateways/$(gatewayId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_gateway(
gatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/20200301/gateways/$(gatewayId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_gateway_capability_configuration(capability_namespace, gateway_id)
describe_gateway_capability_configuration(capability_namespace, gateway_id, params::Dict{String,<:Any})
Retrieves information about a gateway capability configuration. Each gateway capability
defines data sources for a gateway. A capability configuration can contain multiple data
source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise
console, all of your OPC-UA sources are stored in one capability configuration. To list all
capability configurations for a gateway, use DescribeGateway.
# Arguments
- `capability_namespace`: The namespace of the capability configuration. For example, if
you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability
configuration has the namespace iotsitewise:opcuacollector:version, where version is a
number such as 1.
- `gateway_id`: The ID of the gateway that defines the capability configuration.
"""
function describe_gateway_capability_configuration(
capabilityNamespace, gatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/20200301/gateways/$(gatewayId)/capability/$(capabilityNamespace)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_gateway_capability_configuration(
capabilityNamespace,
gatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/20200301/gateways/$(gatewayId)/capability/$(capabilityNamespace)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_logging_options()
describe_logging_options(params::Dict{String,<:Any})
Retrieves the current IoT SiteWise logging options.
"""
function describe_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/logging"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_logging_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET", "/logging", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_portal(portal_id)
describe_portal(portal_id, params::Dict{String,<:Any})
Retrieves information about a portal.
# Arguments
- `portal_id`: The ID of the portal.
"""
function describe_portal(portalId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/portals/$(portalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_portal(
portalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/portals/$(portalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(project_id)
describe_project(project_id, params::Dict{String,<:Any})
Retrieves information about a project.
# Arguments
- `project_id`: The ID of the project.
"""
function describe_project(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/projects/$(projectId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_project(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/projects/$(projectId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_storage_configuration()
describe_storage_configuration(params::Dict{String,<:Any})
Retrieves information about the storage configuration for IoT SiteWise.
"""
function describe_storage_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/configuration/account/storage";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_storage_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/configuration/account/storage",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_time_series()
describe_time_series(params::Dict{String,<:Any})
Retrieves information about a time series (data stream). To identify a time series, do one
of the following: If the time series isn't associated with an asset property, specify the
alias of the time series. If the time series is associated with an asset property,
specify one of the following: The alias of the time series. The assetId and propertyId
that identifies the asset property.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias"`: The alias that identifies the time series.
- `"assetId"`: The ID of the asset in which the asset property was created. This can be
either the actual ID in UUID format, or else externalId: followed by the external ID, if it
has one. For more information, see Referencing objects with external IDs in the IoT
SiteWise User Guide.
- `"propertyId"`: The ID of the asset property. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
"""
function describe_time_series(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/timeseries/describe/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_time_series(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/timeseries/describe/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_assets(asset_id, child_asset_id, hierarchy_id)
disassociate_assets(asset_id, child_asset_id, hierarchy_id, params::Dict{String,<:Any})
Disassociates a child asset from the given parent asset through a hierarchy defined in the
parent asset's model.
# Arguments
- `asset_id`: The ID of the parent asset from which to disassociate the child asset. This
can be either the actual ID in UUID format, or else externalId: followed by the external
ID, if it has one. For more information, see Referencing objects with external IDs in the
IoT SiteWise User Guide.
- `child_asset_id`: The ID of the child asset to disassociate. This can be either the
actual ID in UUID format, or else externalId: followed by the external ID, if it has one.
For more information, see Referencing objects with external IDs in the IoT SiteWise User
Guide.
- `hierarchy_id`: The ID of a hierarchy in the parent asset's model. (This can be either
the actual ID in UUID format, or else externalId: followed by the external ID, if it has
one. For more information, see Referencing objects with external IDs in the IoT SiteWise
User Guide.) Hierarchies allow different groupings of assets to be formed that all come
from the same asset model. You can use the hierarchy ID to identify the correct asset to
disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function disassociate_assets(
assetId, childAssetId, hierarchyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/assets/$(assetId)/disassociate",
Dict{String,Any}(
"childAssetId" => childAssetId,
"hierarchyId" => hierarchyId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_assets(
assetId,
childAssetId,
hierarchyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/assets/$(assetId)/disassociate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"childAssetId" => childAssetId,
"hierarchyId" => hierarchyId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_time_series_from_asset_property(alias, asset_id, property_id)
disassociate_time_series_from_asset_property(alias, asset_id, property_id, params::Dict{String,<:Any})
Disassociates a time series (data stream) from an asset property.
# Arguments
- `alias`: The alias that identifies the time series.
- `asset_id`: The ID of the asset in which the asset property was created. This can be
either the actual ID in UUID format, or else externalId: followed by the external ID, if it
has one. For more information, see Referencing objects with external IDs in the IoT
SiteWise User Guide.
- `property_id`: The ID of the asset property. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function disassociate_time_series_from_asset_property(
alias, assetId, propertyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/timeseries/disassociate/",
Dict{String,Any}(
"alias" => alias,
"assetId" => assetId,
"propertyId" => propertyId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_time_series_from_asset_property(
alias,
assetId,
propertyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/timeseries/disassociate/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"alias" => alias,
"assetId" => assetId,
"propertyId" => propertyId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_action(action_definition_id, action_payload, target_resource)
execute_action(action_definition_id, action_payload, target_resource, params::Dict{String,<:Any})
Executes an action on a target resource.
# Arguments
- `action_definition_id`: The ID of the action definition.
- `action_payload`: The JSON payload of the action.
- `target_resource`: The resource the action will be taken on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function execute_action(
actionDefinitionId,
actionPayload,
targetResource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/actions",
Dict{String,Any}(
"actionDefinitionId" => actionDefinitionId,
"actionPayload" => actionPayload,
"targetResource" => targetResource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_action(
actionDefinitionId,
actionPayload,
targetResource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/actions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionDefinitionId" => actionDefinitionId,
"actionPayload" => actionPayload,
"targetResource" => targetResource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_query(query_statement)
execute_query(query_statement, params::Dict{String,<:Any})
Run SQL queries to retrieve metadata and time-series data from asset models, assets,
measurements, metrics, transforms, and aggregates.
# Arguments
- `query_statement`: The IoT SiteWise query statement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The string that specifies the next page of results.
"""
function execute_query(queryStatement; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"POST",
"/queries/execution",
Dict{String,Any}("queryStatement" => queryStatement);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_query(
queryStatement,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/queries/execution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryStatement" => queryStatement), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset_property_aggregates(aggregate_types, end_date, resolution, start_date)
get_asset_property_aggregates(aggregate_types, end_date, resolution, start_date, params::Dict{String,<:Any})
Gets aggregated values for an asset property. For more information, see Querying aggregates
in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the
following: The assetId and propertyId of an asset property. A propertyAlias, which is a
data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an
asset property's alias, see UpdateAssetProperty.
# Arguments
- `aggregate_types`: The data aggregating function.
- `end_date`: The inclusive end of the range from which to query historical data, expressed
in seconds in Unix epoch time.
- `resolution`: The time interval over which to aggregate data.
- `start_date`: The exclusive start of the range from which to query historical data,
expressed in seconds in Unix epoch time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetId"`: The ID of the asset, in UUID format.
- `"maxResults"`: The maximum number of results to return for each paginated request. A
result set is returned in the two cases, whichever occurs first. The size of the result
set is equal to 1 MB. The number of data points in the result set is equal to the value
of maxResults. The maximum value of maxResults is 2500.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"propertyAlias"`: The alias that identifies the property, such as an OPC-UA server data
stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
- `"propertyId"`: The ID of the asset property, in UUID format.
- `"qualities"`: The quality by which to filter asset data.
- `"timeOrdering"`: The chronological sorting order of the requested information. Default:
ASCENDING
"""
function get_asset_property_aggregates(
aggregateTypes,
endDate,
resolution,
startDate;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/properties/aggregates",
Dict{String,Any}(
"aggregateTypes" => aggregateTypes,
"endDate" => endDate,
"resolution" => resolution,
"startDate" => startDate,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_asset_property_aggregates(
aggregateTypes,
endDate,
resolution,
startDate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/properties/aggregates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"aggregateTypes" => aggregateTypes,
"endDate" => endDate,
"resolution" => resolution,
"startDate" => startDate,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset_property_value()
get_asset_property_value(params::Dict{String,<:Any})
Gets an asset property's current value. For more information, see Querying current values
in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the
following: The assetId and propertyId of an asset property. A propertyAlias, which is a
data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an
asset property's alias, see UpdateAssetProperty.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetId"`: The ID of the asset, in UUID format.
- `"propertyAlias"`: The alias that identifies the property, such as an OPC-UA server data
stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
- `"propertyId"`: The ID of the asset property, in UUID format.
"""
function get_asset_property_value(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/properties/latest"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_asset_property_value(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/properties/latest",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset_property_value_history()
get_asset_property_value_history(params::Dict{String,<:Any})
Gets the history of an asset property's values. For more information, see Querying
historical values in the IoT SiteWise User Guide. To identify an asset property, you must
specify one of the following: The assetId and propertyId of an asset property. A
propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see
UpdateAssetProperty.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetId"`: The ID of the asset, in UUID format.
- `"endDate"`: The inclusive end of the range from which to query historical data,
expressed in seconds in Unix epoch time.
- `"maxResults"`: The maximum number of results to return for each paginated request. A
result set is returned in the two cases, whichever occurs first. The size of the result
set is equal to 4 MB. The number of data points in the result set is equal to the value
of maxResults. The maximum value of maxResults is 20000.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"propertyAlias"`: The alias that identifies the property, such as an OPC-UA server data
stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
- `"propertyId"`: The ID of the asset property, in UUID format.
- `"qualities"`: The quality by which to filter asset data.
- `"startDate"`: The exclusive start of the range from which to query historical data,
expressed in seconds in Unix epoch time.
- `"timeOrdering"`: The chronological sorting order of the requested information. Default:
ASCENDING
"""
function get_asset_property_value_history(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET", "/properties/history"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_asset_property_value_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/properties/history",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_interpolated_asset_property_values(end_time_in_seconds, interval_in_seconds, quality, start_time_in_seconds, type)
get_interpolated_asset_property_values(end_time_in_seconds, interval_in_seconds, quality, start_time_in_seconds, type, params::Dict{String,<:Any})
Get interpolated values for an asset property for a specified time interval, during a
period of time. If your time series is missing data points during the specified time
interval, you can use interpolation to estimate the missing data. For example, you can use
this operation to return the interpolated temperature values for a wind turbine every 24
hours over a duration of 7 days. To identify an asset property, you must specify one of the
following: The assetId and propertyId of an asset property. A propertyAlias, which is a
data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an
asset property's alias, see UpdateAssetProperty.
# Arguments
- `end_time_in_seconds`: The inclusive end of the range from which to interpolate data,
expressed in seconds in Unix epoch time.
- `interval_in_seconds`: The time interval in seconds over which to interpolate data. Each
interval starts when the previous one ends.
- `quality`: The quality of the asset property value. You can use this parameter as a
filter to choose only the asset property values that have a specific quality.
- `start_time_in_seconds`: The exclusive start of the range from which to interpolate data,
expressed in seconds in Unix epoch time.
- `type`: The interpolation type. Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data using linear interpolation. For example,
you can use this operation to return the interpolated temperature values for a wind turbine
every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9
AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second
interpolated value on July 3, 2021, at 9 AM, and so on. LOCF_INTERPOLATION – Estimates
missing data using last observation carried forward interpolation If no data point is found
for an interval, IoT SiteWise returns the last observed data point for the previous
interval and carries forward this interpolated value until a new data point is found. For
example, you can get the state of an on-off valve every 24 hours over a duration of 7 days.
If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed
data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first
interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise
uses the same interpolated value for the rest of the days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetId"`: The ID of the asset, in UUID format.
- `"endTimeOffsetInNanos"`: The nanosecond offset converted from endTimeInSeconds.
- `"intervalWindowInSeconds"`: The query interval for the window, in seconds. IoT SiteWise
computes each interpolated value by using data points from the timestamp of each interval,
minus the window to the timestamp of each interval plus the window. If not specified, the
window ranges between the start time minus the interval and the end time plus the interval.
If you specify a value for the intervalWindowInSeconds parameter, the value for the type
parameter must be LINEAR_INTERPOLATION. If a data point isn't found during the specified
query window, IoT SiteWise won't return an interpolated value for the interval. This
indicates that there's a gap in the ingested data points. For example, you can get the
interpolated temperature values for a wind turbine every 24 hours over a duration of 7
days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT
SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours)
on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data
points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to
compute the second interpolated value, and so on.
- `"maxResults"`: The maximum number of results to return for each paginated request. If
not specified, the default value is 10.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"propertyAlias"`: The alias that identifies the property, such as an OPC-UA server data
stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
- `"propertyId"`: The ID of the asset property, in UUID format.
- `"startTimeOffsetInNanos"`: The nanosecond offset converted from startTimeInSeconds.
"""
function get_interpolated_asset_property_values(
endTimeInSeconds,
intervalInSeconds,
quality,
startTimeInSeconds,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/properties/interpolated",
Dict{String,Any}(
"endTimeInSeconds" => endTimeInSeconds,
"intervalInSeconds" => intervalInSeconds,
"quality" => quality,
"startTimeInSeconds" => startTimeInSeconds,
"type" => type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_interpolated_asset_property_values(
endTimeInSeconds,
intervalInSeconds,
quality,
startTimeInSeconds,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/properties/interpolated",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTimeInSeconds" => endTimeInSeconds,
"intervalInSeconds" => intervalInSeconds,
"quality" => quality,
"startTimeInSeconds" => startTimeInSeconds,
"type" => type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_policies()
list_access_policies(params::Dict{String,<:Any})
Retrieves a paginated list of access policies for an identity (an IAM Identity Center user,
an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal
or project).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"iamArn"`: The ARN of the IAM user. For more information, see IAM ARNs in the IAM User
Guide. This parameter is required if you specify IAM for identityType.
- `"identityId"`: The ID of the identity. This parameter is required if you specify USER or
GROUP for identityType.
- `"identityType"`: The type of identity (IAM Identity Center user, IAM Identity Center
group, or IAM user). This parameter is required if you specify identityId.
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"resourceId"`: The ID of the resource. This parameter is required if you specify
resourceType.
- `"resourceType"`: The type of resource (portal or project). This parameter is required if
you specify resourceId.
"""
function list_access_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/access-policies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_access_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/access-policies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_actions(target_resource_id, target_resource_type)
list_actions(target_resource_id, target_resource_type, params::Dict{String,<:Any})
Retrieves a paginated list of actions for a specific target resource.
# Arguments
- `target_resource_id`: The ID of the target resource.
- `target_resource_type`: The type of resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_actions(
targetResourceId, targetResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/actions",
Dict{String,Any}(
"targetResourceId" => targetResourceId,
"targetResourceType" => targetResourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_actions(
targetResourceId,
targetResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/actions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"targetResourceId" => targetResourceId,
"targetResourceType" => targetResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_model_composite_models(asset_model_id)
list_asset_model_composite_models(asset_model_id, params::Dict{String,<:Any})
Retrieves a paginated list of composite models associated with the asset model
# Arguments
- `asset_model_id`: The ID of the asset model. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_asset_model_composite_models(
assetModelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/composite-models";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_model_composite_models(
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/composite-models",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_model_properties(asset_model_id)
list_asset_model_properties(asset_model_id, params::Dict{String,<:Any})
Retrieves a paginated list of properties associated with an asset model. If you update
properties associated with the model before you finish listing all the properties, you need
to start all over again.
# Arguments
- `asset_model_id`: The ID of the asset model. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Filters the requested list of asset model properties. You can choose one of
the following options: ALL – The list includes all asset model properties for a given
asset model ID. BASE – The list includes only base asset model properties for a given
asset model ID. Default: BASE
- `"maxResults"`: The maximum number of results to return for each paginated request. If
not specified, the default value is 50.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_asset_model_properties(
assetModelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/properties";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_model_properties(
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/properties",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_models()
list_asset_models(params::Dict{String,<:Any})
Retrieves a paginated list of summaries of all asset models.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetModelTypes"`: The type of asset model. ASSET_MODEL – (default) An asset model
that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of
other asset models. You can't create assets directly from this type of asset model.
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_asset_models(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/asset-models"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_asset_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/asset-models",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_properties(asset_id)
list_asset_properties(asset_id, params::Dict{String,<:Any})
Retrieves a paginated list of properties associated with an asset. If you update properties
associated with the model before you finish listing all the properties, you need to start
all over again.
# Arguments
- `asset_id`: The ID of the asset. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see
Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Filters the requested list of asset properties. You can choose one of the
following options: ALL – The list includes all asset properties for a given asset
model ID. BASE – The list includes only base asset properties for a given asset model
ID. Default: BASE
- `"maxResults"`: The maximum number of results to return for each paginated request. If
not specified, the default value is 50.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_asset_properties(assetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/assets/$(assetId)/properties";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_properties(
assetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/assets/$(assetId)/properties",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_relationships(asset_id, traversal_type)
list_asset_relationships(asset_id, traversal_type, params::Dict{String,<:Any})
Retrieves a paginated list of asset relationships for an asset. You can use this operation
to identify an asset's root asset and all associated assets between that asset and its root.
# Arguments
- `asset_id`: The ID of the asset. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see
Referencing objects with external IDs in the IoT SiteWise User Guide.
- `traversal_type`: The type of traversal to use to identify asset relationships. Choose
the following option: PATH_TO_ROOT – Identify the asset's parent assets up to the root
asset. The asset that you specify in assetId is the first result in the list of
assetRelationshipSummaries, and the root asset is the last result.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_asset_relationships(
assetId, traversalType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/assets/$(assetId)/assetRelationships",
Dict{String,Any}("traversalType" => traversalType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_relationships(
assetId,
traversalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/assets/$(assetId)/assetRelationships",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("traversalType" => traversalType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assets()
list_assets(params::Dict{String,<:Any})
Retrieves a paginated list of asset summaries. You can use this operation to do the
following: List assets based on a specific asset model. List top-level assets. You
can't use this operation to list all assets. To retrieve summaries for all of your assets,
use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all
assets for each asset model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetModelId"`: The ID of the asset model by which to filter the list of assets. This
parameter is required if you choose ALL for filter. This can be either the actual ID in
UUID format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
- `"filter"`: The filter for the requested list of assets. Choose one of the following
options: ALL – The list includes all assets for a given asset model ID. The
assetModelId parameter is required if you filter by ALL. TOP_LEVEL – The list includes
only top-level assets in the asset hierarchy tree. Default: ALL
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_assets(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/assets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET", "/assets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_associated_assets(asset_id)
list_associated_assets(asset_id, params::Dict{String,<:Any})
Retrieves a paginated list of associated assets. You can use this operation to do the
following: List child assets associated to a parent asset by a hierarchy that you
specify. List an asset's parent asset.
# Arguments
- `asset_id`: The ID of the asset to query. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"hierarchyId"`: The ID of the hierarchy by which child assets are associated to the
asset. (This can be either the actual ID in UUID format, or else externalId: followed by
the external ID, if it has one. For more information, see Referencing objects with external
IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or
DescribeAssetModel operations. This parameter is required if you choose CHILD for
traversalDirection. For more information, see Asset hierarchies in the IoT SiteWise User
Guide.
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"traversalDirection"`: The direction to list associated assets. Choose one of the
following options: CHILD – The list includes all child assets associated to the asset.
The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes
the asset's parent asset. Default: CHILD
"""
function list_associated_assets(assetId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/assets/$(assetId)/hierarchies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associated_assets(
assetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/assets/$(assetId)/hierarchies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bulk_import_jobs()
list_bulk_import_jobs(params::Dict{String,<:Any})
Retrieves a paginated list of bulk import job requests. For more information, see List bulk
import jobs (CLI) in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: You can use a filter to select the bulk import jobs that you want to retrieve.
- `"maxResults"`: The maximum number of results to return for each paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_bulk_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_bulk_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET", "/jobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_composition_relationships(asset_model_id)
list_composition_relationships(asset_model_id, params::Dict{String,<:Any})
Retrieves a paginated list of composition relationships for an asset model of type
COMPONENT_MODEL.
# Arguments
- `asset_model_id`: The ID of the asset model. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_composition_relationships(
assetModelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/composition-relationships";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_composition_relationships(
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/asset-models/$(assetModelId)/composition-relationships",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dashboards(project_id)
list_dashboards(project_id, params::Dict{String,<:Any})
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
# Arguments
- `project_id`: The ID of the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_dashboards(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/dashboards",
Dict{String,Any}("projectId" => projectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dashboards(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/dashboards",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectId" => projectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_gateways()
list_gateways(params::Dict{String,<:Any})
Retrieves a paginated list of gateways.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/20200301/gateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/20200301/gateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_portals()
list_portals(params::Dict{String,<:Any})
Retrieves a paginated list of IoT SiteWise Monitor portals.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_portals(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/portals"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_portals(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET", "/portals", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_project_assets(project_id)
list_project_assets(project_id, params::Dict{String,<:Any})
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
# Arguments
- `project_id`: The ID of the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_project_assets(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/projects/$(projectId)/assets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_project_assets(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/projects/$(projectId)/assets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_projects(portal_id)
list_projects(portal_id, params::Dict{String,<:Any})
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
# Arguments
- `portal_id`: The ID of the portal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return for each paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_projects(portalId; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET",
"/projects",
Dict{String,Any}("portalId" => portalId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_projects(
portalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/projects",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("portalId" => portalId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the list of tags for an IoT SiteWise resource.
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/tags",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"GET",
"/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_time_series()
list_time_series(params::Dict{String,<:Any})
Retrieves a paginated list of time series (data streams).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"aliasPrefix"`: The alias prefix of the time series.
- `"assetId"`: The ID of the asset in which the asset property was created. This can be
either the actual ID in UUID format, or else externalId: followed by the external ID, if it
has one. For more information, see Referencing objects with external IDs in the IoT
SiteWise User Guide.
- `"maxResults"`: The maximum number of results to return for each paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"timeSeriesType"`: The type of the time series. The time series type can be one of the
following values: ASSOCIATED – The time series is associated with an asset property.
DISASSOCIATED – The time series isn't associated with any asset property.
"""
function list_time_series(; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"GET", "/timeseries/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_time_series(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"GET",
"/timeseries/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_default_encryption_configuration(encryption_type)
put_default_encryption_configuration(encryption_type, params::Dict{String,<:Any})
Sets the default encryption configuration for the Amazon Web Services account. For more
information, see Key management in the IoT SiteWise User Guide.
# Arguments
- `encryption_type`: The type of encryption used for the encryption configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"kmsKeyId"`: The Key ID of the customer managed key used for KMS encryption. This is
required if you use KMS_BASED_ENCRYPTION.
"""
function put_default_encryption_configuration(
encryptionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/configuration/account/encryption",
Dict{String,Any}("encryptionType" => encryptionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_default_encryption_configuration(
encryptionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/configuration/account/encryption",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("encryptionType" => encryptionType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_logging_options(logging_options)
put_logging_options(logging_options, params::Dict{String,<:Any})
Sets logging options for IoT SiteWise.
# Arguments
- `logging_options`: The logging options to set.
"""
function put_logging_options(
loggingOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"PUT",
"/logging",
Dict{String,Any}("loggingOptions" => loggingOptions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_logging_options(
loggingOptions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/logging",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("loggingOptions" => loggingOptions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_storage_configuration(storage_type)
put_storage_configuration(storage_type, params::Dict{String,<:Any})
Configures storage settings for IoT SiteWise.
# Arguments
- `storage_type`: The storage tier that you specified for your data. The storageType
parameter can be one of the following values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise
saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot
tier. The cold tier is a customer-managed Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"disassociatedDataStorage"`: Contains the storage configuration for time series (data
streams) that aren't associated with asset properties. The disassociatedDataStorage can be
one of the following values: ENABLED – IoT SiteWise accepts time series that aren't
associated with asset properties. After the disassociatedDataStorage is enabled, you can't
disable it. DISABLED – IoT SiteWise doesn't accept time series (data streams) that
aren't associated with asset properties. For more information, see Data streams in the
IoT SiteWise User Guide.
- `"multiLayerStorage"`: Identifies a storage destination. If you specified
MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.
- `"retentionPeriod"`:
- `"warmTier"`: A service managed storage tier optimized for analytical queries. It stores
periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob
API.
- `"warmTierRetentionPeriod"`: Set this period to specify how long your data is stored in
the warm tier before it is deleted. You can set this only if cold tier is enabled.
"""
function put_storage_configuration(
storageType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"POST",
"/configuration/account/storage",
Dict{String,Any}("storageType" => storageType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_storage_configuration(
storageType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/configuration/account/storage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("storageType" => storageType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this
operation updates the tag's value.
# Arguments
- `resource_arn`: The ARN of the resource to tag.
- `tags`: A list of key-value pairs that contain metadata for the resource. For more
information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"POST",
"/tags",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from an IoT SiteWise resource.
# Arguments
- `resource_arn`: The ARN of the resource to untag.
- `tag_keys`: A list of keys for tags to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"DELETE",
"/tags",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"DELETE",
"/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_access_policy(access_policy_id, access_policy_identity, access_policy_permission, access_policy_resource)
update_access_policy(access_policy_id, access_policy_identity, access_policy_permission, access_policy_resource, params::Dict{String,<:Any})
Updates an existing access policy that specifies an identity's access to an IoT SiteWise
Monitor portal or project resource.
# Arguments
- `access_policy_id`: The ID of the access policy.
- `access_policy_identity`: The identity for this access policy. Choose an IAM Identity
Center user, an IAM Identity Center group, or an IAM user.
- `access_policy_permission`: The permission level for this access policy. Note that a
project ADMINISTRATOR is also known as a project owner.
- `access_policy_resource`: The IoT SiteWise Monitor resource for this access policy.
Choose either a portal or a project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function update_access_policy(
accessPolicyId,
accessPolicyIdentity,
accessPolicyPermission,
accessPolicyResource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/access-policies/$(accessPolicyId)",
Dict{String,Any}(
"accessPolicyIdentity" => accessPolicyIdentity,
"accessPolicyPermission" => accessPolicyPermission,
"accessPolicyResource" => accessPolicyResource,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_policy(
accessPolicyId,
accessPolicyIdentity,
accessPolicyPermission,
accessPolicyResource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/access-policies/$(accessPolicyId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accessPolicyIdentity" => accessPolicyIdentity,
"accessPolicyPermission" => accessPolicyPermission,
"accessPolicyResource" => accessPolicyResource,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_asset(asset_id, asset_name)
update_asset(asset_id, asset_name, params::Dict{String,<:Any})
Updates an asset's name. For more information, see Updating assets and models in the IoT
SiteWise User Guide.
# Arguments
- `asset_id`: The ID of the asset to update. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
- `asset_name`: A friendly name for the asset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetDescription"`: A description for the asset.
- `"assetExternalId"`: An external ID to assign to the asset. The asset must not already
have an external ID. The external ID must be unique within your Amazon Web Services
account. For more information, see Using external IDs in the IoT SiteWise User Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function update_asset(assetId, assetName; aws_config::AbstractAWSConfig=global_aws_config())
return iotsitewise(
"PUT",
"/assets/$(assetId)",
Dict{String,Any}("assetName" => assetName, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_asset(
assetId,
assetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/assets/$(assetId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assetName" => assetName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_asset_model(asset_model_id, asset_model_name)
update_asset_model(asset_model_id, asset_model_name, params::Dict{String,<:Any})
Updates an asset model and all of the assets that were created from the model. Each asset
created from the model inherits the updated asset model's property and hierarchy
definitions. For more information, see Updating assets and models in the IoT SiteWise User
Guide. This operation overwrites the existing model with the provided model. To avoid
deleting your asset model's properties or hierarchies, you must include their IDs and
definitions in the updated asset model payload. For more information, see
DescribeAssetModel. If you remove a property from an asset model, IoT SiteWise deletes all
previous data for that property. If you remove a hierarchy definition from an asset model,
IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the
type or data type of an existing property.
# Arguments
- `asset_model_id`: The ID of the asset model to update. This can be either the actual ID
in UUID format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
- `asset_model_name`: A unique, friendly name for the asset model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetModelCompositeModels"`: The composite models that are part of this asset model. It
groups properties (such as attributes, measurements, transforms, and metrics) and child
composite models that model parts of your industrial equipment. Each composite model has a
type that defines the properties that the composite model supports. Use composite models to
define alarms on this asset model. When creating custom composite models, you need to use
CreateAssetModelCompositeModel. For more information, see <LINK>.
- `"assetModelDescription"`: A description for the asset model.
- `"assetModelExternalId"`: An external ID to assign to the asset model. The asset model
must not already have an external ID. The external ID must be unique within your Amazon Web
Services account. For more information, see Using external IDs in the IoT SiteWise User
Guide.
- `"assetModelHierarchies"`: The updated hierarchy definitions of the asset model. Each
hierarchy specifies an asset model whose assets can be children of any other assets created
from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User
Guide. You can specify up to 10 hierarchies per asset model. For more information, see
Quotas in the IoT SiteWise User Guide.
- `"assetModelProperties"`: The updated property definitions of the asset model. For more
information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200
properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function update_asset_model(
assetModelId, assetModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"PUT",
"/asset-models/$(assetModelId)",
Dict{String,Any}(
"assetModelName" => assetModelName, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_asset_model(
assetModelId,
assetModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/asset-models/$(assetModelId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assetModelName" => assetModelName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_asset_model_composite_model(asset_model_composite_model_id, asset_model_composite_model_name, asset_model_id)
update_asset_model_composite_model(asset_model_composite_model_id, asset_model_composite_model_name, asset_model_id, params::Dict{String,<:Any})
Updates a composite model and all of the assets that were created from the model. Each
asset created from the model inherits the updated asset model's property and hierarchy
definitions. For more information, see Updating assets and models in the IoT SiteWise User
Guide. If you remove a property from a composite asset model, IoT SiteWise deletes all
previous data for that property. You can’t change the type or data type of an existing
property. To replace an existing composite asset model property with a new one with the
same name, do the following: Submit an UpdateAssetModelCompositeModel request with the
entire existing property removed. Submit a second UpdateAssetModelCompositeModel request
that includes the new property. The new asset property will have the same name as the
previous one and IoT SiteWise will generate a new unique id.
# Arguments
- `asset_model_composite_model_id`: The ID of a composite model on this asset model.
- `asset_model_composite_model_name`: A unique, friendly name for the composite model.
- `asset_model_id`: The ID of the asset model, in UUID format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetModelCompositeModelDescription"`: A description for the composite model.
- `"assetModelCompositeModelExternalId"`: An external ID to assign to the asset model. You
can only set the external ID of the asset model if it wasn't set when it was created, or
you're setting it to the exact same thing as when it was created.
- `"assetModelCompositeModelProperties"`: The property definitions of the composite model.
For more information, see <LINK>. You can specify up to 200 properties per composite
model. For more information, see Quotas in the IoT SiteWise User Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
"""
function update_asset_model_composite_model(
assetModelCompositeModelId,
assetModelCompositeModelName,
assetModelId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/asset-models/$(assetModelId)/composite-models/$(assetModelCompositeModelId)",
Dict{String,Any}(
"assetModelCompositeModelName" => assetModelCompositeModelName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_asset_model_composite_model(
assetModelCompositeModelId,
assetModelCompositeModelName,
assetModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/asset-models/$(assetModelId)/composite-models/$(assetModelCompositeModelId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assetModelCompositeModelName" => assetModelCompositeModelName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_asset_property(asset_id, property_id)
update_asset_property(asset_id, property_id, params::Dict{String,<:Any})
Updates an asset property's alias and notification state. This operation overwrites the
property's existing alias and notification state. To keep your existing property's alias or
notification state, you must include the existing values in the UpdateAssetProperty
request. For more information, see DescribeAssetProperty.
# Arguments
- `asset_id`: The ID of the asset to be updated. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
- `property_id`: The ID of the asset property to be updated. This can be either the actual
ID in UUID format, or else externalId: followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"propertyAlias"`: The alias that identifies the property, such as an OPC-UA server data
stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. If
you omit this parameter, the alias is removed from the property.
- `"propertyNotificationState"`: The MQTT notification state (enabled or disabled) for this
asset property. When the notification state is enabled, IoT SiteWise publishes property
value updates to a unique MQTT topic. For more information, see Interacting with other
services in the IoT SiteWise User Guide. If you omit this parameter, the notification state
is set to DISABLED.
- `"propertyUnit"`: The unit of measure (such as Newtons or RPM) of the asset property. If
you don't specify a value for this parameter, the service uses the value of the
assetModelProperty in the asset model.
"""
function update_asset_property(
assetId, propertyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"PUT",
"/assets/$(assetId)/properties/$(propertyId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_asset_property(
assetId,
propertyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/assets/$(assetId)/properties/$(propertyId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dashboard(dashboard_definition, dashboard_id, dashboard_name)
update_dashboard(dashboard_definition, dashboard_id, dashboard_name, params::Dict{String,<:Any})
Updates an IoT SiteWise Monitor dashboard.
# Arguments
- `dashboard_definition`: The new dashboard definition, as specified in a JSON literal. For
detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
- `dashboard_id`: The ID of the dashboard to update.
- `dashboard_name`: A new friendly name for the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"dashboardDescription"`: A new description for the dashboard.
"""
function update_dashboard(
dashboardDefinition,
dashboardId,
dashboardName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/dashboards/$(dashboardId)",
Dict{String,Any}(
"dashboardDefinition" => dashboardDefinition,
"dashboardName" => dashboardName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dashboard(
dashboardDefinition,
dashboardId,
dashboardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/dashboards/$(dashboardId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dashboardDefinition" => dashboardDefinition,
"dashboardName" => dashboardName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_gateway(gateway_id, gateway_name)
update_gateway(gateway_id, gateway_name, params::Dict{String,<:Any})
Updates a gateway's name.
# Arguments
- `gateway_id`: The ID of the gateway to update.
- `gateway_name`: A unique, friendly name for the gateway.
"""
function update_gateway(
gatewayId, gatewayName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"PUT",
"/20200301/gateways/$(gatewayId)",
Dict{String,Any}("gatewayName" => gatewayName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_gateway(
gatewayId,
gatewayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/20200301/gateways/$(gatewayId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("gatewayName" => gatewayName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_gateway_capability_configuration(capability_configuration, capability_namespace, gateway_id)
update_gateway_capability_configuration(capability_configuration, capability_namespace, gateway_id, params::Dict{String,<:Any})
Updates a gateway capability configuration or defines a new capability configuration. Each
gateway capability defines data sources for a gateway. A capability configuration can
contain multiple data source configurations. If you define OPC-UA sources for a gateway in
the IoT SiteWise console, all of your OPC-UA sources are stored in one capability
configuration. To list all capability configurations for a gateway, use DescribeGateway.
# Arguments
- `capability_configuration`: The JSON document that defines the configuration for the
gateway capability. For more information, see Configuring data sources (CLI) in the IoT
SiteWise User Guide.
- `capability_namespace`: The namespace of the gateway capability configuration to be
updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your
OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where
version is a number such as 1.
- `gateway_id`: The ID of the gateway to be updated.
"""
function update_gateway_capability_configuration(
capabilityConfiguration,
capabilityNamespace,
gatewayId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/20200301/gateways/$(gatewayId)/capability",
Dict{String,Any}(
"capabilityConfiguration" => capabilityConfiguration,
"capabilityNamespace" => capabilityNamespace,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_gateway_capability_configuration(
capabilityConfiguration,
capabilityNamespace,
gatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"POST",
"/20200301/gateways/$(gatewayId)/capability",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"capabilityConfiguration" => capabilityConfiguration,
"capabilityNamespace" => capabilityNamespace,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_portal(portal_contact_email, portal_id, portal_name, role_arn)
update_portal(portal_contact_email, portal_id, portal_name, role_arn, params::Dict{String,<:Any})
Updates an IoT SiteWise Monitor portal.
# Arguments
- `portal_contact_email`: The Amazon Web Services administrator's contact email address.
- `portal_id`: The ID of the portal to update.
- `portal_name`: A new friendly name for the portal.
- `role_arn`: The ARN of a service role that allows the portal's users to access your IoT
SiteWise resources on your behalf. For more information, see Using service roles for IoT
SiteWise Monitor in the IoT SiteWise User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alarms"`: Contains the configuration information of an alarm created in an IoT SiteWise
Monitor portal. You can use the alarm to monitor an asset property and get notified when
the asset property value is outside a specified range. For more information, see Monitoring
with alarms in the IoT SiteWise Application Guide.
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"notificationSenderEmail"`: The email address that sends alarm notifications.
- `"portalDescription"`: A new description for the portal.
- `"portalLogoImage"`:
"""
function update_portal(
portalContactEmail,
portalId,
portalName,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/portals/$(portalId)",
Dict{String,Any}(
"portalContactEmail" => portalContactEmail,
"portalName" => portalName,
"roleArn" => roleArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_portal(
portalContactEmail,
portalId,
portalName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/portals/$(portalId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"portalContactEmail" => portalContactEmail,
"portalName" => portalName,
"roleArn" => roleArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(project_id, project_name)
update_project(project_id, project_name, params::Dict{String,<:Any})
Updates an IoT SiteWise Monitor project.
# Arguments
- `project_id`: The ID of the project to update.
- `project_name`: A new friendly name for the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new idempotent request is
required.
- `"projectDescription"`: A new description for the project.
"""
function update_project(
projectId, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotsitewise(
"PUT",
"/projects/$(projectId)",
Dict{String,Any}("projectName" => projectName, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
projectId,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotsitewise(
"PUT",
"/projects/$(projectId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"projectName" => projectName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 46659 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotthingsgraph
using AWS.Compat
using AWS.UUIDs
"""
associate_entity_to_thing(entity_id, thing_name)
associate_entity_to_thing(entity_id, thing_name, params::Dict{String,<:Any})
Associates a device with a concrete thing that is in the user's registry. A thing can be
associated with only one device at a time. If you associate a thing with a new device id,
its previous association will be removed.
# Arguments
- `entity_id`: The ID of the device to be associated with the thing. The ID should be in
the following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
- `thing_name`: The name of the thing to which the entity is to be associated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"namespaceVersion"`: The version of the user's namespace. Defaults to the latest version
of the user's namespace.
"""
function associate_entity_to_thing(
entityId, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"AssociateEntityToThing",
Dict{String,Any}("entityId" => entityId, "thingName" => thingName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_entity_to_thing(
entityId,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"AssociateEntityToThing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("entityId" => entityId, "thingName" => thingName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_flow_template(definition)
create_flow_template(definition, params::Dict{String,<:Any})
Creates a workflow template. Workflows can be created only in the user's namespace. (The
public namespace contains only entities.) The workflow can contain only entities in the
specified namespace. The workflow is validated against the entities in the latest version
of the user's namespace unless another namespace version is specified in the request.
# Arguments
- `definition`: The workflow DefinitionDocument.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compatibleNamespaceVersion"`: The namespace version in which the workflow is to be
created. If no value is specified, the latest version is used by default.
"""
function create_flow_template(definition; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"CreateFlowTemplate",
Dict{String,Any}("definition" => definition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_flow_template(
definition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"CreateFlowTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("definition" => definition), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_system_instance(definition, target)
create_system_instance(definition, target, params::Dict{String,<:Any})
Creates a system instance. This action validates the system instance, prepares the
deployment-related resources. For Greengrass deployments, it updates the Greengrass group
that is specified by the greengrassGroupName parameter. It also adds a file to the S3
bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after
running this action. For Greengrass deployments, since this action modifies and adds
resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling
identity must have write permissions to both the specified Greengrass group and S3 bucket.
Otherwise, the call will fail with an authorization error. For cloud deployments, this
action requires a flowActionsRoleArn value. This is an IAM role that has permissions to
access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.
If the definition document doesn't specify a version of the user's namespace, the latest
version will be used by default.
# Arguments
- `definition`:
- `target`: The target type of the deployment. Valid values are GREENGRASS and CLOUD.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"flowActionsRoleArn"`: The ARN of the IAM role that AWS IoT Things Graph will assume
when it executes the flow. This role must have read and write access to AWS Lambda and AWS
IoT and any other AWS services that the flow uses when it executes. This value is required
if the value of the target parameter is CLOUD.
- `"greengrassGroupName"`: The name of the Greengrass group where the system instance will
be deployed. This value is required if the value of the target parameter is GREENGRASS.
- `"metricsConfiguration"`:
- `"s3BucketName"`: The name of the Amazon Simple Storage Service bucket that will be used
to store and deploy the system instance's resource file. This value is required if the
value of the target parameter is GREENGRASS.
- `"tags"`: Metadata, consisting of key-value pairs, that can be used to categorize your
system instances.
"""
function create_system_instance(
definition, target; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"CreateSystemInstance",
Dict{String,Any}("definition" => definition, "target" => target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_system_instance(
definition,
target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"CreateSystemInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("definition" => definition, "target" => target),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_system_template(definition)
create_system_template(definition, params::Dict{String,<:Any})
Creates a system. The system is validated against the entities in the latest version of the
user's namespace unless another namespace version is specified in the request.
# Arguments
- `definition`: The DefinitionDocument used to create the system.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compatibleNamespaceVersion"`: The namespace version in which the system is to be
created. If no value is specified, the latest version is used by default.
"""
function create_system_template(
definition; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"CreateSystemTemplate",
Dict{String,Any}("definition" => definition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_system_template(
definition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"CreateSystemTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("definition" => definition), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_flow_template(id)
delete_flow_template(id, params::Dict{String,<:Any})
Deletes a workflow. Any new system or deployment that contains this workflow will fail to
update or deploy. Existing deployments that contain the workflow will continue to run
(since they use a snapshot of the workflow taken at the time of deployment).
# Arguments
- `id`: The ID of the workflow to be deleted. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
"""
function delete_flow_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeleteFlowTemplate",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_flow_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeleteFlowTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_namespace()
delete_namespace(params::Dict{String,<:Any})
Deletes the specified namespace. This action deletes all of the entities in the namespace.
Delete the systems and flows that use entities in the namespace before performing this
action. This action takes no request parameters.
"""
function delete_namespace(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeleteNamespace"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_namespace(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeleteNamespace", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_system_instance()
delete_system_instance(params::Dict{String,<:Any})
Deletes a system instance. Only system instances that have never been deployed, or that
have been undeployed can be deleted. Users can create a new system instance that has the
same ID as a deleted system instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"id"`: The ID of the system instance to be deleted.
"""
function delete_system_instance(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeleteSystemInstance"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_system_instance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeleteSystemInstance",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_system_template(id)
delete_system_template(id, params::Dict{String,<:Any})
Deletes a system. New deployments can't contain the system after its deletion. Existing
deployments that contain the system will continue to work because they use a snapshot of
the system that is taken when it is deployed.
# Arguments
- `id`: The ID of the system to be deleted. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
"""
function delete_system_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeleteSystemTemplate",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_system_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeleteSystemTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deploy_system_instance()
deploy_system_instance(params::Dict{String,<:Any})
Greengrass and Cloud Deployments Deploys the system instance to the target specified in
CreateSystemInstance. Greengrass Deployments If the system or any workflows and entities
have been updated before this action is called, then the deployment will create a new
Amazon Simple Storage Service resource file and then deploy it. Since this action creates a
Greengrass deployment on the caller's behalf, the calling identity must have write
permissions to the specified Greengrass group. Otherwise, the call will fail with an
authorization error. For information about the artifacts that get added to your Greengrass
core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"id"`: The ID of the system instance. This value is returned by the CreateSystemInstance
action. The ID should be in the following format. urn:tdm:REGION/ACCOUNT
ID/default:deployment:DEPLOYMENTNAME
"""
function deploy_system_instance(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeploySystemInstance"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function deploy_system_instance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeploySystemInstance",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprecate_flow_template(id)
deprecate_flow_template(id, params::Dict{String,<:Any})
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated
flows can't be deployed, but existing deployments will continue to run.
# Arguments
- `id`: The ID of the workflow to be deleted. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
"""
function deprecate_flow_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeprecateFlowTemplate",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprecate_flow_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeprecateFlowTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprecate_system_template(id)
deprecate_system_template(id, params::Dict{String,<:Any})
Deprecates the specified system.
# Arguments
- `id`: The ID of the system to delete. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
"""
function deprecate_system_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DeprecateSystemTemplate",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprecate_system_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DeprecateSystemTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_namespace()
describe_namespace(params::Dict{String,<:Any})
Gets the latest version of the user's namespace and the public version that it is tracking.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"namespaceName"`: The name of the user's namespace. Set this to aws to get the public
namespace.
"""
function describe_namespace(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"DescribeNamespace"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_namespace(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DescribeNamespace", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
dissociate_entity_from_thing(entity_type, thing_name)
dissociate_entity_from_thing(entity_type, thing_name, params::Dict{String,<:Any})
Dissociates a device entity from a concrete thing. The action takes only the type of the
entity that you need to dissociate because only one entity of a particular type can be
associated with a thing.
# Arguments
- `entity_type`: The entity type from which to disassociate the thing.
- `thing_name`: The name of the thing to disassociate.
"""
function dissociate_entity_from_thing(
entityType, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"DissociateEntityFromThing",
Dict{String,Any}("entityType" => entityType, "thingName" => thingName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function dissociate_entity_from_thing(
entityType,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"DissociateEntityFromThing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("entityType" => entityType, "thingName" => thingName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_entities(ids)
get_entities(ids, params::Dict{String,<:Any})
Gets definitions of the specified entities. Uses the latest version of the user's namespace
by default. This API returns the following TDM entities. Properties States Events
Actions Capabilities Mappings Devices Device Models Services This action
doesn't return definitions for systems, flows, and deployments.
# Arguments
- `ids`: An array of entity IDs. The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"namespaceVersion"`: The version of the user's namespace. Defaults to the latest version
of the user's namespace.
"""
function get_entities(ids; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetEntities",
Dict{String,Any}("ids" => ids);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_entities(
ids, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetEntities",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ids" => ids), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_flow_template(id)
get_flow_template(id, params::Dict{String,<:Any})
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified
workflow.
# Arguments
- `id`: The ID of the workflow. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"revisionNumber"`: The number of the workflow revision to retrieve.
"""
function get_flow_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetFlowTemplate",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_flow_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetFlowTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_flow_template_revisions(id)
get_flow_template_revisions(id, params::Dict{String,<:Any})
Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the
workflow has been deprecated, this action will return revisions that occurred before the
deprecation. This action won't work for workflows that have been deleted.
# Arguments
- `id`: The ID of the workflow. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function get_flow_template_revisions(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetFlowTemplateRevisions",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_flow_template_revisions(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetFlowTemplateRevisions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_namespace_deletion_status()
get_namespace_deletion_status(params::Dict{String,<:Any})
Gets the status of a namespace deletion task.
"""
function get_namespace_deletion_status(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetNamespaceDeletionStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_namespace_deletion_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetNamespaceDeletionStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_system_instance(id)
get_system_instance(id, params::Dict{String,<:Any})
Gets a system instance.
# Arguments
- `id`: The ID of the system deployment instance. This value is returned by
CreateSystemInstance. The ID should be in the following format. urn:tdm:REGION/ACCOUNT
ID/default:deployment:DEPLOYMENTNAME
"""
function get_system_instance(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetSystemInstance",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_system_instance(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetSystemInstance",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_system_template(id)
get_system_template(id, params::Dict{String,<:Any})
Gets a system.
# Arguments
- `id`: The ID of the system to get. This ID must be in the user's namespace. The ID should
be in the following format. urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"revisionNumber"`: The number that specifies the revision of the system to get.
"""
function get_system_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetSystemTemplate",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_system_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetSystemTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_system_template_revisions(id)
get_system_template_revisions(id, params::Dict{String,<:Any})
Gets revisions made to the specified system template. Only the previous 100 revisions are
stored. If the system has been deprecated, this action will return the revisions that
occurred before its deprecation. This action won't work with systems that have been deleted.
# Arguments
- `id`: The ID of the system template. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function get_system_template_revisions(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetSystemTemplateRevisions",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_system_template_revisions(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"GetSystemTemplateRevisions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_upload_status(upload_id)
get_upload_status(upload_id, params::Dict{String,<:Any})
Gets the status of the specified upload.
# Arguments
- `upload_id`: The ID of the upload. This value is returned by the UploadEntityDefinitions
action.
"""
function get_upload_status(uploadId; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"GetUploadStatus",
Dict{String,Any}("uploadId" => uploadId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_upload_status(
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"GetUploadStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("uploadId" => uploadId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_flow_execution_messages(flow_execution_id)
list_flow_execution_messages(flow_execution_id, params::Dict{String,<:Any})
Returns a list of objects that contain information about events in a flow execution.
# Arguments
- `flow_execution_id`: The ID of the flow execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function list_flow_execution_messages(
flowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"ListFlowExecutionMessages",
Dict{String,Any}("flowExecutionId" => flowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_flow_execution_messages(
flowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"ListFlowExecutionMessages",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("flowExecutionId" => flowExecutionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags on an AWS IoT Things Graph resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags are to be
returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of tags to return.
- `"nextToken"`: The token that specifies the next page of results to return.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"ListTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_entities(entity_types)
search_entities(entity_types, params::Dict{String,<:Any})
Searches for entities of the specified type. You can search for entities in your namespace
and the public namespace that you're tracking.
# Arguments
- `entity_types`: The entity types for which to search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that
are used by the entity in the result set. For example, you can filter on the ID of a
property that is used in a state. Multiple filters function as OR criteria in the query.
Multiple values passed inside the filter function as AND criteria.
- `"maxResults"`: The maximum number of results to return in the response.
- `"namespaceVersion"`: The version of the user's namespace. Defaults to the latest version
of the user's namespace.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function search_entities(entityTypes; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"SearchEntities",
Dict{String,Any}("entityTypes" => entityTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_entities(
entityTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"SearchEntities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("entityTypes" => entityTypes), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_flow_executions(system_instance_id)
search_flow_executions(system_instance_id, params::Dict{String,<:Any})
Searches for AWS IoT Things Graph workflow execution instances.
# Arguments
- `system_instance_id`: The ID of the system instance that contains the flow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The date and time of the latest flow execution to return.
- `"flowExecutionId"`: The ID of a flow execution.
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
- `"startTime"`: The date and time of the earliest flow execution to return.
"""
function search_flow_executions(
systemInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"SearchFlowExecutions",
Dict{String,Any}("systemInstanceId" => systemInstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_flow_executions(
systemInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"SearchFlowExecutions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("systemInstanceId" => systemInstanceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_flow_templates()
search_flow_templates(params::Dict{String,<:Any})
Searches for summary information about workflows.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An array of objects that limit the result set. The only valid filter is
DEVICE_MODEL_ID.
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function search_flow_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"SearchFlowTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_flow_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"SearchFlowTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_system_instances()
search_system_instances(params::Dict{String,<:Any})
Searches for system instances in the user's account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filter to apply to the search. Valid filters are
SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME. Multiple filters function as OR
criteria in the query. Multiple values passed inside the filter function as AND criteria.
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function search_system_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"SearchSystemInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_system_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"SearchSystemInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_system_templates()
search_system_templates(params::Dict{String,<:Any})
Searches for summary information about systems in the user's account. You can filter by the
ID of a workflow to return only systems that use the specified workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An array of filters that limit the result set. The only valid filter is
FLOW_TEMPLATE_ID.
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function search_system_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"SearchSystemTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_system_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"SearchSystemTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_things(entity_id)
search_things(entity_id, params::Dict{String,<:Any})
Searches for things associated with the specified entity. You can search by both device and
device model. For example, if two different devices, camera1 and camera2, implement the
camera device model, the user can associate thing1 to camera1 and thing2 to camera2.
SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both
thing1 and thing2. This action searches for exact matches and doesn't perform partial text
matching.
# Arguments
- `entity_id`: The ID of the entity to which the things are associated. The IDs should be
in the following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"namespaceVersion"`: The version of the user's namespace. Defaults to the latest version
of the user's namespace.
- `"nextToken"`: The string that specifies the next page of results. Use this when you're
paginating results.
"""
function search_things(entityId; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"SearchThings",
Dict{String,Any}("entityId" => entityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_things(
entityId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"SearchThings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("entityId" => entityId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Creates a tag for the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags are returned.
- `tags`: A list of tags to add to the resource.>
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
undeploy_system_instance()
undeploy_system_instance(params::Dict{String,<:Any})
Removes a system instance from its target (Cloud or Greengrass).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"id"`: The ID of the system instance to remove from its target.
"""
function undeploy_system_instance(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"UndeploySystemInstance"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function undeploy_system_instance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"UndeploySystemInstance",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags are to be
removed.
- `tag_keys`: A list of tag key names to remove from the resource. You don't specify the
value. Both the key and its associated value are removed. This parameter to the API
requires a JSON text string argument. For information on how to format a JSON parameter for
the various command line tool environments, see Using JSON for Parameters in the AWS CLI
User Guide.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flow_template(definition, id)
update_flow_template(definition, id, params::Dict{String,<:Any})
Updates the specified workflow. All deployed systems and system instances that use the
workflow will see the changes in the flow when it is redeployed. If you don't want this
behavior, copy the workflow (creating a new workflow with a different ID), and update the
copy. The workflow can contain only entities in the specified namespace.
# Arguments
- `definition`: The DefinitionDocument that contains the updated workflow definition.
- `id`: The ID of the workflow to be updated. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compatibleNamespaceVersion"`: The version of the user's namespace. If no value is
specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you
want to find earlier revisions of the flow to update.
"""
function update_flow_template(
definition, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"UpdateFlowTemplate",
Dict{String,Any}("definition" => definition, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flow_template(
definition,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"UpdateFlowTemplate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("definition" => definition, "id" => id), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_system_template(definition, id)
update_system_template(definition, id, params::Dict{String,<:Any})
Updates the specified system. You don't need to run this action after updating a workflow.
Any deployment that uses the system will see the changes in the system when it is
redeployed.
# Arguments
- `definition`: The DefinitionDocument that contains the updated system definition.
- `id`: The ID of the system to be updated. The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compatibleNamespaceVersion"`: The version of the user's namespace. Defaults to the
latest version of the user's namespace. If no value is specified, the latest version is
used by default.
"""
function update_system_template(
definition, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"UpdateSystemTemplate",
Dict{String,Any}("definition" => definition, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_system_template(
definition,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotthingsgraph(
"UpdateSystemTemplate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("definition" => definition, "id" => id), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_entity_definitions()
upload_entity_definitions(params::Dict{String,<:Any})
Asynchronously uploads one or more entity definitions to the user's namespace. The document
parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If
the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize
with the latest version of the public namespace. If deprecateExistingEntities is set to
true, all entities in the latest version will be deleted before the new DefinitionDocument
is uploaded. When a user uploads entity definitions for the first time, the service creates
a new namespace for the user. The new namespace tracks the public namespace. Currently
users can have only one namespace. The namespace version increments whenever a user uploads
entity definitions that are backwards-incompatible and whenever a user sets the
syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true. The
IDs for all of the entities should be in URN format. Each entity must be in the user's
namespace. Users can't create entities in the public namespace, but entity definitions can
refer to entities in the public namespace. Valid entities are Device, DeviceModel, Service,
Capability, State, Action, Event, Property, Mapping, Enum.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deprecateExistingEntities"`: A Boolean that specifies whether to deprecate all entities
in the latest version before uploading the new DefinitionDocument. If set to true, the
upload will create a new namespace version.
- `"document"`: The DefinitionDocument that defines the updated entities.
- `"syncWithPublicNamespace"`: A Boolean that specifies whether to synchronize with the
latest version of the public namespace. If set to true, the upload will create a new
namespace version.
"""
function upload_entity_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return iotthingsgraph(
"UploadEntityDefinitions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function upload_entity_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotthingsgraph(
"UploadEntityDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 50972 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iottwinmaker
using AWS.Compat
using AWS.UUIDs
"""
batch_put_property_values(entries, workspace_id)
batch_put_property_values(entries, workspace_id, params::Dict{String,<:Any})
Sets values for multiple time series properties.
# Arguments
- `entries`: An object that maps strings to the property value entries to set. Each string
in the mapping must be unique to this object.
- `workspace_id`: The ID of the workspace that contains the properties to set.
"""
function batch_put_property_values(
entries, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entity-properties",
Dict{String,Any}("entries" => entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_property_values(
entries,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entity-properties",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("entries" => entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_metadata_transfer_job(metadata_transfer_job_id)
cancel_metadata_transfer_job(metadata_transfer_job_id, params::Dict{String,<:Any})
Cancels the metadata transfer job.
# Arguments
- `metadata_transfer_job_id`: The metadata transfer job Id.
"""
function cancel_metadata_transfer_job(
metadataTransferJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"PUT",
"/metadata-transfer-jobs/$(metadataTransferJobId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_metadata_transfer_job(
metadataTransferJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"PUT",
"/metadata-transfer-jobs/$(metadataTransferJobId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_component_type(component_type_id, workspace_id)
create_component_type(component_type_id, workspace_id, params::Dict{String,<:Any})
Creates a component type.
# Arguments
- `component_type_id`: The ID of the component type.
- `workspace_id`: The ID of the workspace that contains the component type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentTypeName"`: A friendly name for the component type.
- `"compositeComponentTypes"`: This is an object that maps strings to
compositeComponentTypes of the componentType. CompositeComponentType is referenced by
componentTypeId.
- `"description"`: The description of the component type.
- `"extendsFrom"`: Specifies the parent component type to extend.
- `"functions"`: An object that maps strings to the functions in the component type. Each
string in the mapping must be unique to this object.
- `"isSingleton"`: A Boolean value that specifies whether an entity can have more than one
component of this type.
- `"propertyDefinitions"`: An object that maps strings to the property definitions in the
component type. Each string in the mapping must be unique to this object.
- `"propertyGroups"`:
- `"tags"`: Metadata that you can use to manage the component type.
"""
function create_component_type(
componentTypeId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_component_type(
componentTypeId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_entity(entity_name, workspace_id)
create_entity(entity_name, workspace_id, params::Dict{String,<:Any})
Creates an entity.
# Arguments
- `entity_name`: The name of the entity.
- `workspace_id`: The ID of the workspace that contains the entity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"components"`: An object that maps strings to the components in the entity. Each string
in the mapping must be unique to this object.
- `"compositeComponents"`: This is an object that maps strings to compositeComponent
updates in the request. Each key of the map represents the componentPath of the
compositeComponent.
- `"description"`: The description of the entity.
- `"entityId"`: The ID of the entity.
- `"parentEntityId"`: The ID of the entity's parent entity.
- `"tags"`: Metadata that you can use to manage the entity.
"""
function create_entity(
entityName, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entities",
Dict{String,Any}("entityName" => entityName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_entity(
entityName,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("entityName" => entityName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_metadata_transfer_job(destination, sources)
create_metadata_transfer_job(destination, sources, params::Dict{String,<:Any})
Creates a new metadata transfer job.
# Arguments
- `destination`: The metadata transfer job destination.
- `sources`: The metadata transfer job sources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The metadata transfer job description.
- `"metadataTransferJobId"`: The metadata transfer job Id.
"""
function create_metadata_transfer_job(
destination, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/metadata-transfer-jobs",
Dict{String,Any}("destination" => destination, "sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_metadata_transfer_job(
destination,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/metadata-transfer-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("destination" => destination, "sources" => sources),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_scene(content_location, scene_id, workspace_id)
create_scene(content_location, scene_id, workspace_id, params::Dict{String,<:Any})
Creates a scene.
# Arguments
- `content_location`: The relative path that specifies the location of the content
definition file.
- `scene_id`: The ID of the scene.
- `workspace_id`: The ID of the workspace that contains the scene.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capabilities"`: A list of capabilities that the scene uses to render itself.
- `"description"`: The description for this scene.
- `"sceneMetadata"`: The request metadata.
- `"tags"`: Metadata that you can use to manage the scene.
"""
function create_scene(
contentLocation, sceneId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/scenes",
Dict{String,Any}("contentLocation" => contentLocation, "sceneId" => sceneId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_scene(
contentLocation,
sceneId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/scenes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"contentLocation" => contentLocation, "sceneId" => sceneId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sync_job(sync_role, sync_source, workspace_id)
create_sync_job(sync_role, sync_source, workspace_id, params::Dict{String,<:Any})
This action creates a SyncJob.
# Arguments
- `sync_role`: The SyncJob IAM role. This IAM role is used by the SyncJob to read from the
syncSource, and create, update, or delete the corresponding resources.
- `sync_source`: The sync source. Currently the only supported syncSoource is SITEWISE .
- `workspace_id`: The workspace ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The SyncJob tags.
"""
function create_sync_job(
syncRole, syncSource, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/sync-jobs/$(syncSource)",
Dict{String,Any}("syncRole" => syncRole);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sync_job(
syncRole,
syncSource,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/sync-jobs/$(syncSource)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("syncRole" => syncRole), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workspace(workspace_id)
create_workspace(workspace_id, params::Dict{String,<:Any})
Creates a workplace.
# Arguments
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the workspace.
- `"role"`: The ARN of the execution role associated with the workspace.
- `"s3Location"`: The ARN of the S3 bucket where resources associated with the workspace
are stored.
- `"tags"`: Metadata that you can use to manage the workspace
"""
function create_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workspace(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_component_type(component_type_id, workspace_id)
delete_component_type(component_type_id, workspace_id, params::Dict{String,<:Any})
Deletes a component type.
# Arguments
- `component_type_id`: The ID of the component type to delete.
- `workspace_id`: The ID of the workspace that contains the component type.
"""
function delete_component_type(
componentTypeId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_component_type(
componentTypeId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_entity(entity_id, workspace_id)
delete_entity(entity_id, workspace_id, params::Dict{String,<:Any})
Deletes an entity.
# Arguments
- `entity_id`: The ID of the entity to delete.
- `workspace_id`: The ID of the workspace that contains the entity to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isRecursive"`: A Boolean value that specifies whether the operation deletes child
entities.
"""
function delete_entity(
entityId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/entities/$(entityId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_entity(
entityId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/entities/$(entityId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_scene(scene_id, workspace_id)
delete_scene(scene_id, workspace_id, params::Dict{String,<:Any})
Deletes a scene.
# Arguments
- `scene_id`: The ID of the scene to delete.
- `workspace_id`: The ID of the workspace.
"""
function delete_scene(
sceneId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/scenes/$(sceneId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_scene(
sceneId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/scenes/$(sceneId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sync_job(sync_source, workspace_id)
delete_sync_job(sync_source, workspace_id, params::Dict{String,<:Any})
Delete the SyncJob.
# Arguments
- `sync_source`: The sync source. Currently the only supported syncSource is SITEWISE .
- `workspace_id`: The workspace ID.
"""
function delete_sync_job(
syncSource, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/sync-jobs/$(syncSource)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sync_job(
syncSource,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)/sync-jobs/$(syncSource)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workspace(workspace_id)
delete_workspace(workspace_id, params::Dict{String,<:Any})
Deletes a workspace.
# Arguments
- `workspace_id`: The ID of the workspace to delete.
"""
function delete_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workspace(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"DELETE",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_query(query_statement, workspace_id)
execute_query(query_statement, workspace_id, params::Dict{String,<:Any})
Run queries to access information from your knowledge graph of entities within individual
workspaces. The ExecuteQuery action only works with Amazon Web Services Java SDK2.
ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.
# Arguments
- `query_statement`: The query statement.
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at one time. The default is 50.
- `"nextToken"`: The string that specifies the next page of results.
"""
function execute_query(
queryStatement, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/queries/execution",
Dict{String,Any}("queryStatement" => queryStatement, "workspaceId" => workspaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_query(
queryStatement,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/queries/execution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"queryStatement" => queryStatement, "workspaceId" => workspaceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_component_type(component_type_id, workspace_id)
get_component_type(component_type_id, workspace_id, params::Dict{String,<:Any})
Retrieves information about a component type.
# Arguments
- `component_type_id`: The ID of the component type.
- `workspace_id`: The ID of the workspace that contains the component type.
"""
function get_component_type(
componentTypeId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component_type(
componentTypeId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_entity(entity_id, workspace_id)
get_entity(entity_id, workspace_id, params::Dict{String,<:Any})
Retrieves information about an entity.
# Arguments
- `entity_id`: The ID of the entity.
- `workspace_id`: The ID of the workspace.
"""
function get_entity(
entityId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)/entities/$(entityId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_entity(
entityId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)/entities/$(entityId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_metadata_transfer_job(metadata_transfer_job_id)
get_metadata_transfer_job(metadata_transfer_job_id, params::Dict{String,<:Any})
Gets a nmetadata transfer job.
# Arguments
- `metadata_transfer_job_id`: The metadata transfer job Id.
"""
function get_metadata_transfer_job(
metadataTransferJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"GET",
"/metadata-transfer-jobs/$(metadataTransferJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_metadata_transfer_job(
metadataTransferJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"GET",
"/metadata-transfer-jobs/$(metadataTransferJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_pricing_plan()
get_pricing_plan(params::Dict{String,<:Any})
Gets the pricing plan.
"""
function get_pricing_plan(; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"GET", "/pricingplan"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_pricing_plan(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"GET",
"/pricingplan",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_property_value(selected_properties, workspace_id)
get_property_value(selected_properties, workspace_id, params::Dict{String,<:Any})
Gets the property values for a component, component type, entity, or workspace. You must
specify a value for either componentName, componentTypeId, entityId, or workspaceId.
# Arguments
- `selected_properties`: The properties whose values the operation returns.
- `workspace_id`: The ID of the workspace whose values the operation returns.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentName"`: The name of the component whose property values the operation returns.
- `"componentPath"`: This string specifies the path to the composite component, starting
from the top-level component.
- `"componentTypeId"`: The ID of the component type whose property values the operation
returns.
- `"entityId"`: The ID of the entity whose property values the operation returns.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- `"nextToken"`: The string that specifies the next page of results.
- `"propertyGroupName"`: The property group name.
- `"tabularConditions"`: The tabular conditions.
"""
function get_property_value(
selectedProperties, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entity-properties/value",
Dict{String,Any}("selectedProperties" => selectedProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_property_value(
selectedProperties,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entity-properties/value",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("selectedProperties" => selectedProperties), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_property_value_history(selected_properties, workspace_id)
get_property_value_history(selected_properties, workspace_id, params::Dict{String,<:Any})
Retrieves information about the history of a time series property value for a component,
component type, entity, or workspace. You must specify a value for workspaceId. For
entity-specific queries, specify values for componentName and entityId. For cross-entity
quries, specify a value for componentTypeId.
# Arguments
- `selected_properties`: A list of properties whose value histories the request retrieves.
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentName"`: The name of the component.
- `"componentPath"`: This string specifies the path to the composite component, starting
from the top-level component.
- `"componentTypeId"`: The ID of the component type.
- `"endDateTime"`: The date and time of the latest property value to return.
- `"endTime"`: The ISO8601 DateTime of the latest property value to return. For more
information about the ISO8601 DateTime format, see the data type PropertyValue.
- `"entityId"`: The ID of the entity.
- `"interpolation"`: An object that specifies the interpolation type and the interval over
which to interpolate data.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- `"nextToken"`: The string that specifies the next page of results.
- `"orderByTime"`: The time direction to use in the result order.
- `"propertyFilters"`: A list of objects that filter the property value history request.
- `"startDateTime"`: The date and time of the earliest property value to return.
- `"startTime"`: The ISO8601 DateTime of the earliest property value to return. For more
information about the ISO8601 DateTime format, see the data type PropertyValue.
"""
function get_property_value_history(
selectedProperties, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entity-properties/history",
Dict{String,Any}("selectedProperties" => selectedProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_property_value_history(
selectedProperties,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entity-properties/history",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("selectedProperties" => selectedProperties), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_scene(scene_id, workspace_id)
get_scene(scene_id, workspace_id, params::Dict{String,<:Any})
Retrieves information about a scene.
# Arguments
- `scene_id`: The ID of the scene.
- `workspace_id`: The ID of the workspace that contains the scene.
"""
function get_scene(sceneId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)/scenes/$(sceneId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_scene(
sceneId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)/scenes/$(sceneId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sync_job(sync_source)
get_sync_job(sync_source, params::Dict{String,<:Any})
Gets the SyncJob.
# Arguments
- `sync_source`: The sync source. Currently the only supported syncSource is SITEWISE .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"workspace"`: The workspace ID.
"""
function get_sync_job(syncSource; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"GET",
"/sync-jobs/$(syncSource)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sync_job(
syncSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"GET",
"/sync-jobs/$(syncSource)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workspace(workspace_id)
get_workspace(workspace_id, params::Dict{String,<:Any})
Retrieves information about a workspace.
# Arguments
- `workspace_id`: The ID of the workspace.
"""
function get_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workspace(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"GET",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_component_types(workspace_id)
list_component_types(workspace_id, params::Dict{String,<:Any})
Lists all component types in a workspace.
# Arguments
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A list of objects that filter the request.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_component_types(
workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/component-types-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_component_types(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/component-types-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_components(entity_id, workspace_id)
list_components(entity_id, workspace_id, params::Dict{String,<:Any})
This API lists the components of an entity.
# Arguments
- `entity_id`: The ID for the entity whose metadata (component/properties) is returned by
the operation.
- `workspace_id`: The workspace ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentPath"`: This string specifies the path to the composite component, starting
from the top-level component.
- `"maxResults"`: The maximum number of results returned at one time. The default is 25.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_components(
entityId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entities/$(entityId)/components-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_components(
entityId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entities/$(entityId)/components-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entities(workspace_id)
list_entities(workspace_id, params::Dict{String,<:Any})
Lists all entities in a workspace.
# Arguments
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A list of objects that filter the request. Only one object is accepted as a
valid input.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_entities(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entities-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_entities(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/entities-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_metadata_transfer_jobs(destination_type, source_type)
list_metadata_transfer_jobs(destination_type, source_type, params::Dict{String,<:Any})
Lists the metadata transfer jobs.
# Arguments
- `destination_type`: The metadata transfer job's destination type.
- `source_type`: The metadata transfer job's source type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An object that filters metadata transfer jobs.
- `"maxResults"`: The maximum number of results to return at one time.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_metadata_transfer_jobs(
destinationType, sourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/metadata-transfer-jobs-list",
Dict{String,Any}("destinationType" => destinationType, "sourceType" => sourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_metadata_transfer_jobs(
destinationType,
sourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/metadata-transfer-jobs-list",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationType" => destinationType, "sourceType" => sourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_properties(entity_id, workspace_id)
list_properties(entity_id, workspace_id, params::Dict{String,<:Any})
This API lists the properties of a component.
# Arguments
- `entity_id`: The ID for the entity whose metadata (component/properties) is returned by
the operation.
- `workspace_id`: The workspace ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentName"`: The name of the component whose properties are returned by the
operation.
- `"componentPath"`: This string specifies the path to the composite component, starting
from the top-level component.
- `"maxResults"`: The maximum number of results returned at one time. The default is 25.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_properties(
entityId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/properties-list",
Dict{String,Any}("entityId" => entityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_properties(
entityId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/properties-list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("entityId" => entityId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_scenes(workspace_id)
list_scenes(workspace_id, params::Dict{String,<:Any})
Lists all scenes in a workspace.
# Arguments
- `workspace_id`: The ID of the workspace that contains the scenes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the maximum number of results to display.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_scenes(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/scenes-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_scenes(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/scenes-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sync_jobs(workspace_id)
list_sync_jobs(workspace_id, params::Dict{String,<:Any})
List all SyncJobs.
# Arguments
- `workspace_id`: The ID of the workspace that contains the sync job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_sync_jobs(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/sync-jobs-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sync_jobs(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/sync-jobs-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sync_resources(sync_source, workspace_id)
list_sync_resources(sync_source, workspace_id, params::Dict{String,<:Any})
Lists the sync resources.
# Arguments
- `sync_source`: The sync source. Currently the only supported syncSource is SITEWISE .
- `workspace_id`: The ID of the workspace that contains the sync job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A list of objects that filter the request. The following filter combinations
are supported: Filter with state Filter with ResourceType and ResourceId Filter with
ResourceType and ExternalId
- `"maxResults"`: The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_sync_resources(
syncSource, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/sync-jobs/$(syncSource)/resources-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sync_resources(
syncSource,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/workspaces/$(workspaceId)/sync-jobs/$(syncSource)/resources-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags associated with a resource.
# Arguments
- `resource_arn`: The ARN of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_tags_for_resource(
resourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/tags-list",
Dict{String,Any}("resourceARN" => resourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/tags-list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceARN" => resourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workspaces()
list_workspaces(params::Dict{String,<:Any})
Retrieves information about workspaces in the current account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- `"nextToken"`: The string that specifies the next page of results.
"""
function list_workspaces(; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST", "/workspaces-list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workspaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"POST",
"/workspaces-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to a resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tags`: Metadata to add to this resource.
"""
function tag_resource(resourceARN, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST",
"/tags",
Dict{String,Any}("resourceARN" => resourceARN, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceARN,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceARN" => resourceARN, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tag_keys`: A list of tag key names to remove from the resource. You don't specify the
value. Both the key and its associated value are removed.
"""
function untag_resource(
resourceARN, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"DELETE",
"/tags",
Dict{String,Any}("resourceARN" => resourceARN, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceARN,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"DELETE",
"/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceARN" => resourceARN, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_component_type(component_type_id, workspace_id)
update_component_type(component_type_id, workspace_id, params::Dict{String,<:Any})
Updates information in a component type.
# Arguments
- `component_type_id`: The ID of the component type.
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentTypeName"`: The component type name.
- `"compositeComponentTypes"`: This is an object that maps strings to
compositeComponentTypes of the componentType. CompositeComponentType is referenced by
componentTypeId.
- `"description"`: The description of the component type.
- `"extendsFrom"`: Specifies the component type that this component type extends.
- `"functions"`: An object that maps strings to the functions in the component type. Each
string in the mapping must be unique to this object.
- `"isSingleton"`: A Boolean value that specifies whether an entity can have more than one
component of this type.
- `"propertyDefinitions"`: An object that maps strings to the property definitions in the
component type. Each string in the mapping must be unique to this object.
- `"propertyGroups"`: The property groups.
"""
function update_component_type(
componentTypeId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_component_type(
componentTypeId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)/component-types/$(componentTypeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_entity(entity_id, workspace_id)
update_entity(entity_id, workspace_id, params::Dict{String,<:Any})
Updates an entity.
# Arguments
- `entity_id`: The ID of the entity.
- `workspace_id`: The ID of the workspace that contains the entity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentUpdates"`: An object that maps strings to the component updates in the
request. Each string in the mapping must be unique to this object.
- `"compositeComponentUpdates"`: This is an object that maps strings to compositeComponent
updates in the request. Each key of the map represents the componentPath of the
compositeComponent.
- `"description"`: The description of the entity.
- `"entityName"`: The name of the entity.
- `"parentEntityUpdate"`: An object that describes the update request for a parent entity.
"""
function update_entity(
entityId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)/entities/$(entityId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_entity(
entityId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)/entities/$(entityId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pricing_plan(pricing_mode)
update_pricing_plan(pricing_mode, params::Dict{String,<:Any})
Update the pricing plan.
# Arguments
- `pricing_mode`: The pricing mode.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bundleNames"`: The bundle names.
"""
function update_pricing_plan(pricingMode; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"POST",
"/pricingplan",
Dict{String,Any}("pricingMode" => pricingMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pricing_plan(
pricingMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"POST",
"/pricingplan",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("pricingMode" => pricingMode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_scene(scene_id, workspace_id)
update_scene(scene_id, workspace_id, params::Dict{String,<:Any})
Updates a scene.
# Arguments
- `scene_id`: The ID of the scene.
- `workspace_id`: The ID of the workspace that contains the scene.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capabilities"`: A list of capabilities that the scene uses to render.
- `"contentLocation"`: The relative path that specifies the location of the content
definition file.
- `"description"`: The description of this scene.
- `"sceneMetadata"`: The scene metadata.
"""
function update_scene(
sceneId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)/scenes/$(sceneId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_scene(
sceneId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)/scenes/$(sceneId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workspace(workspace_id)
update_workspace(workspace_id, params::Dict{String,<:Any})
Updates a workspace.
# Arguments
- `workspace_id`: The ID of the workspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the workspace.
- `"role"`: The ARN of the execution role associated with the workspace.
- `"s3Location"`: The ARN of the S3 bucket where resources associated with the workspace
are stored.
"""
function update_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workspace(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iottwinmaker(
"PUT",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 45864 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ivs
using AWS.Compat
using AWS.UUIDs
"""
batch_get_channel(arns)
batch_get_channel(arns, params::Dict{String,<:Any})
Performs GetChannel on multiple ARNs simultaneously.
# Arguments
- `arns`: Array of ARNs, one per channel.
"""
function batch_get_channel(arns; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/BatchGetChannel",
Dict{String,Any}("arns" => arns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_channel(
arns, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/BatchGetChannel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arns" => arns), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_stream_key(arns)
batch_get_stream_key(arns, params::Dict{String,<:Any})
Performs GetStreamKey on multiple ARNs simultaneously.
# Arguments
- `arns`: Array of ARNs, one per stream key.
"""
function batch_get_stream_key(arns; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/BatchGetStreamKey",
Dict{String,Any}("arns" => arns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_stream_key(
arns, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/BatchGetStreamKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arns" => arns), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_start_viewer_session_revocation(viewer_sessions)
batch_start_viewer_session_revocation(viewer_sessions, params::Dict{String,<:Any})
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs
simultaneously.
# Arguments
- `viewer_sessions`: Array of viewer sessions, one per channel-ARN and viewer-ID pair.
"""
function batch_start_viewer_session_revocation(
viewerSessions; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/BatchStartViewerSessionRevocation",
Dict{String,Any}("viewerSessions" => viewerSessions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_start_viewer_session_revocation(
viewerSessions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/BatchStartViewerSessionRevocation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("viewerSessions" => viewerSessions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel()
create_channel(params::Dict{String,<:Any})
Creates a new channel and an associated stream key to start streaming.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorized"`: Whether the channel is private (enabled for playback authorization).
Default: false.
- `"insecureIngest"`: Whether the channel allows insecure RTMP and SRT ingest. Default:
false.
- `"latencyMode"`: Channel latency mode. Use NORMAL to broadcast and deliver live video up
to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
- `"name"`: Channel name.
- `"playbackRestrictionPolicyArn"`: Playback-restriction-policy ARN. A valid ARN value here
both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no
playback restriction policy is applied).
- `"preset"`: Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is
HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the
empty string (\"\").
- `"recordingConfigurationArn"`: Recording-configuration ARN. A valid ARN value here both
specifies the ARN and enables recording. Default: \"\" (empty string, recording is
disabled).
- `"tags"`: Array of 1-50 maps, each of the form string:string (key:value). See Tagging
Amazon Web Services Resources for more information, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific
constraints beyond what is documented there.
- `"type"`: Channel type, which determines the allowable resolution and bitrate. If you
exceed the allowable input resolution or bitrate, the stream probably will disconnect
immediately. Default: STANDARD. For details, see Channel Types.
"""
function create_channel(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST", "/CreateChannel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_channel(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/CreateChannel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_playback_restriction_policy()
create_playback_restriction_policy(params::Dict{String,<:Any})
Creates a new playback restriction policy, for constraining playback by countries and/or
origins.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"allowedCountries"`: A list of country codes that control geoblocking restriction.
Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries
(an empty array).
- `"allowedOrigins"`: A list of origin sites that control CORS restriction. Allowed values
are the same as valid values of the Origin header defined at
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
empty array).
- `"enableStrictOriginEnforcement"`: Whether channel playback is constrained by origin
site. Default: false.
- `"name"`: Playback-restriction-policy name. The value does not need to be unique.
- `"tags"`: Array of 1-50 maps, each of the form string:string (key:value). See Tagging
Amazon Web Services Resources for more information, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific
constraints beyond what is documented there.
"""
function create_playback_restriction_policy(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/CreatePlaybackRestrictionPolicy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_playback_restriction_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/CreatePlaybackRestrictionPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recording_configuration(destination_configuration)
create_recording_configuration(destination_configuration, params::Dict{String,<:Any})
Creates a new recording configuration, used to enable recording to Amazon S3. Known issue:
In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording
configuration, it returns success even if the S3 bucket is in a different region. In this
case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In
other regions, the CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording
configuration. If you create a recording configuration in a different region as your S3
bucket, delete that recording configuration and create a new one with an S3 bucket from the
correct region.
# Arguments
- `destination_configuration`: A complex type that contains a destination configuration for
where recorded video will be stored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Recording-configuration name. The value does not need to be unique.
- `"recordingReconnectWindowSeconds"`: If a broadcast disconnects and then reconnects
within the specified interval, the multiple streams will be considered a single broadcast
and merged together. Default: 0.
- `"renditionConfiguration"`: Object that describes which renditions should be recorded for
a stream.
- `"tags"`: Array of 1-50 maps, each of the form string:string (key:value). See Tagging
Amazon Web Services Resources for more information, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific
constraints beyond what is documented there.
- `"thumbnailConfiguration"`: A complex type that allows you to enable/disable the
recording of thumbnails for a live session and modify the interval at which thumbnails are
generated for the live session.
"""
function create_recording_configuration(
destinationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/CreateRecordingConfiguration",
Dict{String,Any}("destinationConfiguration" => destinationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recording_configuration(
destinationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/CreateRecordingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("destinationConfiguration" => destinationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stream_key(channel_arn)
create_stream_key(channel_arn, params::Dict{String,<:Any})
Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that
CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same
channel, it will fail because a stream key already exists and there is a limit of 1 stream
key per channel. To reset the stream key on a channel, use DeleteStreamKey and then
CreateStreamKey.
# Arguments
- `channel_arn`: ARN of the channel for which to create the stream key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Array of 1-50 maps, each of the form string:string (key:value). See Tagging
Amazon Web Services Resources for more information, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific
constraints beyond what is documented there.
"""
function create_stream_key(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/CreateStreamKey",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_stream_key(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/CreateStreamKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel(arn)
delete_channel(arn, params::Dict{String,<:Any})
Deletes the specified channel and its associated stream keys. If you try to delete a live
channel, you will get an error (409 ConflictException). To delete a channel that is live,
call StopStream, wait for the Amazon EventBridge \"Stream End\" event (to verify that the
stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with
Amazon IVS.)
# Arguments
- `arn`: ARN of the channel to be deleted.
"""
function delete_channel(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/DeleteChannel",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeleteChannel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_playback_key_pair(arn)
delete_playback_key_pair(arn, params::Dict{String,<:Any})
Deletes a specified authorization key pair. This invalidates future viewer tokens generated
using the key pair’s privateKey. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
# Arguments
- `arn`: ARN of the key pair to be deleted.
"""
function delete_playback_key_pair(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/DeletePlaybackKeyPair",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_playback_key_pair(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeletePlaybackKeyPair",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_playback_restriction_policy(arn)
delete_playback_restriction_policy(arn, params::Dict{String,<:Any})
Deletes the specified playback restriction policy.
# Arguments
- `arn`: ARN of the playback restriction policy to be deleted.
"""
function delete_playback_restriction_policy(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeletePlaybackRestrictionPolicy",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_playback_restriction_policy(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeletePlaybackRestrictionPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recording_configuration(arn)
delete_recording_configuration(arn, params::Dict{String,<:Any})
Deletes the recording configuration for the specified ARN. If you try to delete a recording
configuration that is associated with a channel, you will get an error (409
ConflictException). To avoid this, for all channels that reference the recording
configuration, first use UpdateChannel to set the recordingConfigurationArn field to an
empty string, then use DeleteRecordingConfiguration.
# Arguments
- `arn`: ARN of the recording configuration to be deleted.
"""
function delete_recording_configuration(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeleteRecordingConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recording_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeleteRecordingConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stream_key(arn)
delete_stream_key(arn, params::Dict{String,<:Any})
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
# Arguments
- `arn`: ARN of the stream key to be deleted.
"""
function delete_stream_key(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/DeleteStreamKey",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stream_key(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/DeleteStreamKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channel(arn)
get_channel(arn, params::Dict{String,<:Any})
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
# Arguments
- `arn`: ARN of the channel for which the configuration is to be retrieved.
"""
function get_channel(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/GetChannel",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channel(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/GetChannel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_playback_key_pair(arn)
get_playback_key_pair(arn, params::Dict{String,<:Any})
Gets a specified playback authorization key pair and returns the arn and fingerprint. The
privateKey held by the caller can be used to generate viewer authorization tokens, to grant
viewers access to private channels. For more information, see Setting Up Private Channels
in the Amazon IVS User Guide.
# Arguments
- `arn`: ARN of the key pair to be returned.
"""
function get_playback_key_pair(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/GetPlaybackKeyPair",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_playback_key_pair(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/GetPlaybackKeyPair",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_playback_restriction_policy(arn)
get_playback_restriction_policy(arn, params::Dict{String,<:Any})
Gets the specified playback restriction policy.
# Arguments
- `arn`: ARN of the playback restriction policy to be returned.
"""
function get_playback_restriction_policy(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/GetPlaybackRestrictionPolicy",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_playback_restriction_policy(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/GetPlaybackRestrictionPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recording_configuration(arn)
get_recording_configuration(arn, params::Dict{String,<:Any})
Gets the recording configuration for the specified ARN.
# Arguments
- `arn`: ARN of the recording configuration to be retrieved.
"""
function get_recording_configuration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/GetRecordingConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recording_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/GetRecordingConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_stream(channel_arn)
get_stream(channel_arn, params::Dict{String,<:Any})
Gets information about the active (live) stream on a specified channel.
# Arguments
- `channel_arn`: Channel ARN for stream to be accessed.
"""
function get_stream(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/GetStream",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_stream(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/GetStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_stream_key(arn)
get_stream_key(arn, params::Dict{String,<:Any})
Gets stream-key information for a specified ARN.
# Arguments
- `arn`: ARN for the stream key to be retrieved.
"""
function get_stream_key(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/GetStreamKey",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_stream_key(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/GetStreamKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_stream_session(channel_arn)
get_stream_session(channel_arn, params::Dict{String,<:Any})
Gets metadata on a specified stream.
# Arguments
- `channel_arn`: ARN of the channel resource
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"streamId"`: Unique identifier for a live or previously live stream in the specified
channel. If no streamId is provided, this returns the most recent stream session for the
channel, if it exists.
"""
function get_stream_session(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/GetStreamSession",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_stream_session(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/GetStreamSession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_playback_key_pair(public_key_material)
import_playback_key_pair(public_key_material, params::Dict{String,<:Any})
Imports the public portion of a new key pair and returns its arn and fingerprint. The
privateKey can then be used to generate viewer authorization tokens, to grant viewers
access to private channels. For more information, see Setting Up Private Channels in the
Amazon IVS User Guide.
# Arguments
- `public_key_material`: The public portion of a customer-generated key pair.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Playback-key-pair name. The value does not need to be unique.
- `"tags"`: Any tags provided with the request are added to the playback key pair tags. See
Tagging Amazon Web Services Resources for more information, including restrictions that
apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no
service-specific constraints beyond what is documented there.
"""
function import_playback_key_pair(
publicKeyMaterial; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ImportPlaybackKeyPair",
Dict{String,Any}("publicKeyMaterial" => publicKeyMaterial);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_playback_key_pair(
publicKeyMaterial,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/ImportPlaybackKeyPair",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("publicKeyMaterial" => publicKeyMaterial), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channels()
list_channels(params::Dict{String,<:Any})
Gets summary information about all channels in your account, in the Amazon Web Services
region where the API request is processed. This list can be filtered to match a specified
name or recording-configuration ARN. Filters are mutually exclusive and cannot be used
together. If you try to use both filters, you will get an error (409 ConflictException).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterByName"`: Filters the channel list to match the specified name.
- `"filterByPlaybackRestrictionPolicyArn"`: Filters the channel list to match the specified
policy.
- `"filterByRecordingConfigurationArn"`: Filters the channel list to match the specified
recording-configuration ARN.
- `"maxResults"`: Maximum number of channels to return. Default: 100.
- `"nextToken"`: The first channel to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST", "/ListChannels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ListChannels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_playback_key_pairs()
list_playback_key_pairs(params::Dict{String,<:Any})
Gets summary information about playback key pairs. For more information, see Setting Up
Private Channels in the Amazon IVS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of key pairs to return. Default: your service quota or
100, whichever is smaller.
- `"nextToken"`: The first key pair to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_playback_key_pairs(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/ListPlaybackKeyPairs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_playback_key_pairs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ListPlaybackKeyPairs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_playback_restriction_policies()
list_playback_restriction_policies(params::Dict{String,<:Any})
Gets summary information about playback restriction policies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of policies to return. Default: 1.
- `"nextToken"`: The first policy to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_playback_restriction_policies(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ListPlaybackRestrictionPolicies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_playback_restriction_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ListPlaybackRestrictionPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recording_configurations()
list_recording_configurations(params::Dict{String,<:Any})
Gets summary information about all recording configurations in your account, in the Amazon
Web Services region where the API request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of recording configurations to return. Default: your
service quota or 100, whichever is smaller.
- `"nextToken"`: The first recording configuration to retrieve. This is used for
pagination; see the nextToken response field.
"""
function list_recording_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/ListRecordingConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recording_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ListRecordingConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stream_keys(channel_arn)
list_stream_keys(channel_arn, params::Dict{String,<:Any})
Gets summary information about stream keys for the specified channel.
# Arguments
- `channel_arn`: Channel ARN used to filter the list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of streamKeys to return. Default: 1.
- `"nextToken"`: The first stream key to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_stream_keys(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/ListStreamKeys",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_stream_keys(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/ListStreamKeys",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stream_sessions(channel_arn)
list_stream_sessions(channel_arn, params::Dict{String,<:Any})
Gets a summary of current and previous streams for a specified channel in your account, in
the AWS region where the API request is processed.
# Arguments
- `channel_arn`: Channel ARN used to filter the list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of streams to return. Default: 100.
- `"nextToken"`: The first stream to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_stream_sessions(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/ListStreamSessions",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_stream_sessions(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/ListStreamSessions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streams()
list_streams(params::Dict{String,<:Any})
Gets summary information about live streams in your account, in the Amazon Web Services
region where the API request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterBy"`: Filters the stream list to match the specified criterion.
- `"maxResults"`: Maximum number of streams to return. Default: 100.
- `"nextToken"`: The first stream to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST", "/ListStreams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/ListStreams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets information about Amazon Web Services tags for the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be retrieved. The ARN must be URL-encoded.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_metadata(channel_arn, metadata)
put_metadata(channel_arn, metadata, params::Dict{String,<:Any})
Inserts metadata into the active stream of the specified channel. At most 5 requests per
second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not
sufficient for your needs, we recommend batching your data into a single PutMetadata call.)
At most 155 requests per second per account are allowed. Also see Embedding Metadata within
a Video Stream in the Amazon IVS User Guide.
# Arguments
- `channel_arn`: ARN of the channel into which metadata is inserted. This channel must have
an active stream.
- `metadata`: Metadata to insert into the stream. Maximum: 1 KB per request.
"""
function put_metadata(
channelArn, metadata; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/PutMetadata",
Dict{String,Any}("channelArn" => channelArn, "metadata" => metadata);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_metadata(
channelArn,
metadata,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/PutMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("channelArn" => channelArn, "metadata" => metadata),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_viewer_session_revocation(channel_arn, viewer_id)
start_viewer_session_revocation(channel_arn, viewer_id, params::Dict{String,<:Any})
Starts the process of revoking the viewer session associated with a specified channel ARN
and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than
and including that version. For instructions on associating a viewer ID with a viewer
session, see Setting Up Private Channels.
# Arguments
- `channel_arn`: The ARN of the channel associated with the viewer session to revoke.
- `viewer_id`: The ID of the viewer associated with the viewer session to revoke. Do not
use this field for personally identifying, confidential, or sensitive information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"viewerSessionVersionsLessThanOrEqualTo"`: An optional filter on which versions of the
viewer session to revoke. All versions less than or equal to the specified version will be
revoked. Default: 0.
"""
function start_viewer_session_revocation(
channelArn, viewerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/StartViewerSessionRevocation",
Dict{String,Any}("channelArn" => channelArn, "viewerId" => viewerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_viewer_session_revocation(
channelArn,
viewerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/StartViewerSessionRevocation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("channelArn" => channelArn, "viewerId" => viewerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_stream(channel_arn)
stop_stream(channel_arn, params::Dict{String,<:Any})
Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction
with DeleteStreamKey to prevent further streaming to a channel. Many streaming
client-software libraries automatically reconnect a dropped RTMPS session, so to stop the
stream permanently, you may want to first revoke the streamKey attached to the channel.
# Arguments
- `channel_arn`: ARN of the channel for which the stream is to be stopped.
"""
function stop_stream(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/StopStream",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_stream(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/StopStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
# Arguments
- `resource_arn`: ARN of the resource for which tags are to be added or updated. The ARN
must be URL-encoded.
- `tags`: Array of tags to be added or updated. Array of maps, each of the form
string:string (key:value). See Tagging Amazon Web Services Resources for more information,
including restrictions that apply to tags and \"Tag naming limits and requirements\";
Amazon IVS has no service-specific constraints beyond what is documented there.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the resource with the specified ARN.
# Arguments
- `resource_arn`: ARN of the resource for which tags are to be removed. The ARN must be
URL-encoded.
- `tag_keys`: Array of tags to be removed. Array of maps, each of the form string:string
(key:value). See Tagging Amazon Web Services Resources for more information, including
restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has
no service-specific constraints beyond what is documented there.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel(arn)
update_channel(arn, params::Dict{String,<:Any})
Updates a channel's configuration. Live channels cannot be updated. You must stop the
ongoing stream, update the channel, and restart the stream for the changes to take effect.
# Arguments
- `arn`: ARN of the channel to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorized"`: Whether the channel is private (enabled for playback authorization).
- `"insecureIngest"`: Whether the channel allows insecure RTMP and SRT ingest. Default:
false.
- `"latencyMode"`: Channel latency mode. Use NORMAL to broadcast and deliver live video up
to Full HD. Use LOW for near-real-time interaction with viewers.
- `"name"`: Channel name.
- `"playbackRestrictionPolicyArn"`: Playback-restriction-policy ARN. A valid ARN value here
both specifies the ARN and enables playback restriction. If this is set to an empty string,
playback restriction policy is disabled.
- `"preset"`: Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is
HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the
empty string (\"\").
- `"recordingConfigurationArn"`: Recording-configuration ARN. A valid ARN value here both
specifies the ARN and enables recording. If this is set to an empty string, recording is
disabled.
- `"type"`: Channel type, which determines the allowable resolution and bitrate. If you
exceed the allowable input resolution or bitrate, the stream probably will disconnect
immediately. Default: STANDARD. For details, see Channel Types.
"""
function update_channel(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs(
"POST",
"/UpdateChannel",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/UpdateChannel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_playback_restriction_policy(arn)
update_playback_restriction_policy(arn, params::Dict{String,<:Any})
Updates a specified playback restriction policy.
# Arguments
- `arn`: ARN of the playback-restriction-policy to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"allowedCountries"`: A list of country codes that control geoblocking restriction.
Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries
(an empty array).
- `"allowedOrigins"`: A list of origin sites that control CORS restriction. Allowed values
are the same as valid values of the Origin header defined at
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
empty array).
- `"enableStrictOriginEnforcement"`: Whether channel playback is constrained by origin
site. Default: false.
- `"name"`: Playback-restriction-policy name. The value does not need to be unique.
"""
function update_playback_restriction_policy(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/UpdatePlaybackRestrictionPolicy",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_playback_restriction_policy(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs(
"POST",
"/UpdatePlaybackRestrictionPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 34800 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ivs_realtime
using AWS.Compat
using AWS.UUIDs
"""
create_encoder_configuration()
create_encoder_configuration(params::Dict{String,<:Any})
Creates an EncoderConfiguration object.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Optional name to identify the resource.
- `"tags"`: Tags attached to the resource. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags
beyond what is documented there.
- `"video"`: Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
fps.
"""
function create_encoder_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/CreateEncoderConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_encoder_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/CreateEncoderConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_participant_token(stage_arn)
create_participant_token(stage_arn, params::Dict{String,<:Any})
Creates an additional token for a specified stage. This can be done after stage creation or
when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
# Arguments
- `stage_arn`: ARN of the stage to which this token is scoped.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: Application-provided attributes to encode into the token and attach to a
stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field
is 1 KB total. This field is exposed to all stage participants and should not be used for
personally identifying, confidential, or sensitive information.
- `"capabilities"`: Set of capabilities that the user is allowed to perform in the stage.
Default: PUBLISH, SUBSCRIBE.
- `"duration"`: Duration (in minutes), after which the token expires. Default: 720 (12
hours).
- `"userId"`: Name that can be specified to help identify the token. This can be any UTF-8
encoded text. This field is exposed to all stage participants and should not be used for
personally identifying, confidential, or sensitive information.
"""
function create_participant_token(
stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/CreateParticipantToken",
Dict{String,Any}("stageArn" => stageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_participant_token(
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/CreateParticipantToken",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("stageArn" => stageArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stage()
create_stage(params::Dict{String,<:Any})
Creates a new stage (and optionally participant tokens).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoParticipantRecordingConfiguration"`: Auto participant recording configuration
object attached to the stage.
- `"name"`: Optional name that can be specified for the stage being created.
- `"participantTokenConfigurations"`: Array of participant token configuration objects to
attach to the new stage.
- `"tags"`: Tags attached to the resource. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags
beyond what is documented there.
"""
function create_stage(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST", "/CreateStage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_stage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/CreateStage",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_storage_configuration(s3)
create_storage_configuration(s3, params::Dict{String,<:Any})
Creates a new storage configuration, used to enable recording to Amazon S3. When a
StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided
bucket. This will ensure that IVS has sufficient permissions to write content to the
provided bucket.
# Arguments
- `s3`: A complex type that contains a storage configuration for where recorded video will
be stored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Storage configuration name. The value does not need to be unique.
- `"tags"`: Tags attached to the resource. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags
beyond what is documented there.
"""
function create_storage_configuration(s3; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/CreateStorageConfiguration",
Dict{String,Any}("s3" => s3);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_storage_configuration(
s3, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/CreateStorageConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("s3" => s3), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_encoder_configuration(arn)
delete_encoder_configuration(arn, params::Dict{String,<:Any})
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this
template; otherwise, returns an error.
# Arguments
- `arn`: ARN of the EncoderConfiguration.
"""
function delete_encoder_configuration(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/DeleteEncoderConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_encoder_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/DeleteEncoderConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stage(arn)
delete_stage(arn, params::Dict{String,<:Any})
Shuts down and deletes the specified stage (disconnecting all participants).
# Arguments
- `arn`: ARN of the stage to be deleted.
"""
function delete_stage(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/DeleteStage",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stage(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/DeleteStage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_storage_configuration(arn)
delete_storage_configuration(arn, params::Dict{String,<:Any})
Deletes the storage configuration for the specified ARN. If you try to delete a storage
configuration that is used by a Composition, you will get an error (409 ConflictException).
To avoid this, for all Compositions that reference the storage configuration, first use
StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
# Arguments
- `arn`: ARN of the storage configuration to be deleted.
"""
function delete_storage_configuration(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/DeleteStorageConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_storage_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/DeleteStorageConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_participant(participant_id, stage_arn)
disconnect_participant(participant_id, stage_arn, params::Dict{String,<:Any})
Disconnects a specified participant and revokes the participant permanently from a
specified stage.
# Arguments
- `participant_id`: Identifier of the participant to be disconnected. This is assigned by
IVS and returned by CreateParticipantToken.
- `stage_arn`: ARN of the stage to which the participant is attached.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"reason"`: Description of why this participant is being disconnected.
"""
function disconnect_participant(
participantId, stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/DisconnectParticipant",
Dict{String,Any}("participantId" => participantId, "stageArn" => stageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_participant(
participantId,
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/DisconnectParticipant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("participantId" => participantId, "stageArn" => stageArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_composition(arn)
get_composition(arn, params::Dict{String,<:Any})
Get information about the specified Composition resource.
# Arguments
- `arn`: ARN of the Composition resource.
"""
function get_composition(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/GetComposition",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_composition(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/GetComposition",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_encoder_configuration(arn)
get_encoder_configuration(arn, params::Dict{String,<:Any})
Gets information about the specified EncoderConfiguration resource.
# Arguments
- `arn`: ARN of the EncoderConfiguration resource.
"""
function get_encoder_configuration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/GetEncoderConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_encoder_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/GetEncoderConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_participant(participant_id, session_id, stage_arn)
get_participant(participant_id, session_id, stage_arn, params::Dict{String,<:Any})
Gets information about the specified participant token.
# Arguments
- `participant_id`: Unique identifier for the participant. This is assigned by IVS and
returned by CreateParticipantToken.
- `session_id`: ID of a session within the stage.
- `stage_arn`: Stage ARN.
"""
function get_participant(
participantId, sessionId, stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/GetParticipant",
Dict{String,Any}(
"participantId" => participantId,
"sessionId" => sessionId,
"stageArn" => stageArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_participant(
participantId,
sessionId,
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/GetParticipant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"participantId" => participantId,
"sessionId" => sessionId,
"stageArn" => stageArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_stage(arn)
get_stage(arn, params::Dict{String,<:Any})
Gets information for the specified stage.
# Arguments
- `arn`: ARN of the stage for which the information is to be retrieved.
"""
function get_stage(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/GetStage",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_stage(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/GetStage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_stage_session(session_id, stage_arn)
get_stage_session(session_id, stage_arn, params::Dict{String,<:Any})
Gets information for the specified stage session.
# Arguments
- `session_id`: ID of a session within the stage.
- `stage_arn`: ARN of the stage for which the information is to be retrieved.
"""
function get_stage_session(
sessionId, stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/GetStageSession",
Dict{String,Any}("sessionId" => sessionId, "stageArn" => stageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_stage_session(
sessionId,
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/GetStageSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("sessionId" => sessionId, "stageArn" => stageArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_storage_configuration(arn)
get_storage_configuration(arn, params::Dict{String,<:Any})
Gets the storage configuration for the specified ARN.
# Arguments
- `arn`: ARN of the storage configuration to be retrieved.
"""
function get_storage_configuration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/GetStorageConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_storage_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/GetStorageConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_compositions()
list_compositions(params::Dict{String,<:Any})
Gets summary information about all Compositions in your account, in the AWS region where
the API request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterByEncoderConfigurationArn"`: Filters the Composition list to match the specified
EncoderConfiguration attached to at least one of its output.
- `"filterByStageArn"`: Filters the Composition list to match the specified Stage ARN.
- `"maxResults"`: Maximum number of results to return. Default: 100.
- `"nextToken"`: The first Composition to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_compositions(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST", "/ListCompositions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_compositions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/ListCompositions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_encoder_configurations()
list_encoder_configurations(params::Dict{String,<:Any})
Gets summary information about all EncoderConfigurations in your account, in the AWS region
where the API request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of results to return. Default: 100.
- `"nextToken"`: The first encoder configuration to retrieve. This is used for pagination;
see the nextToken response field.
"""
function list_encoder_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/ListEncoderConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_encoder_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/ListEncoderConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_participant_events(participant_id, session_id, stage_arn)
list_participant_events(participant_id, session_id, stage_arn, params::Dict{String,<:Any})
Lists events for a specified participant that occurred during a specified stage session.
# Arguments
- `participant_id`: Unique identifier for this participant. This is assigned by IVS and
returned by CreateParticipantToken.
- `session_id`: ID of a session within the stage.
- `stage_arn`: Stage ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of results to return. Default: 50.
- `"nextToken"`: The first participant event to retrieve. This is used for pagination; see
the nextToken response field.
"""
function list_participant_events(
participantId, sessionId, stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/ListParticipantEvents",
Dict{String,Any}(
"participantId" => participantId,
"sessionId" => sessionId,
"stageArn" => stageArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_participant_events(
participantId,
sessionId,
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/ListParticipantEvents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"participantId" => participantId,
"sessionId" => sessionId,
"stageArn" => stageArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_participants(session_id, stage_arn)
list_participants(session_id, stage_arn, params::Dict{String,<:Any})
Lists all participants in a specified stage session.
# Arguments
- `session_id`: ID of the session within the stage.
- `stage_arn`: Stage ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterByPublished"`: Filters the response list to only show participants who published
during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or
filterByRecordingState can be provided per request.
- `"filterByRecordingState"`: Filters the response list to only show participants with the
specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or
filterByRecordingState can be provided per request.
- `"filterByState"`: Filters the response list to only show participants in the specified
state. Only one of filterByUserId, filterByPublished, filterByState, or
filterByRecordingState can be provided per request.
- `"filterByUserId"`: Filters the response list to match the specified user ID. Only one of
filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided
per request. A userId is a customer-assigned name to help identify the token; this can be
used to link a participant to a user in the customer’s own systems.
- `"maxResults"`: Maximum number of results to return. Default: 50.
- `"nextToken"`: The first participant to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_participants(
sessionId, stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/ListParticipants",
Dict{String,Any}("sessionId" => sessionId, "stageArn" => stageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_participants(
sessionId,
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/ListParticipants",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("sessionId" => sessionId, "stageArn" => stageArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stage_sessions(stage_arn)
list_stage_sessions(stage_arn, params::Dict{String,<:Any})
Gets all sessions for a specified stage.
# Arguments
- `stage_arn`: Stage ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of results to return. Default: 50.
- `"nextToken"`: The first stage session to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_stage_sessions(stageArn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/ListStageSessions",
Dict{String,Any}("stageArn" => stageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_stage_sessions(
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/ListStageSessions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("stageArn" => stageArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stages()
list_stages(params::Dict{String,<:Any})
Gets summary information about all stages in your account, in the AWS region where the API
request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of results to return. Default: 50.
- `"nextToken"`: The first stage to retrieve. This is used for pagination; see the
nextToken response field.
"""
function list_stages(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST", "/ListStages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_stages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/ListStages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_storage_configurations()
list_storage_configurations(params::Dict{String,<:Any})
Gets summary information about all storage configurations in your account, in the AWS
region where the API request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of storage configurations to return. Default: your service
quota or 100, whichever is smaller.
- `"nextToken"`: The first storage configuration to retrieve. This is used for pagination;
see the nextToken response field.
"""
function list_storage_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/ListStorageConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_storage_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/ListStorageConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets information about AWS tags for the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be retrieved. The ARN must be URL-encoded.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_composition(destinations, stage_arn)
start_composition(destinations, stage_arn, params::Dict{String,<:Any})
Starts a Composition from a stage based on the configuration provided in the request. A
Composition is an ephemeral resource that exists after this endpoint returns successfully.
Composition stops and the resource is deleted: When StopComposition is called. After a
1-minute timeout, when all participants are disconnected from the stage. After a 1-minute
timeout, if there are no participants in the stage when StartComposition is called. When
broadcasting to the IVS channel fails and all retries are exhausted. When broadcasting is
disconnected and all attempts to reconnect are exhausted.
# Arguments
- `destinations`: Array of destination configuration.
- `stage_arn`: ARN of the stage to be used for compositing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"idempotencyToken"`: Idempotency token.
- `"layout"`: Layout object to configure composition parameters.
- `"tags"`: Tags attached to the resource. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags
beyond what is documented there.
"""
function start_composition(
destinations, stageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/StartComposition",
Dict{String,Any}(
"destinations" => destinations,
"stageArn" => stageArn,
"idempotencyToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_composition(
destinations,
stageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/StartComposition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinations" => destinations,
"stageArn" => stageArn,
"idempotencyToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_composition(arn)
stop_composition(arn, params::Dict{String,<:Any})
Stops and deletes a Composition resource. Any broadcast from the Composition resource is
stopped.
# Arguments
- `arn`: ARN of the Composition.
"""
function stop_composition(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/StopComposition",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_composition(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/StopComposition",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or updates tags for the AWS resource with the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be tagged. The ARN must be URL-encoded.
- `tags`: Array of tags to be added or updated. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources for details, including restrictions
that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no
constraints beyond what is documented there.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the resource with the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be untagged. The ARN must be URL-encoded.
- `tag_keys`: Array of tags to be removed. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what
is documented there.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivs_realtime(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_stage(arn)
update_stage(arn, params::Dict{String,<:Any})
Updates a stage’s configuration.
# Arguments
- `arn`: ARN of the stage to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoParticipantRecordingConfiguration"`: Auto-participant-recording configuration
object to attach to the stage. Auto-participant-recording configuration cannot be updated
while recording is active.
- `"name"`: Name of the stage to be updated.
"""
function update_stage(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ivs_realtime(
"POST",
"/UpdateStage",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_stage(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivs_realtime(
"POST",
"/UpdateStage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 23603 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ivschat
using AWS.Compat
using AWS.UUIDs
"""
create_chat_token(room_identifier, user_id)
create_chat_token(room_identifier, user_id, params::Dict{String,<:Any})
Creates an encrypted token that is used by a chat participant to establish an individual
WebSocket chat connection to a room. When the token is used to connect to chat, the
connection is valid for the session duration specified in the request. The token becomes
invalid at the token-expiration timestamp included in the response. Use the capabilities
field to permit an end user to send messages or moderate a room. The attributes field
securely attaches structured data to the chat session; the data is included within each
message sent by the end user and received by other participants in the room. Common use
cases for attributes include passing end-user profile data like an icon, display name,
colors, badges, and other display features. Encryption keys are owned by Amazon IVS Chat
and never used directly by your application.
# Arguments
- `room_identifier`: Identifier of the room that the client is trying to access. Currently
this must be an ARN.
- `user_id`: Application-provided ID that uniquely identifies the user associated with this
token. This can be any UTF-8 encoded text.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: Application-provided attributes to encode into the token and attach to a
chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of
this field is 1 KB total.
- `"capabilities"`: Set of capabilities that the user is allowed to perform in the room.
Default: None (the capability to view messages is implicitly included in all requests).
- `"sessionDurationInMinutes"`: Session duration (in minutes), after which the session
expires. Default: 60 (1 hour).
"""
function create_chat_token(
roomIdentifier, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/CreateChatToken",
Dict{String,Any}("roomIdentifier" => roomIdentifier, "userId" => userId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_chat_token(
roomIdentifier,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/CreateChatToken",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("roomIdentifier" => roomIdentifier, "userId" => userId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_logging_configuration(destination_configuration)
create_logging_configuration(destination_configuration, params::Dict{String,<:Any})
Creates a logging configuration that allows clients to store and record sent messages.
# Arguments
- `destination_configuration`: A complex type that contains a destination configuration for
where chat content will be logged. There can be only one type of destination
(cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Logging-configuration name. The value does not need to be unique.
- `"tags"`: Tags to attach to the resource. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags
beyond what is documented there.
"""
function create_logging_configuration(
destinationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/CreateLoggingConfiguration",
Dict{String,Any}("destinationConfiguration" => destinationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_logging_configuration(
destinationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/CreateLoggingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("destinationConfiguration" => destinationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_room()
create_room(params::Dict{String,<:Any})
Creates a room that allows clients to connect and pass messages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loggingConfigurationIdentifiers"`: Array of logging-configuration identifiers attached
to the room.
- `"maximumMessageLength"`: Maximum number of characters in a single message. Messages are
expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count,
not number of bytes. Default: 500.
- `"maximumMessageRatePerSecond"`: Maximum number of messages per second that can be sent
to the room (by all clients). Default: 10.
- `"messageReviewHandler"`: Configuration information for optional review of messages.
- `"name"`: Room name. The value does not need to be unique.
- `"tags"`: Tags to attach to the resource. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond
what is documented there.
"""
function create_room(; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST", "/CreateRoom"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_room(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/CreateRoom",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_logging_configuration(identifier)
delete_logging_configuration(identifier, params::Dict{String,<:Any})
Deletes the specified logging configuration.
# Arguments
- `identifier`: Identifier of the logging configuration to be deleted.
"""
function delete_logging_configuration(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/DeleteLoggingConfiguration",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_logging_configuration(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/DeleteLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_message(id, room_identifier)
delete_message(id, room_identifier, params::Dict{String,<:Any})
Sends an event to a specific room which directs clients to delete a specific message; that
is, unrender it from view and delete it from the client’s chat history. This event’s
EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in
the Amazon IVS Chat Messaging API.
# Arguments
- `id`: ID of the message to be deleted. This is the Id field in the received message (see
Message (Subscribe) in the Chat Messaging API).
- `room_identifier`: Identifier of the room where the message should be deleted. Currently
this must be an ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"reason"`: Reason for deleting the message.
"""
function delete_message(
id, roomIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/DeleteMessage",
Dict{String,Any}("id" => id, "roomIdentifier" => roomIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_message(
id,
roomIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/DeleteMessage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "roomIdentifier" => roomIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_room(identifier)
delete_room(identifier, params::Dict{String,<:Any})
Deletes the specified room.
# Arguments
- `identifier`: Identifier of the room to be deleted. Currently this must be an ARN.
"""
function delete_room(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST",
"/DeleteRoom",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_room(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/DeleteRoom",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_user(room_identifier, user_id)
disconnect_user(room_identifier, user_id, params::Dict{String,<:Any})
Disconnects all connections using a specified user ID from a room. This replicates the
DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
# Arguments
- `room_identifier`: Identifier of the room from which the user's clients should be
disconnected. Currently this must be an ARN.
- `user_id`: ID of the user (connection) to disconnect from the room.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"reason"`: Reason for disconnecting the user.
"""
function disconnect_user(
roomIdentifier, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/DisconnectUser",
Dict{String,Any}("roomIdentifier" => roomIdentifier, "userId" => userId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_user(
roomIdentifier,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/DisconnectUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("roomIdentifier" => roomIdentifier, "userId" => userId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logging_configuration(identifier)
get_logging_configuration(identifier, params::Dict{String,<:Any})
Gets the specified logging configuration.
# Arguments
- `identifier`: Identifier of the logging configuration to be retrieved.
"""
function get_logging_configuration(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/GetLoggingConfiguration",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_logging_configuration(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/GetLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_room(identifier)
get_room(identifier, params::Dict{String,<:Any})
Gets the specified room.
# Arguments
- `identifier`: Identifier of the room for which the configuration is to be retrieved.
Currently this must be an ARN.
"""
function get_room(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST",
"/GetRoom",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_room(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/GetRoom",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_logging_configurations()
list_logging_configurations(params::Dict{String,<:Any})
Gets summary information about all your logging configurations in the AWS region where the
API request is processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of logging configurations to return. Default: 50.
- `"nextToken"`: The first logging configurations to retrieve. This is used for pagination;
see the nextToken response field.
"""
function list_logging_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST",
"/ListLoggingConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_logging_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/ListLoggingConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rooms()
list_rooms(params::Dict{String,<:Any})
Gets summary information about all your rooms in the AWS region where the API request is
processed. Results are sorted in descending order of updateTime.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loggingConfigurationIdentifier"`: Logging-configuration identifier.
- `"maxResults"`: Maximum number of rooms to return. Default: 50.
- `"messageReviewHandlerUri"`: Filters the list to match the specified message review
handler URI.
- `"name"`: Filters the list to match the specified room name.
- `"nextToken"`: The first room to retrieve. This is used for pagination; see the nextToken
response field.
"""
function list_rooms(; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST", "/ListRooms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rooms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST", "/ListRooms", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets information about AWS tags for the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be retrieved. The ARN must be URL-encoded.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_event(event_name, room_identifier)
send_event(event_name, room_identifier, params::Dict{String,<:Any})
Sends an event to a room. Use this within your application’s business logic to send
events to clients of a room; e.g., to notify clients to change the way the chat UI is
rendered.
# Arguments
- `event_name`: Application-defined name of the event to send to clients.
- `room_identifier`: Identifier of the room to which the event will be sent. Currently this
must be an ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: Application-defined metadata to attach to the event sent to clients. The
maximum length of the metadata is 1 KB total.
"""
function send_event(
eventName, roomIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/SendEvent",
Dict{String,Any}("eventName" => eventName, "roomIdentifier" => roomIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_event(
eventName,
roomIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/SendEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventName" => eventName, "roomIdentifier" => roomIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or updates tags for the AWS resource with the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be tagged. The ARN must be URL-encoded.
- `tags`: Array of tags to be added or updated. Array of maps, each of the form
string:string (key:value). See Tagging AWS Resources for details, including restrictions
that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no
constraints beyond what is documented there.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the resource with the specified ARN.
# Arguments
- `resource_arn`: The ARN of the resource to be untagged. The ARN must be URL-encoded.
- `tag_keys`: Array of tags to be removed. Array of maps, each of the form string:string
(key:value). See Tagging AWS Resources for details, including restrictions that apply to
tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond
what is documented there.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_logging_configuration(identifier)
update_logging_configuration(identifier, params::Dict{String,<:Any})
Updates a specified logging configuration.
# Arguments
- `identifier`: Identifier of the logging configuration to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationConfiguration"`: A complex type that contains a destination configuration
for where chat content will be logged. There can be only one type of destination
(cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
- `"name"`: Logging-configuration name. The value does not need to be unique.
"""
function update_logging_configuration(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return ivschat(
"POST",
"/UpdateLoggingConfiguration",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_logging_configuration(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/UpdateLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_room(identifier)
update_room(identifier, params::Dict{String,<:Any})
Updates a room’s configuration.
# Arguments
- `identifier`: Identifier of the room to be updated. Currently this must be an ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loggingConfigurationIdentifiers"`: Array of logging-configuration identifiers attached
to the room.
- `"maximumMessageLength"`: The maximum number of characters in a single message. Messages
are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point
count, not number of bytes. Default: 500.
- `"maximumMessageRatePerSecond"`: Maximum number of messages per second that can be sent
to the room (by all clients). Default: 10.
- `"messageReviewHandler"`: Configuration information for optional review of messages.
Specify an empty uri string to disassociate a message review handler from the specified
room.
- `"name"`: Room name. The value does not need to be unique.
"""
function update_room(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return ivschat(
"POST",
"/UpdateRoom",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_room(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ivschat(
"POST",
"/UpdateRoom",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 69358 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kafka
using AWS.Compat
using AWS.UUIDs
"""
batch_associate_scram_secret(cluster_arn, secret_arn_list)
batch_associate_scram_secret(cluster_arn, secret_arn_list, params::Dict{String,<:Any})
Associates one or more Scram Secrets with an Amazon MSK cluster.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster to be updated.
- `secret_arn_list`:
List of AWS Secrets Manager secret ARNs.
"""
function batch_associate_scram_secret(
clusterArn, secretArnList; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"POST",
"/v1/clusters/$(clusterArn)/scram-secrets",
Dict{String,Any}("secretArnList" => secretArnList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_scram_secret(
clusterArn,
secretArnList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/clusters/$(clusterArn)/scram-secrets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("secretArnList" => secretArnList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_scram_secret(cluster_arn, secret_arn_list)
batch_disassociate_scram_secret(cluster_arn, secret_arn_list, params::Dict{String,<:Any})
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster to be updated.
- `secret_arn_list`:
List of AWS Secrets Manager secret ARNs.
"""
function batch_disassociate_scram_secret(
clusterArn, secretArnList; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PATCH",
"/v1/clusters/$(clusterArn)/scram-secrets",
Dict{String,Any}("secretArnList" => secretArnList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_scram_secret(
clusterArn,
secretArnList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PATCH",
"/v1/clusters/$(clusterArn)/scram-secrets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("secretArnList" => secretArnList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(broker_node_group_info, cluster_name, kafka_version, number_of_broker_nodes)
create_cluster(broker_node_group_info, cluster_name, kafka_version, number_of_broker_nodes, params::Dict{String,<:Any})
Creates a new MSK cluster.
# Arguments
- `broker_node_group_info`:
Information about the broker nodes in the
cluster.
- `cluster_name`:
The name of the cluster.
- `kafka_version`:
The version of Apache Kafka.
- `number_of_broker_nodes`:
The number of broker nodes in the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientAuthentication"`:
Includes all client authentication related
information.
- `"configurationInfo"`:
Represents the configuration that you want MSK to use
for the brokers in a cluster.
- `"encryptionInfo"`:
Includes all encryption-related information.
- `"enhancedMonitoring"`:
Specifies the level of monitoring for the MSK
cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and
PER_TOPIC_PER_PARTITION.
- `"loggingInfo"`:
- `"openMonitoring"`:
The settings for open monitoring.
- `"storageMode"`:
This controls storage mode for supported storage tiers.
- `"tags"`:
Create tags when creating the cluster.
"""
function create_cluster(
brokerNodeGroupInfo,
clusterName,
kafkaVersion,
numberOfBrokerNodes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/clusters",
Dict{String,Any}(
"brokerNodeGroupInfo" => brokerNodeGroupInfo,
"clusterName" => clusterName,
"kafkaVersion" => kafkaVersion,
"numberOfBrokerNodes" => numberOfBrokerNodes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
brokerNodeGroupInfo,
clusterName,
kafkaVersion,
numberOfBrokerNodes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/clusters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"brokerNodeGroupInfo" => brokerNodeGroupInfo,
"clusterName" => clusterName,
"kafkaVersion" => kafkaVersion,
"numberOfBrokerNodes" => numberOfBrokerNodes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster_v2(cluster_name)
create_cluster_v2(cluster_name, params::Dict{String,<:Any})
Creates a new MSK cluster.
# Arguments
- `cluster_name`:
The name of the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"provisioned"`:
Information about the provisioned cluster.
- `"serverless"`:
Information about the serverless cluster.
- `"tags"`:
A map of tags that you want the cluster to have.
"""
function create_cluster_v2(clusterName; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"POST",
"/api/v2/clusters",
Dict{String,Any}("clusterName" => clusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster_v2(
clusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/api/v2/clusters",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clusterName" => clusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration(name, server_properties)
create_configuration(name, server_properties, params::Dict{String,<:Any})
Creates a new MSK configuration.
# Arguments
- `name`:
The name of the configuration.
- `server_properties`:
Contents of the server.properties file. When using the
API, you must ensure that the contents of the file are base64 encoded.
When
using the AWS Management Console, the SDK, or the AWS CLI, the contents of
server.properties can be in plaintext.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`:
The description of the configuration.
- `"kafkaVersions"`:
The versions of Apache Kafka with which you can use this
MSK configuration.
"""
function create_configuration(
name, serverProperties; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"POST",
"/v1/configurations",
Dict{String,Any}("name" => name, "serverProperties" => serverProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration(
name,
serverProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/configurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "serverProperties" => serverProperties),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replicator(kafka_clusters, replication_info_list, replicator_name, service_execution_role_arn)
create_replicator(kafka_clusters, replication_info_list, replicator_name, service_execution_role_arn, params::Dict{String,<:Any})
Creates the replicator.
# Arguments
- `kafka_clusters`: Kafka Clusters to use in setting up sources / targets for replication.
- `replication_info_list`: A list of replication configurations, where each configuration
targets a given source cluster to target cluster replication flow.
- `replicator_name`: The name of the replicator. Alpha-numeric characters with '-' are
allowed.
- `service_execution_role_arn`: The ARN of the IAM role used by the replicator to access
resources in the customer's account (e.g source and target clusters)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A summary description of the replicator.
- `"tags"`: List of tags to attach to created Replicator.
"""
function create_replicator(
kafkaClusters,
replicationInfoList,
replicatorName,
serviceExecutionRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/replication/v1/replicators",
Dict{String,Any}(
"kafkaClusters" => kafkaClusters,
"replicationInfoList" => replicationInfoList,
"replicatorName" => replicatorName,
"serviceExecutionRoleArn" => serviceExecutionRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replicator(
kafkaClusters,
replicationInfoList,
replicatorName,
serviceExecutionRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/replication/v1/replicators",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"kafkaClusters" => kafkaClusters,
"replicationInfoList" => replicationInfoList,
"replicatorName" => replicatorName,
"serviceExecutionRoleArn" => serviceExecutionRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_connection(authentication, client_subnets, security_groups, target_cluster_arn, vpc_id)
create_vpc_connection(authentication, client_subnets, security_groups, target_cluster_arn, vpc_id, params::Dict{String,<:Any})
Creates a new MSK VPC connection.
# Arguments
- `authentication`:
The authentication type of VPC connection.
- `client_subnets`:
The list of client subnets.
- `security_groups`:
The list of security groups.
- `target_cluster_arn`:
The cluster Amazon Resource Name (ARN) for the VPC
connection.
- `vpc_id`:
The VPC ID of VPC connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`:
A map of tags for the VPC connection.
"""
function create_vpc_connection(
authentication,
clientSubnets,
securityGroups,
targetClusterArn,
vpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/vpc-connection",
Dict{String,Any}(
"authentication" => authentication,
"clientSubnets" => clientSubnets,
"securityGroups" => securityGroups,
"targetClusterArn" => targetClusterArn,
"vpcId" => vpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_connection(
authentication,
clientSubnets,
securityGroups,
targetClusterArn,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/vpc-connection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"authentication" => authentication,
"clientSubnets" => clientSubnets,
"securityGroups" => securityGroups,
"targetClusterArn" => targetClusterArn,
"vpcId" => vpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_arn)
delete_cluster(cluster_arn, params::Dict{String,<:Any})
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the
request.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentVersion"`:
The current version of the MSK cluster.
"""
function delete_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"DELETE",
"/v1/clusters/$(clusterArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"DELETE",
"/v1/clusters/$(clusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster_policy(cluster_arn)
delete_cluster_policy(cluster_arn, params::Dict{String,<:Any})
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in
the request.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster.
"""
function delete_cluster_policy(
clusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"DELETE",
"/v1/clusters/$(clusterArn)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster_policy(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"DELETE",
"/v1/clusters/$(clusterArn)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration(arn)
delete_configuration(arn, params::Dict{String,<:Any})
Deletes an MSK Configuration.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) that uniquely identifies an MSK
configuration.
"""
function delete_configuration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"DELETE",
"/v1/configurations/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"DELETE",
"/v1/configurations/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replicator(replicator_arn)
delete_replicator(replicator_arn, params::Dict{String,<:Any})
Deletes a replicator.
# Arguments
- `replicator_arn`: The Amazon Resource Name (ARN) of the replicator to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentVersion"`: The current version of the replicator.
"""
function delete_replicator(replicatorArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"DELETE",
"/replication/v1/replicators/$(replicatorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replicator(
replicatorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"DELETE",
"/replication/v1/replicators/$(replicatorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_connection(arn)
delete_vpc_connection(arn, params::Dict{String,<:Any})
Deletes a MSK VPC connection.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC
connection.
"""
function delete_vpc_connection(arn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"DELETE",
"/v1/vpc-connection/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_connection(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"DELETE",
"/v1/vpc-connection/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster(cluster_arn)
describe_cluster(cluster_arn, params::Dict{String,<:Any})
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is
specified in the request.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
"""
function describe_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/clusters/$(clusterArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_operation(cluster_operation_arn)
describe_cluster_operation(cluster_operation_arn, params::Dict{String,<:Any})
Returns a description of the cluster operation specified by the ARN.
# Arguments
- `cluster_operation_arn`:
The Amazon Resource Name (ARN) that uniquely
identifies the MSK cluster operation.
"""
function describe_cluster_operation(
clusterOperationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/operations/$(clusterOperationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_operation(
clusterOperationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/operations/$(clusterOperationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_operation_v2(cluster_operation_arn)
describe_cluster_operation_v2(cluster_operation_arn, params::Dict{String,<:Any})
Returns a description of the cluster operation specified by the ARN.
# Arguments
- `cluster_operation_arn`: ARN of the cluster operation to describe.
"""
function describe_cluster_operation_v2(
clusterOperationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/api/v2/operations/$(clusterOperationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_operation_v2(
clusterOperationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/api/v2/operations/$(clusterOperationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_v2(cluster_arn)
describe_cluster_v2(cluster_arn, params::Dict{String,<:Any})
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is
specified in the request.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
"""
function describe_cluster_v2(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/api/v2/clusters/$(clusterArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_v2(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/api/v2/clusters/$(clusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration(arn)
describe_configuration(arn, params::Dict{String,<:Any})
Returns a description of this MSK configuration.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) that uniquely identifies an MSK
configuration and all of its revisions.
"""
function describe_configuration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/configurations/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/configurations/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_revision(arn, revision)
describe_configuration_revision(arn, revision, params::Dict{String,<:Any})
Returns a description of this revision of the configuration.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) that uniquely identifies an MSK
configuration and all of its revisions.
- `revision`:
A string that uniquely identifies a revision of an MSK
configuration.
"""
function describe_configuration_revision(
arn, revision; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/configurations/$(arn)/revisions/$(revision)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_revision(
arn,
revision,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/configurations/$(arn)/revisions/$(revision)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replicator(replicator_arn)
describe_replicator(replicator_arn, params::Dict{String,<:Any})
Describes a replicator.
# Arguments
- `replicator_arn`: The Amazon Resource Name (ARN) of the replicator to be described.
"""
function describe_replicator(
replicatorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/replication/v1/replicators/$(replicatorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replicator(
replicatorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/replication/v1/replicators/$(replicatorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_connection(arn)
describe_vpc_connection(arn, params::Dict{String,<:Any})
Returns a description of this MSK VPC connection.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC
connection.
"""
function describe_vpc_connection(arn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/vpc-connection/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_connection(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/vpc-connection/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bootstrap_brokers(cluster_arn)
get_bootstrap_brokers(cluster_arn, params::Dict{String,<:Any})
A list of brokers that a client application can use to bootstrap.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
"""
function get_bootstrap_brokers(
clusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/bootstrap-brokers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bootstrap_brokers(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/bootstrap-brokers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cluster_policy(cluster_arn)
get_cluster_policy(cluster_arn, params::Dict{String,<:Any})
Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the
request.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster.
"""
function get_cluster_policy(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cluster_policy(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compatible_kafka_versions()
get_compatible_kafka_versions(params::Dict{String,<:Any})
Gets the Apache Kafka versions to which you can update the MSK cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clusterArn"`:
The Amazon Resource Name (ARN) of the cluster check.
"""
function get_compatible_kafka_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/compatible-kafka-versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compatible_kafka_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/compatible-kafka-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_client_vpc_connections(cluster_arn)
list_client_vpc_connections(cluster_arn, params::Dict{String,<:Any})
Returns a list of all the VPC connections in this Region.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_client_vpc_connections(
clusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/client-vpc-connections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_client_vpc_connections(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/client-vpc-connections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cluster_operations(cluster_arn)
list_cluster_operations(cluster_arn, params::Dict{String,<:Any})
Returns a list of all the operations that have been performed on the specified
MSK cluster.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_cluster_operations(
clusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/operations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cluster_operations(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/operations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cluster_operations_v2(cluster_arn)
list_cluster_operations_v2(cluster_arn, params::Dict{String,<:Any})
Returns a list of all the operations that have been performed on the specified
MSK cluster.
# Arguments
- `cluster_arn`: The arn of the cluster whose operations are being requested.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maxResults of the query.
- `"nextToken"`: The nextToken of the query.
"""
function list_cluster_operations_v2(
clusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/api/v2/clusters/$(clusterArn)/operations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cluster_operations_v2(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/api/v2/clusters/$(clusterArn)/operations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Returns a list of all the MSK clusters in the current Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clusterNameFilter"`:
Specify a prefix of the name of the clusters that you
want to list. The service lists all the clusters whose names start with this prefix.
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET", "/v1/clusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/clusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters_v2()
list_clusters_v2(params::Dict{String,<:Any})
Returns a list of all the MSK clusters in the current Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clusterNameFilter"`:
Specify a prefix of the names of the clusters that
you want to list. The service lists all the clusters whose names start with this prefix.
- `"clusterTypeFilter"`:
Specify either PROVISIONED or SERVERLESS.
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_clusters_v2(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET", "/api/v2/clusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_clusters_v2(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/api/v2/clusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_revisions(arn)
list_configuration_revisions(arn, params::Dict{String,<:Any})
Returns a list of all the MSK configurations in this Region.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) that uniquely identifies an MSK
configuration and all of its revisions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_configuration_revisions(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/configurations/$(arn)/revisions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_revisions(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/configurations/$(arn)/revisions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configurations()
list_configurations(params::Dict{String,<:Any})
Returns a list of all the MSK configurations in this Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET", "/v1/configurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kafka_versions()
list_kafka_versions(params::Dict{String,<:Any})
Returns a list of Apache Kafka versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response. To get the next batch,
provide this token in your next request.
"""
function list_kafka_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET", "/v1/kafka-versions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_kafka_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/kafka-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_nodes(cluster_arn)
list_nodes(cluster_arn, params::Dict{String,<:Any})
Returns a list of the broker nodes in the cluster.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_nodes(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/nodes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_nodes(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/nodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_replicators()
list_replicators(params::Dict{String,<:Any})
Lists the replicators.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response. If there are
more results, the response includes a NextToken parameter.
- `"nextToken"`: If the response of ListReplicators is truncated, it returns a NextToken in
the response. This NextToken should be sent in the subsequent request to ListReplicators.
- `"replicatorNameFilter"`: Returns replicators starting with given name.
"""
function list_replicators(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/replication/v1/replicators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_replicators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/replication/v1/replicators",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_scram_secrets(cluster_arn)
list_scram_secrets(cluster_arn, params::Dict{String,<:Any})
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
# Arguments
- `cluster_arn`:
The arn of the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maxResults of the query.
- `"nextToken"`:
The nextToken of the query.
"""
function list_scram_secrets(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/scram-secrets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_scram_secrets(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/clusters/$(clusterArn)/scram-secrets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of the tags associated with the specified resource.
# Arguments
- `resource_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
resource that's associated with the tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"GET",
"/v1/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpc_connections()
list_vpc_connections(params::Dict{String,<:Any})
Returns a list of all the VPC connections in this Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
The maximum number of results to return in the response. If
there are more results, the response includes a NextToken parameter.
- `"nextToken"`:
The paginated results marker. When the result of the
operation is truncated, the call returns NextToken in the response.
To get the
next batch, provide this token in your next request.
"""
function list_vpc_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"GET", "/v1/vpc-connections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_vpc_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"GET",
"/v1/vpc-connections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_cluster_policy(cluster_arn, policy)
put_cluster_policy(cluster_arn, policy, params::Dict{String,<:Any})
Creates or updates the MSK cluster policy specified by the cluster Amazon
Resource Name (ARN) in the request.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster.
- `policy`:
The policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentVersion"`:
The policy version.
"""
function put_cluster_policy(
clusterArn, policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/policy",
Dict{String,Any}("policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_cluster_policy(
clusterArn,
policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_broker(broker_ids, cluster_arn)
reboot_broker(broker_ids, cluster_arn, params::Dict{String,<:Any})
Reboots brokers.
# Arguments
- `broker_ids`:
The list of broker IDs to be rebooted. The reboot-broker
operation supports rebooting one broker at a time.
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster to be updated.
"""
function reboot_broker(
brokerIds, clusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/reboot-broker",
Dict{String,Any}("brokerIds" => brokerIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_broker(
brokerIds,
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/reboot-broker",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("brokerIds" => brokerIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_client_vpc_connection(cluster_arn, vpc_connection_arn)
reject_client_vpc_connection(cluster_arn, vpc_connection_arn, params::Dict{String,<:Any})
Returns empty response.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster.
- `vpc_connection_arn`:
The VPC connection ARN.
"""
function reject_client_vpc_connection(
clusterArn, vpcConnectionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/client-vpc-connection",
Dict{String,Any}("vpcConnectionArn" => vpcConnectionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_client_vpc_connection(
clusterArn,
vpcConnectionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/client-vpc-connection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("vpcConnectionArn" => vpcConnectionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to the specified MSK resource.
# Arguments
- `resource_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
resource that's associated with the tags.
- `tags`:
The key-value pair for the resource tag.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return kafka(
"POST",
"/v1/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"POST",
"/v1/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the tags associated with the keys that are provided in the query.
# Arguments
- `resource_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
resource that's associated with the tags.
- `tag_keys`:
Tag keys must be unique for a given cluster. In addition, the
following restrictions apply:
Each tag key
must be unique. If you add a tag with a key that's already in
use, your
new tag overwrites the existing key-value pair.
You can't start a tag key with aws: because this prefix is reserved for use
by AWS. AWS creates tags that begin with this prefix on your behalf, but
you can't edit or delete them.
Tag keys must be between 1 and 128 Unicode characters in length.
Tag keys must consist of the following characters: Unicode letters,
digits,
white space, and the following special characters: _ . / = + -
@.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"DELETE",
"/v1/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"DELETE",
"/v1/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_broker_count(cluster_arn, current_version, target_number_of_broker_nodes)
update_broker_count(cluster_arn, current_version, target_number_of_broker_nodes, params::Dict{String,<:Any})
Updates the number of broker nodes in the cluster.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
- `current_version`:
The version of cluster to update from. A successful
operation will then generate a new version.
- `target_number_of_broker_nodes`:
The number of broker nodes that you want
the cluster to have after this operation completes successfully.
"""
function update_broker_count(
clusterArn,
currentVersion,
targetNumberOfBrokerNodes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/nodes/count",
Dict{String,Any}(
"currentVersion" => currentVersion,
"targetNumberOfBrokerNodes" => targetNumberOfBrokerNodes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_broker_count(
clusterArn,
currentVersion,
targetNumberOfBrokerNodes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/nodes/count",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"currentVersion" => currentVersion,
"targetNumberOfBrokerNodes" => targetNumberOfBrokerNodes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_broker_storage(cluster_arn, current_version, target_broker_ebsvolume_info)
update_broker_storage(cluster_arn, current_version, target_broker_ebsvolume_info, params::Dict{String,<:Any})
Updates the EBS storage associated with MSK brokers.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
- `current_version`:
The version of cluster to update from. A successful
operation will then generate a new version.
- `target_broker_ebsvolume_info`:
Describes the target volume size and the ID
of the broker to apply the update to.
"""
function update_broker_storage(
clusterArn,
currentVersion,
targetBrokerEBSVolumeInfo;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/nodes/storage",
Dict{String,Any}(
"currentVersion" => currentVersion,
"targetBrokerEBSVolumeInfo" => targetBrokerEBSVolumeInfo,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_broker_storage(
clusterArn,
currentVersion,
targetBrokerEBSVolumeInfo,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/nodes/storage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"currentVersion" => currentVersion,
"targetBrokerEBSVolumeInfo" => targetBrokerEBSVolumeInfo,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_broker_type(cluster_arn, current_version, target_instance_type)
update_broker_type(cluster_arn, current_version, target_instance_type, params::Dict{String,<:Any})
Updates EC2 instance type.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
- `current_version`:
The cluster version that you want to change. After this
operation completes successfully, the cluster will have a new version.
- `target_instance_type`:
The Amazon MSK broker type that you want all of the
brokers in this cluster to be.
"""
function update_broker_type(
clusterArn,
currentVersion,
targetInstanceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/nodes/type",
Dict{String,Any}(
"currentVersion" => currentVersion, "targetInstanceType" => targetInstanceType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_broker_type(
clusterArn,
currentVersion,
targetInstanceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/nodes/type",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"currentVersion" => currentVersion,
"targetInstanceType" => targetInstanceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster_configuration(cluster_arn, configuration_info, current_version)
update_cluster_configuration(cluster_arn, configuration_info, current_version, params::Dict{String,<:Any})
Updates the cluster with the configuration that is specified in the request
body.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
- `configuration_info`:
Represents the configuration that you want MSK to use
for the brokers in a cluster.
- `current_version`:
The version of the cluster that needs to be updated.
"""
function update_cluster_configuration(
clusterArn,
configurationInfo,
currentVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/configuration",
Dict{String,Any}(
"configurationInfo" => configurationInfo, "currentVersion" => currentVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster_configuration(
clusterArn,
configurationInfo,
currentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/configuration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configurationInfo" => configurationInfo,
"currentVersion" => currentVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster_kafka_version(cluster_arn, current_version, target_kafka_version)
update_cluster_kafka_version(cluster_arn, current_version, target_kafka_version, params::Dict{String,<:Any})
Updates the Apache Kafka version for the cluster.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster to be updated.
- `current_version`:
Current cluster version.
- `target_kafka_version`:
Target Kafka version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configurationInfo"`:
The custom configuration that should be applied on
the new version of cluster.
"""
function update_cluster_kafka_version(
clusterArn,
currentVersion,
targetKafkaVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/version",
Dict{String,Any}(
"currentVersion" => currentVersion, "targetKafkaVersion" => targetKafkaVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster_kafka_version(
clusterArn,
currentVersion,
targetKafkaVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/version",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"currentVersion" => currentVersion,
"targetKafkaVersion" => targetKafkaVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration(arn, server_properties)
update_configuration(arn, server_properties, params::Dict{String,<:Any})
Updates an MSK configuration.
# Arguments
- `arn`:
The Amazon Resource Name (ARN) of the configuration.
- `server_properties`:
Contents of the server.properties file. When using the
API, you must ensure that the contents of the file are base64 encoded.
When
using the AWS Management Console, the SDK, or the AWS CLI, the contents of
server.properties can be in plaintext.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`:
The description of the configuration revision.
"""
function update_configuration(
arn, serverProperties; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PUT",
"/v1/configurations/$(arn)",
Dict{String,Any}("serverProperties" => serverProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration(
arn,
serverProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/configurations/$(arn)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("serverProperties" => serverProperties), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connectivity(cluster_arn, connectivity_info, current_version)
update_connectivity(cluster_arn, connectivity_info, current_version, params::Dict{String,<:Any})
Updates the cluster's connectivity configuration.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the configuration.
- `connectivity_info`:
Information about the broker access configuration.
- `current_version`:
The version of the MSK cluster to update. Cluster
versions aren't simple numbers. You can describe an MSK cluster to find its version. When
this update operation is successful, it generates a new cluster version.
"""
function update_connectivity(
clusterArn,
connectivityInfo,
currentVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/connectivity",
Dict{String,Any}(
"connectivityInfo" => connectivityInfo, "currentVersion" => currentVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connectivity(
clusterArn,
connectivityInfo,
currentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/connectivity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectivityInfo" => connectivityInfo,
"currentVersion" => currentVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_monitoring(cluster_arn, current_version)
update_monitoring(cluster_arn, current_version, params::Dict{String,<:Any})
Updates the monitoring settings for the cluster. You can use this operation to
specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You
can also specify settings for open monitoring with Prometheus.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
- `current_version`:
The version of the MSK cluster to update. Cluster
versions aren't simple numbers. You can describe an MSK cluster to find its version. When
this update operation is successful, it generates a new cluster version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enhancedMonitoring"`:
Specifies which Apache Kafka metrics Amazon MSK
gathers and sends to Amazon CloudWatch for this cluster.
- `"loggingInfo"`:
- `"openMonitoring"`:
The settings for open monitoring.
"""
function update_monitoring(
clusterArn, currentVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/monitoring",
Dict{String,Any}("currentVersion" => currentVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_monitoring(
clusterArn,
currentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/monitoring",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("currentVersion" => currentVersion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_replication_info(current_version, replicator_arn, source_kafka_cluster_arn, target_kafka_cluster_arn)
update_replication_info(current_version, replicator_arn, source_kafka_cluster_arn, target_kafka_cluster_arn, params::Dict{String,<:Any})
Updates replication info of a replicator.
# Arguments
- `current_version`: Current replicator version.
- `replicator_arn`: The Amazon Resource Name (ARN) of the replicator to be updated.
- `source_kafka_cluster_arn`: The ARN of the source Kafka cluster.
- `target_kafka_cluster_arn`: The ARN of the target Kafka cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"consumerGroupReplication"`: Updated consumer group replication information.
- `"topicReplication"`: Updated topic replication information.
"""
function update_replication_info(
currentVersion,
replicatorArn,
sourceKafkaClusterArn,
targetKafkaClusterArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/replication/v1/replicators/$(replicatorArn)/replication-info",
Dict{String,Any}(
"currentVersion" => currentVersion,
"sourceKafkaClusterArn" => sourceKafkaClusterArn,
"targetKafkaClusterArn" => targetKafkaClusterArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_replication_info(
currentVersion,
replicatorArn,
sourceKafkaClusterArn,
targetKafkaClusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/replication/v1/replicators/$(replicatorArn)/replication-info",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"currentVersion" => currentVersion,
"sourceKafkaClusterArn" => sourceKafkaClusterArn,
"targetKafkaClusterArn" => targetKafkaClusterArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security(cluster_arn, current_version)
update_security(cluster_arn, current_version, params::Dict{String,<:Any})
Updates the security settings for the cluster. You can use this operation to
specify encryption and authentication on existing clusters.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
- `current_version`:
The version of the MSK cluster to update. Cluster
versions aren't simple numbers. You can describe an MSK cluster to find its version. When
this update operation is successful, it generates a new cluster version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientAuthentication"`:
Includes all client authentication related
information.
- `"encryptionInfo"`:
Includes all encryption-related information.
"""
function update_security(
clusterArn, currentVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PATCH",
"/v1/clusters/$(clusterArn)/security",
Dict{String,Any}("currentVersion" => currentVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security(
clusterArn,
currentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PATCH",
"/v1/clusters/$(clusterArn)/security",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("currentVersion" => currentVersion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_storage(cluster_arn, current_version)
update_storage(cluster_arn, current_version, params::Dict{String,<:Any})
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
# Arguments
- `cluster_arn`:
The Amazon Resource Name (ARN) of the cluster to be updated.
- `current_version`:
The version of cluster to update from. A successful
operation will then generate a new version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"provisionedThroughput"`:
EBS volume provisioned throughput information.
- `"storageMode"`:
Controls storage mode for supported storage tiers.
- `"volumeSizeGB"`:
size of the EBS volume to update.
"""
function update_storage(
clusterArn, currentVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/storage",
Dict{String,Any}("currentVersion" => currentVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_storage(
clusterArn,
currentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafka(
"PUT",
"/v1/clusters/$(clusterArn)/storage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("currentVersion" => currentVersion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 21557 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kafkaconnect
using AWS.Compat
using AWS.UUIDs
"""
create_connector(capacity, connector_configuration, connector_name, kafka_cluster, kafka_cluster_client_authentication, kafka_cluster_encryption_in_transit, kafka_connect_version, plugins, service_execution_role_arn)
create_connector(capacity, connector_configuration, connector_name, kafka_cluster, kafka_cluster_client_authentication, kafka_cluster_encryption_in_transit, kafka_connect_version, plugins, service_execution_role_arn, params::Dict{String,<:Any})
Creates a connector using the specified properties.
# Arguments
- `capacity`: Information about the capacity allocated to the connector. Exactly one of the
two properties must be specified.
- `connector_configuration`: A map of keys to values that represent the configuration for
the connector.
- `connector_name`: The name of the connector.
- `kafka_cluster`: Specifies which Apache Kafka cluster to connect to.
- `kafka_cluster_client_authentication`: Details of the client authentication used by the
Apache Kafka cluster.
- `kafka_cluster_encryption_in_transit`: Details of encryption in transit to the Apache
Kafka cluster.
- `kafka_connect_version`: The version of Kafka Connect. It has to be compatible with both
the Apache Kafka cluster's version and the plugins.
- `plugins`: Amazon MSK Connect does not currently support specifying multiple plugins as
a list. To use more than one plugin for your connector, you can create a single custom
plugin using a ZIP file that bundles multiple plugins together. Specifies which plugin to
use for the connector. You must specify a single-element list containing one customPlugin
object.
- `service_execution_role_arn`: The Amazon Resource Name (ARN) of the IAM role used by the
connector to access the Amazon Web Services resources that it needs. The types of resources
depends on the logic of the connector. For example, a connector that has Amazon S3 as a
destination must have permissions that allow it to write to the S3 destination bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectorDescription"`: A summary description of the connector.
- `"logDelivery"`: Details about log delivery.
- `"tags"`: The tags you want to attach to the connector.
- `"workerConfiguration"`: Specifies which worker configuration to use with the connector.
"""
function create_connector(
capacity,
connectorConfiguration,
connectorName,
kafkaCluster,
kafkaClusterClientAuthentication,
kafkaClusterEncryptionInTransit,
kafkaConnectVersion,
plugins,
serviceExecutionRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"POST",
"/v1/connectors",
Dict{String,Any}(
"capacity" => capacity,
"connectorConfiguration" => connectorConfiguration,
"connectorName" => connectorName,
"kafkaCluster" => kafkaCluster,
"kafkaClusterClientAuthentication" => kafkaClusterClientAuthentication,
"kafkaClusterEncryptionInTransit" => kafkaClusterEncryptionInTransit,
"kafkaConnectVersion" => kafkaConnectVersion,
"plugins" => plugins,
"serviceExecutionRoleArn" => serviceExecutionRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector(
capacity,
connectorConfiguration,
connectorName,
kafkaCluster,
kafkaClusterClientAuthentication,
kafkaClusterEncryptionInTransit,
kafkaConnectVersion,
plugins,
serviceExecutionRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"POST",
"/v1/connectors",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"capacity" => capacity,
"connectorConfiguration" => connectorConfiguration,
"connectorName" => connectorName,
"kafkaCluster" => kafkaCluster,
"kafkaClusterClientAuthentication" => kafkaClusterClientAuthentication,
"kafkaClusterEncryptionInTransit" => kafkaClusterEncryptionInTransit,
"kafkaConnectVersion" => kafkaConnectVersion,
"plugins" => plugins,
"serviceExecutionRoleArn" => serviceExecutionRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_plugin(content_type, location, name)
create_custom_plugin(content_type, location, name, params::Dict{String,<:Any})
Creates a custom plugin using the specified properties.
# Arguments
- `content_type`: The type of the plugin file.
- `location`: Information about the location of a custom plugin.
- `name`: The name of the custom plugin.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A summary description of the custom plugin.
- `"tags"`: The tags you want to attach to the custom plugin.
"""
function create_custom_plugin(
contentType, location, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"POST",
"/v1/custom-plugins",
Dict{String,Any}(
"contentType" => contentType, "location" => location, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_plugin(
contentType,
location,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"POST",
"/v1/custom-plugins",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"contentType" => contentType, "location" => location, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_worker_configuration(name, properties_file_content)
create_worker_configuration(name, properties_file_content, params::Dict{String,<:Any})
Creates a worker configuration using the specified properties.
# Arguments
- `name`: The name of the worker configuration.
- `properties_file_content`: Base64 encoded contents of connect-distributed.properties file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A summary description of the worker configuration.
- `"tags"`: The tags you want to attach to the worker configuration.
"""
function create_worker_configuration(
name, propertiesFileContent; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"POST",
"/v1/worker-configurations",
Dict{String,Any}("name" => name, "propertiesFileContent" => propertiesFileContent);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_worker_configuration(
name,
propertiesFileContent,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"POST",
"/v1/worker-configurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "propertiesFileContent" => propertiesFileContent
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector(connector_arn)
delete_connector(connector_arn, params::Dict{String,<:Any})
Deletes the specified connector.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) of the connector that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentVersion"`: The current version of the connector that you want to delete.
"""
function delete_connector(connectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafkaconnect(
"DELETE",
"/v1/connectors/$(connectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector(
connectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"DELETE",
"/v1/connectors/$(connectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_plugin(custom_plugin_arn)
delete_custom_plugin(custom_plugin_arn, params::Dict{String,<:Any})
Deletes a custom plugin.
# Arguments
- `custom_plugin_arn`: The Amazon Resource Name (ARN) of the custom plugin that you want to
delete.
"""
function delete_custom_plugin(
customPluginArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"DELETE",
"/v1/custom-plugins/$(customPluginArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_plugin(
customPluginArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"DELETE",
"/v1/custom-plugins/$(customPluginArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_worker_configuration(worker_configuration_arn)
delete_worker_configuration(worker_configuration_arn, params::Dict{String,<:Any})
Deletes the specified worker configuration.
# Arguments
- `worker_configuration_arn`: The Amazon Resource Name (ARN) of the worker configuration
that you want to delete.
"""
function delete_worker_configuration(
workerConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"DELETE",
"/v1/worker-configurations/$(workerConfigurationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_worker_configuration(
workerConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"DELETE",
"/v1/worker-configurations/$(workerConfigurationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connector(connector_arn)
describe_connector(connector_arn, params::Dict{String,<:Any})
Returns summary information about the connector.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) of the connector that you want to
describe.
"""
function describe_connector(connectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return kafkaconnect(
"GET",
"/v1/connectors/$(connectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_connector(
connectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"GET",
"/v1/connectors/$(connectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_plugin(custom_plugin_arn)
describe_custom_plugin(custom_plugin_arn, params::Dict{String,<:Any})
A summary description of the custom plugin.
# Arguments
- `custom_plugin_arn`: Returns information about a custom plugin.
"""
function describe_custom_plugin(
customPluginArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"GET",
"/v1/custom-plugins/$(customPluginArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_plugin(
customPluginArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"GET",
"/v1/custom-plugins/$(customPluginArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_worker_configuration(worker_configuration_arn)
describe_worker_configuration(worker_configuration_arn, params::Dict{String,<:Any})
Returns information about a worker configuration.
# Arguments
- `worker_configuration_arn`: The Amazon Resource Name (ARN) of the worker configuration
that you want to get information about.
"""
function describe_worker_configuration(
workerConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"GET",
"/v1/worker-configurations/$(workerConfigurationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_worker_configuration(
workerConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"GET",
"/v1/worker-configurations/$(workerConfigurationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connectors()
list_connectors(params::Dict{String,<:Any})
Returns a list of all the connectors in this account and Region. The list is limited to
connectors whose name starts with the specified prefix. The response also includes a
description of each of the listed connectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectorNamePrefix"`: The name prefix that you want to use to search for and list
connectors.
- `"maxResults"`: The maximum number of connectors to list in one response.
- `"nextToken"`: If the response of a ListConnectors operation is truncated, it will
include a NextToken. Send this NextToken in a subsequent request to continue listing from
where the previous operation left off.
"""
function list_connectors(; aws_config::AbstractAWSConfig=global_aws_config())
return kafkaconnect(
"GET", "/v1/connectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"GET",
"/v1/connectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_plugins()
list_custom_plugins(params::Dict{String,<:Any})
Returns a list of all of the custom plugins in this account and Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of custom plugins to list in one response.
- `"namePrefix"`: Lists custom plugin names that start with the specified text string.
- `"nextToken"`: If the response of a ListCustomPlugins operation is truncated, it will
include a NextToken. Send this NextToken in a subsequent request to continue listing from
where the previous operation left off.
"""
function list_custom_plugins(; aws_config::AbstractAWSConfig=global_aws_config())
return kafkaconnect(
"GET", "/v1/custom-plugins"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_custom_plugins(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"GET",
"/v1/custom-plugins",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all the tags attached to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want to list
all attached tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"GET",
"/v1/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"GET",
"/v1/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_worker_configurations()
list_worker_configurations(params::Dict{String,<:Any})
Returns a list of all of the worker configurations in this account and Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of worker configurations to list in one response.
- `"namePrefix"`: Lists worker configuration names that start with the specified text
string.
- `"nextToken"`: If the response of a ListWorkerConfigurations operation is truncated, it
will include a NextToken. Send this NextToken in a subsequent request to continue listing
from where the previous operation left off.
"""
function list_worker_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return kafkaconnect(
"GET",
"/v1/worker-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_worker_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"GET",
"/v1/worker-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Attaches tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which you want to
attach tags.
- `tags`: The tags that you want to attach to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return kafkaconnect(
"POST",
"/v1/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"POST",
"/v1/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource from which you want to
remove tags.
- `tag_keys`: The keys of the tags that you want to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return kafkaconnect(
"DELETE",
"/v1/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"DELETE",
"/v1/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connector(capacity, connector_arn, current_version)
update_connector(capacity, connector_arn, current_version, params::Dict{String,<:Any})
Updates the specified connector.
# Arguments
- `capacity`: The target capacity.
- `connector_arn`: The Amazon Resource Name (ARN) of the connector that you want to update.
- `current_version`: The current version of the connector that you want to update.
"""
function update_connector(
capacity,
connectorArn,
currentVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"PUT",
"/v1/connectors/$(connectorArn)",
Dict{String,Any}("capacity" => capacity, "currentVersion" => currentVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connector(
capacity,
connectorArn,
currentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kafkaconnect(
"PUT",
"/v1/connectors/$(connectorArn)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"capacity" => capacity, "currentVersion" => currentVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 133059 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kendra
using AWS.Compat
using AWS.UUIDs
"""
associate_entities_to_experience(entity_list, id, index_id)
associate_entities_to_experience(entity_list, id, index_id, params::Dict{String,<:Any})
Grants users or groups in your IAM Identity Center identity source access to your Amazon
Kendra experience. You can create an Amazon Kendra experience such as a search application.
For more information on creating a search application experience, see Building a search
experience with no code.
# Arguments
- `entity_list`: Lists users or groups in your IAM Identity Center identity source.
- `id`: The identifier of your Amazon Kendra experience.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
"""
function associate_entities_to_experience(
EntityList, Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"AssociateEntitiesToExperience",
Dict{String,Any}("EntityList" => EntityList, "Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_entities_to_experience(
EntityList,
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"AssociateEntitiesToExperience",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EntityList" => EntityList, "Id" => Id, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_personas_to_entities(id, index_id, personas)
associate_personas_to_entities(id, index_id, personas, params::Dict{String,<:Any})
Defines the specific permissions of users or groups in your IAM Identity Center identity
source with access to your Amazon Kendra experience. You can create an Amazon Kendra
experience such as a search application. For more information on creating a search
application experience, see Building a search experience with no code.
# Arguments
- `id`: The identifier of your Amazon Kendra experience.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
- `personas`: The personas that define the specific permissions of users or groups in your
IAM Identity Center identity source. The available personas or access roles are Owner and
Viewer. For more information on these personas, see Providing access to your search page.
"""
function associate_personas_to_entities(
Id, IndexId, Personas; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"AssociatePersonasToEntities",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId, "Personas" => Personas);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_personas_to_entities(
Id,
IndexId,
Personas,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"AssociatePersonasToEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Id" => Id, "IndexId" => IndexId, "Personas" => Personas),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_document(document_id_list, index_id)
batch_delete_document(document_id_list, index_id, params::Dict{String,<:Any})
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of
the deletion by using Amazon Web Services CloudWatch. Any error messages related to the
processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also
use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.
Deleting documents from an index using BatchDeleteDocument could take up to an hour or
more, depending on the number of documents you want to delete.
# Arguments
- `document_id_list`: One or more identifiers for documents to delete from the index.
- `index_id`: The identifier of the index that contains the documents to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceSyncJobMetricTarget"`:
"""
function batch_delete_document(
DocumentIdList, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"BatchDeleteDocument",
Dict{String,Any}("DocumentIdList" => DocumentIdList, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_document(
DocumentIdList,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"BatchDeleteDocument",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentIdList" => DocumentIdList, "IndexId" => IndexId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_featured_results_set(featured_results_set_ids, index_id)
batch_delete_featured_results_set(featured_results_set_ids, index_id, params::Dict{String,<:Any})
Removes one or more sets of featured results. Features results are placed above all other
results for certain queries. If there's an exact match of a query, then one or more
specific documents are featured in the search results.
# Arguments
- `featured_results_set_ids`: The identifiers of the featured results sets that you want to
delete.
- `index_id`: The identifier of the index used for featuring results.
"""
function batch_delete_featured_results_set(
FeaturedResultsSetIds, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"BatchDeleteFeaturedResultsSet",
Dict{String,Any}(
"FeaturedResultsSetIds" => FeaturedResultsSetIds, "IndexId" => IndexId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_featured_results_set(
FeaturedResultsSetIds,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"BatchDeleteFeaturedResultsSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeaturedResultsSetIds" => FeaturedResultsSetIds, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_document_status(document_info_list, index_id)
batch_get_document_status(document_info_list, index_id, params::Dict{String,<:Any})
Returns the indexing status for one or more documents submitted with the BatchPutDocument
API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can
use the BatchGetDocumentStatus API to get the current status of a list of documents so that
you can determine if they have been successfully indexed. You can also use the
BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a
document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
# Arguments
- `document_info_list`: A list of DocumentInfo objects that identify the documents for
which to get the status. You identify the documents by their document ID and optional
attributes.
- `index_id`: The identifier of the index to add documents to. The index ID is returned by
the CreateIndex API.
"""
function batch_get_document_status(
DocumentInfoList, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"BatchGetDocumentStatus",
Dict{String,Any}("DocumentInfoList" => DocumentInfoList, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_document_status(
DocumentInfoList,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"BatchGetDocumentStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DocumentInfoList" => DocumentInfoList, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_document(documents, index_id)
batch_put_document(documents, index_id, params::Dict{String,<:Any})
Adds one or more documents to an index. The BatchPutDocument API enables you to ingest
inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to
ingest your text and unstructured text into an index, add custom attributes to the
documents, and to attach an access control list to the documents added to the index. The
documents are indexed asynchronously. You can see the progress of the batch using Amazon
Web Services CloudWatch. Any error messages related to processing the batch are sent to
your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to
monitor the progress of indexing your documents. For an example of ingesting inline
documents using Python and Java SDKs, see Adding files directly to an index.
# Arguments
- `documents`: One or more documents to add to the index. Documents have the following file
size limits. 50 MB total size for any file 5 MB extracted text for any file For more
information, see Quotas.
- `index_id`: The identifier of the index to add the documents to. You need to create the
index first using the CreateIndex API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomDocumentEnrichmentConfiguration"`: Configuration information for altering your
document metadata and content during the document ingestion process when you use the
BatchPutDocument API. For more information on how to create, modify and delete document
metadata, or make other content alterations when you ingest documents into Amazon Kendra,
see Customizing document metadata during the ingestion process.
- `"RoleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access your
S3 bucket. For more information, see IAM access roles for Amazon Kendra.
"""
function batch_put_document(
Documents, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"BatchPutDocument",
Dict{String,Any}("Documents" => Documents, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_document(
Documents,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"BatchPutDocument",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Documents" => Documents, "IndexId" => IndexId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
clear_query_suggestions(index_id)
clear_query_suggestions(index_id, params::Dict{String,<:Any})
Clears existing query suggestions from an index. This deletes existing suggestions only,
not the queries in the query log. After you clear suggestions, Amazon Kendra learns new
suggestions based on new queries added to the query log from the time you cleared
suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to
collect enough queries to learn new suggestions. ClearQuerySuggestions is currently not
supported in the Amazon Web Services GovCloud (US-West) region.
# Arguments
- `index_id`: The identifier of the index you want to clear query suggestions from.
"""
function clear_query_suggestions(IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"ClearQuerySuggestions",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function clear_query_suggestions(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ClearQuerySuggestions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_control_configuration(index_id, name)
create_access_control_configuration(index_id, name, params::Dict{String,<:Any})
Creates an access configuration for your documents. This includes user and group access
information for your documents. This is useful for user context filtering, where search
results are filtered based on the user or their group access to documents. You can use this
to re-configure your existing document level access control without indexing all of your
documents again. For example, your index contains top-secret company documents that only
certain employees or users should access. One of these users leaves the company or switches
to a team that should be blocked from accessing top-secret documents. The user still has
access to top-secret documents because the user had access when your documents were
previously indexed. You can create a specific access control configuration for the user
with deny access. You can later update the access control configuration to allow access if
the user returns to the company and re-joins the 'top-secret' team. You can re-configure
access control for your documents as circumstances change. To apply your access control
configuration to certain documents, you call the BatchPutDocument API with the
AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a
data source, you update the .metadata.json with the AccessControlConfigurationId and
synchronize your data source. Amazon Kendra currently only supports access control
configuration for S3 data sources and documents indexed using the BatchPutDocument API.
# Arguments
- `index_id`: The identifier of the index to create an access control configuration for
your documents.
- `name`: A name for the access control configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessControlList"`: Information on principals (users and/or groups) and which
documents they should have access to. This is useful for user context filtering, where
search results are filtered based on the user or their group access to documents.
- `"ClientToken"`: A token that you provide to identify the request to create an access
control configuration. Multiple calls to the CreateAccessControlConfiguration API with the
same client token will create only one access control configuration.
- `"Description"`: A description for the access control configuration.
- `"HierarchicalAccessControlList"`: The list of principal lists that define the hierarchy
for which documents users should have access to.
"""
function create_access_control_configuration(
IndexId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"CreateAccessControlConfiguration",
Dict{String,Any}(
"IndexId" => IndexId, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_control_configuration(
IndexId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateAccessControlConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId, "Name" => Name, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source(index_id, name, type)
create_data_source(index_id, name, type, params::Dict{String,<:Any})
Creates a data source connector that you want to use with an Amazon Kendra index. You
specify a name, data source connector type and description for your data source. You also
specify configuration information for the data source connector. CreateDataSource is a
synchronous operation. The operation returns 200 if the data source was successfully
created. Otherwise, an exception is raised. For an example of creating an index and data
source using the Python SDK, see Getting started with Python SDK. For an example of
creating an index and data source using the Java SDK, see Getting started with Java SDK.
# Arguments
- `index_id`: The identifier of the index you want to use with the data source connector.
- `name`: A name for the data source connector.
- `type`: The type of data source repository. For example, SHAREPOINT.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create a data source
connector. Multiple calls to the CreateDataSource API with the same client token will
create only one data source connector.
- `"Configuration"`: Configuration information to connect to your data source repository.
You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If
you do, you receive a ValidationException exception. The Configuration parameter is
required for all other data sources.
- `"CustomDocumentEnrichmentConfiguration"`: Configuration information for altering
document metadata and content during the document ingestion process. For more information
on how to create, modify and delete document metadata, or make other content alterations
when you ingest documents into Amazon Kendra, see Customizing document metadata during the
ingestion process.
- `"Description"`: A description for the data source connector.
- `"LanguageCode"`: The code for a language. This allows you to support a language for all
documents when creating the data source connector. English is supported by default. For
more information on supported languages, including their codes, see Adding documents in
languages other than English.
- `"RoleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access the
data source and required resources. For more information, see IAM access roles for Amazon
Kendra.. You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM.
If you do, you receive a ValidationException exception. The RoleArn parameter is required
for all other data sources.
- `"Schedule"`: Sets the frequency for Amazon Kendra to check the documents in your data
source repository and update the index. If you don't set a schedule Amazon Kendra will not
periodically update the index. You can call the StartDataSourceSyncJob API to update the
index. Specify a cron- format schedule string or an empty string to indicate that the index
is updated on demand. You can't specify the Schedule parameter when the Type parameter is
set to CUSTOM. If you do, you receive a ValidationException exception.
- `"Tags"`: A list of key-value pairs that identify or categorize the data source
connector. You can also use tags to help control access to the data source connector. Tag
keys and values can consist of Unicode letters, digits, white space, and any of the
following symbols: _ . : / = + - @.
- `"VpcConfiguration"`: Configuration information for an Amazon Virtual Private Cloud to
connect to your data source. For more information, see Configuring a VPC.
"""
function create_data_source(
IndexId, Name, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"CreateDataSource",
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"Type" => Type,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source(
IndexId,
Name,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateDataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"Type" => Type,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_experience(index_id, name)
create_experience(index_id, name, params::Dict{String,<:Any})
Creates an Amazon Kendra experience such as a search application. For more information on
creating a search application experience, including using the Python and Java SDKs, see
Building a search experience with no code.
# Arguments
- `index_id`: The identifier of the index for your Amazon Kendra experience.
- `name`: A name for your Amazon Kendra experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create your Amazon
Kendra experience. Multiple calls to the CreateExperience API with the same client token
creates only one Amazon Kendra experience.
- `"Configuration"`: Configuration information for your Amazon Kendra experience. This
includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs,
and UserIdentityConfiguration, which specifies the user or group information to grant
access to your Amazon Kendra experience.
- `"Description"`: A description for your Amazon Kendra experience.
- `"RoleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access
Query API, GetQuerySuggestions API, and other required APIs. The role also must include
permission to access IAM Identity Center that stores your user and group information. For
more information, see IAM access roles for Amazon Kendra.
"""
function create_experience(IndexId, Name; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"CreateExperience",
Dict{String,Any}(
"IndexId" => IndexId, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_experience(
IndexId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateExperience",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId, "Name" => Name, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_faq(index_id, name, role_arn, s3_path)
create_faq(index_id, name, role_arn, s3_path, params::Dict{String,<:Any})
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an
Amazon S3 bucket. Adding FAQs to an index is an asynchronous operation. For an example of
adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
# Arguments
- `index_id`: The identifier of the index for the FAQ.
- `name`: A name for the FAQ.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role with permission to access the
S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon
Kendra.
- `s3_path`: The path to the FAQ file in S3.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create a FAQ.
Multiple calls to the CreateFaqRequest API with the same client token will create only one
FAQ.
- `"Description"`: A description for the FAQ.
- `"FileFormat"`: The format of the FAQ input file. You can choose between a basic CSV
format, a CSV format that includes customs attributes in a header, and a JSON format that
includes custom attributes. The default format is CSV. The format must match the format of
the file stored in the S3 bucket identified in the S3Path parameter. For more information,
see Adding questions and answers.
- `"LanguageCode"`: The code for a language. This allows you to support a language for the
FAQ document. English is supported by default. For more information on supported languages,
including their codes, see Adding documents in languages other than English.
- `"Tags"`: A list of key-value pairs that identify the FAQ. You can use the tags to
identify and organize your resources and to control access to resources.
"""
function create_faq(
IndexId, Name, RoleArn, S3Path; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"CreateFaq",
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"RoleArn" => RoleArn,
"S3Path" => S3Path,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_faq(
IndexId,
Name,
RoleArn,
S3Path,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateFaq",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"RoleArn" => RoleArn,
"S3Path" => S3Path,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_featured_results_set(featured_results_set_name, index_id)
create_featured_results_set(featured_results_set_name, index_id, params::Dict{String,<:Any})
Creates a set of featured results to display at the top of the search results page.
Featured results are placed above all other results for certain queries. You map specific
queries to specific documents for featuring in the results. If a query contains an exact
match, then one or more specific documents are featured in the search results. You can
create up to 50 sets of featured results per index. You can request to increase this limit
by contacting Support.
# Arguments
- `featured_results_set_name`: A name for the set of featured results.
- `index_id`: The identifier of the index that you want to use for featuring results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create a set of
featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client
token will create only one featured results set.
- `"Description"`: A description for the set of featured results.
- `"FeaturedDocuments"`: A list of document IDs for the documents you want to feature at
the top of the search results page. For more information on the list of documents, see
FeaturedResultsSet.
- `"QueryTexts"`: A list of queries for featuring results. For more information on the list
of queries, see FeaturedResultsSet.
- `"Status"`: The current status of the set of featured results. When the value is ACTIVE,
featured results are ready for use. You can still configure your settings before setting
the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the
UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique
per featured results set for each index, whether the status is ACTIVE or INACTIVE.
- `"Tags"`: A list of key-value pairs that identify or categorize the featured results set.
You can also use tags to help control access to the featured results set. Tag keys and
values can consist of Unicode letters, digits, white space, and any of the following
symbols:_ . : / = + - @.
"""
function create_featured_results_set(
FeaturedResultsSetName, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"CreateFeaturedResultsSet",
Dict{String,Any}(
"FeaturedResultsSetName" => FeaturedResultsSetName, "IndexId" => IndexId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_featured_results_set(
FeaturedResultsSetName,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateFeaturedResultsSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeaturedResultsSetName" => FeaturedResultsSetName, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_index(name, role_arn)
create_index(name, role_arn, params::Dict{String,<:Any})
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if
index creation has completed, check the Status field returned from a call to DescribeIndex.
The Status field is set to ACTIVE when the index is ready to use. Once the index is active,
you can index your documents using the BatchPutDocument API or using one of the supported
data sources. For an example of creating an index and data source using the Python SDK, see
Getting started with Python SDK. For an example of creating an index and data source using
the Java SDK, see Getting started with Java SDK.
# Arguments
- `name`: A name for the index.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role with permission to access your
Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon
Kendra.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create an index.
Multiple calls to the CreateIndex API with the same client token will create only one index.
- `"Description"`: A description for the index.
- `"Edition"`: The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for
indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for
production. Once you set the edition for an index, it can't be changed. The Edition
parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION. For
more information on quota limits for Enterprise and Developer editions, see Quotas.
- `"ServerSideEncryptionConfiguration"`: The identifier of the KMS customer managed key
(CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support
asymmetric CMKs.
- `"Tags"`: A list of key-value pairs that identify or categorize the index. You can also
use tags to help control access to the index. Tag keys and values can consist of Unicode
letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- `"UserContextPolicy"`: The user context policy. ATTRIBUTE_FILTER All indexed content is
searchable and displayable for all users. If you want to filter search results on user
context, you can use the attribute filters of _user_id and _group_ids or you can provide
user and group information in UserContext. USER_TOKEN Enables token-based user access
control to filter search results on user context. All documents with no access control and
all documents accessible to the user will be searchable and displayable.
- `"UserGroupResolutionConfiguration"`: Gets users and groups from IAM Identity Center
identity source. To configure this, see UserGroupResolutionConfiguration. This is useful
for user context filtering, where search results are filtered based on the user or their
group access to documents.
- `"UserTokenConfigurations"`: The user token configuration.
"""
function create_index(Name, RoleArn; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"CreateIndex",
Dict{String,Any}(
"Name" => Name, "RoleArn" => RoleArn, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_index(
Name,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateIndex",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "RoleArn" => RoleArn, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_query_suggestions_block_list(index_id, name, role_arn, source_s3_path)
create_query_suggestions_block_list(index_id, name, role_arn, source_s3_path, params::Dict{String,<:Any})
Creates a block list to exlcude certain queries from suggestions. Any query that contains
words or phrases specified in the block list is blocked or filtered out from being shown as
a suggestion. You need to provide the file location of your block list text file in your S3
bucket. In your text file, enter each block word or phrase on a separate line. For
information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services
GovCloud (US-West) region. For an example of creating a block list for query suggestions
using the Python SDK, see Query suggestions block list.
# Arguments
- `index_id`: The identifier of the index you want to create a query suggestions block list
for.
- `name`: A name for the block list. For example, the name 'offensive-words', which
includes all offensive words that could appear in user queries and need to be blocked from
suggestions.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role with permission to access your
S3 bucket that contains the block list text file. For more information, see IAM access
roles for Amazon Kendra.
- `source_s3_path`: The S3 path to your block list text file in your S3 bucket. Each block
word or phrase should be on a separate line in a text file. For information on the current
quota limits for block lists, see Quotas for Amazon Kendra.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create a query
suggestions block list.
- `"Description"`: A description for the block list. For example, the description \"List of
all offensive words that can appear in user queries and need to be blocked from
suggestions.\"
- `"Tags"`: A list of key-value pairs that identify or categorize the block list. Tag keys
and values can consist of Unicode letters, digits, white space, and any of the following
symbols: _ . : / = + - @.
"""
function create_query_suggestions_block_list(
IndexId, Name, RoleArn, SourceS3Path; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"CreateQuerySuggestionsBlockList",
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"RoleArn" => RoleArn,
"SourceS3Path" => SourceS3Path,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_query_suggestions_block_list(
IndexId,
Name,
RoleArn,
SourceS3Path,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateQuerySuggestionsBlockList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"RoleArn" => RoleArn,
"SourceS3Path" => SourceS3Path,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_thesaurus(index_id, name, role_arn, source_s3_path)
create_thesaurus(index_id, name, role_arn, source_s3_path, params::Dict{String,<:Any})
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an
index.
# Arguments
- `index_id`: The identifier of the index for the thesaurus.
- `name`: A name for the thesaurus.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role with permission to access your
S3 bucket that contains the thesaurus file. For more information, see IAM access roles for
Amazon Kendra.
- `source_s3_path`: The path to the thesaurus file in S3.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A token that you provide to identify the request to create a thesaurus.
Multiple calls to the CreateThesaurus API with the same client token will create only one
thesaurus.
- `"Description"`: A description for the thesaurus.
- `"Tags"`: A list of key-value pairs that identify or categorize the thesaurus. You can
also use tags to help control access to the thesaurus. Tag keys and values can consist of
Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
"""
function create_thesaurus(
IndexId, Name, RoleArn, SourceS3Path; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"CreateThesaurus",
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"RoleArn" => RoleArn,
"SourceS3Path" => SourceS3Path,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_thesaurus(
IndexId,
Name,
RoleArn,
SourceS3Path,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"CreateThesaurus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId,
"Name" => Name,
"RoleArn" => RoleArn,
"SourceS3Path" => SourceS3Path,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_control_configuration(id, index_id)
delete_access_control_configuration(id, index_id, params::Dict{String,<:Any})
Deletes an access control configuration that you created for your documents in an index.
This includes user and group access information for your documents. This is useful for user
context filtering, where search results are filtered based on the user or their group
access to documents.
# Arguments
- `id`: The identifier of the access control configuration you want to delete.
- `index_id`: The identifier of the index for an access control configuration.
"""
function delete_access_control_configuration(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DeleteAccessControlConfiguration",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_control_configuration(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeleteAccessControlConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_source(id, index_id)
delete_data_source(id, index_id, params::Dict{String,<:Any})
Deletes an Amazon Kendra data source connector. An exception is not thrown if the data
source is already being deleted. While the data source is being deleted, the Status field
returned by a call to the DescribeDataSource API is set to DELETING. For more information,
see Deleting Data Sources. Deleting an entire data source or re-syncing your index after
deleting specific documents from a data source could take up to an hour or more, depending
on the number of documents you want to delete.
# Arguments
- `id`: The identifier of the data source connector you want to delete.
- `index_id`: The identifier of the index used with the data source connector.
"""
function delete_data_source(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DeleteDataSource",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_source(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeleteDataSource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_experience(id, index_id)
delete_experience(id, index_id, params::Dict{String,<:Any})
Deletes your Amazon Kendra experience such as a search application. For more information on
creating a search application experience, see Building a search experience with no code.
# Arguments
- `id`: The identifier of your Amazon Kendra experience you want to delete.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
"""
function delete_experience(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DeleteExperience",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_experience(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeleteExperience",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_faq(id, index_id)
delete_faq(id, index_id, params::Dict{String,<:Any})
Removes an FAQ from an index.
# Arguments
- `id`: The identifier of the FAQ you want to remove.
- `index_id`: The identifier of the index for the FAQ.
"""
function delete_faq(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DeleteFaq",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_faq(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeleteFaq",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_index(id)
delete_index(id, params::Dict{String,<:Any})
Deletes an Amazon Kendra index. An exception is not thrown if the index is already being
deleted. While the index is being deleted, the Status field returned by a call to the
DescribeIndex API is set to DELETING.
# Arguments
- `id`: The identifier of the index you want to delete.
"""
function delete_index(Id; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DeleteIndex",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_index(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DeleteIndex",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_principal_mapping(group_id, index_id)
delete_principal_mapping(group_id, index_id, params::Dict{String,<:Any})
Deletes a group so that all users and sub groups that belong to the group can no longer
access documents only available to that group. For example, after deleting the group
\"Summer Interns\", all interns who belonged to that group no longer see intern-only
documents in their search results. If you want to delete or replace users or sub groups of
a group, you need to use the PutPrincipalMapping operation. For example, if a user in the
group \"Engineering\" leaves the engineering team and another user takes their place, you
provide an updated list of users or sub groups that belong to the \"Engineering\" group
when calling PutPrincipalMapping. You can update your internal list of users or sub groups
and input this list when calling PutPrincipalMapping. DeletePrincipalMapping is currently
not supported in the Amazon Web Services GovCloud (US-West) region.
# Arguments
- `group_id`: The identifier of the group you want to delete.
- `index_id`: The identifier of the index you want to delete a group from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceId"`: The identifier of the data source you want to delete a group from. A
group can be tied to multiple data sources. You can delete a group from accessing documents
in a certain data source. For example, the groups \"Research\", \"Engineering\", and
\"Sales and Marketing\" are all tied to the company's documents stored in the data sources
Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from
Salesforce, so that these groups cannot access customer-related documents stored in
Salesforce. Only \"Sales and Marketing\" should access documents in the Salesforce data
source.
- `"OrderingId"`: The timestamp identifier you specify to ensure Amazon Kendra does not
override the latest DELETE action with previous actions. The highest number ID, which is
the ordering ID, is the latest action you want to process and apply on top of other actions
with lower number IDs. This prevents previous actions with lower number IDs from possibly
overriding the latest action. The ordering ID can be the Unix time of the last update you
made to a group members list. You would then provide this list when calling
PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest
members list doesn't get overwritten by earlier DELETE actions for the same group which are
yet to be processed. The default ordering ID is the current Unix time in milliseconds that
the action was received by Amazon Kendra.
"""
function delete_principal_mapping(
GroupId, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DeletePrincipalMapping",
Dict{String,Any}("GroupId" => GroupId, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_principal_mapping(
GroupId,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeletePrincipalMapping",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GroupId" => GroupId, "IndexId" => IndexId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_query_suggestions_block_list(id, index_id)
delete_query_suggestions_block_list(id, index_id, params::Dict{String,<:Any})
Deletes a block list used for query suggestions for an index. A deleted block list might
not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to
add back the queries that were previously blocked. DeleteQuerySuggestionsBlockList is
currently not supported in the Amazon Web Services GovCloud (US-West) region.
# Arguments
- `id`: The identifier of the block list you want to delete.
- `index_id`: The identifier of the index for the block list.
"""
function delete_query_suggestions_block_list(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DeleteQuerySuggestionsBlockList",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_query_suggestions_block_list(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeleteQuerySuggestionsBlockList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_thesaurus(id, index_id)
delete_thesaurus(id, index_id, params::Dict{String,<:Any})
Deletes an Amazon Kendra thesaurus.
# Arguments
- `id`: The identifier of the thesaurus you want to delete.
- `index_id`: The identifier of the index for the thesaurus.
"""
function delete_thesaurus(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DeleteThesaurus",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_thesaurus(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DeleteThesaurus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_access_control_configuration(id, index_id)
describe_access_control_configuration(id, index_id, params::Dict{String,<:Any})
Gets information about an access control configuration that you created for your documents
in an index. This includes user and group access information for your documents. This is
useful for user context filtering, where search results are filtered based on the user or
their group access to documents.
# Arguments
- `id`: The identifier of the access control configuration you want to get information on.
- `index_id`: The identifier of the index for an access control configuration.
"""
function describe_access_control_configuration(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeAccessControlConfiguration",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_access_control_configuration(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeAccessControlConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_source(id, index_id)
describe_data_source(id, index_id, params::Dict{String,<:Any})
Gets information about an Amazon Kendra data source connector.
# Arguments
- `id`: The identifier of the data source connector.
- `index_id`: The identifier of the index used with the data source connector.
"""
function describe_data_source(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeDataSource",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_source(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeDataSource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_experience(id, index_id)
describe_experience(id, index_id, params::Dict{String,<:Any})
Gets information about your Amazon Kendra experience such as a search application. For more
information on creating a search application experience, see Building a search experience
with no code.
# Arguments
- `id`: The identifier of your Amazon Kendra experience you want to get information on.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
"""
function describe_experience(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DescribeExperience",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_experience(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeExperience",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_faq(id, index_id)
describe_faq(id, index_id, params::Dict{String,<:Any})
Gets information about an FAQ list.
# Arguments
- `id`: The identifier of the FAQ you want to get information on.
- `index_id`: The identifier of the index for the FAQ.
"""
function describe_faq(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DescribeFaq",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_faq(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeFaq",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_featured_results_set(featured_results_set_id, index_id)
describe_featured_results_set(featured_results_set_id, index_id, params::Dict{String,<:Any})
Gets information about a set of featured results. Features results are placed above all
other results for certain queries. If there's an exact match of a query, then one or more
specific documents are featured in the search results.
# Arguments
- `featured_results_set_id`: The identifier of the set of featured results that you want to
get information on.
- `index_id`: The identifier of the index used for featuring results.
"""
function describe_featured_results_set(
FeaturedResultsSetId, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeFeaturedResultsSet",
Dict{String,Any}(
"FeaturedResultsSetId" => FeaturedResultsSetId, "IndexId" => IndexId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_featured_results_set(
FeaturedResultsSetId,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeFeaturedResultsSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeaturedResultsSetId" => FeaturedResultsSetId, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_index(id)
describe_index(id, params::Dict{String,<:Any})
Gets information about an Amazon Kendra index.
# Arguments
- `id`: The identifier of the index you want to get information on.
"""
function describe_index(Id; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DescribeIndex",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_index(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeIndex",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_principal_mapping(group_id, index_id)
describe_principal_mapping(group_id, index_id, params::Dict{String,<:Any})
Describes the processing of PUT and DELETE actions for mapping users to their groups. This
includes information on the status of actions currently processing or yet to be processed,
when actions were last updated, when actions were received by Amazon Kendra, the latest
action that should process and apply after other actions, and useful error messages if an
action could not be processed. DescribePrincipalMapping is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
# Arguments
- `group_id`: The identifier of the group required to check the processing of PUT and
DELETE actions for mapping users to their groups.
- `index_id`: The identifier of the index required to check the processing of PUT and
DELETE actions for mapping users to their groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceId"`: The identifier of the data source to check the processing of PUT and
DELETE actions for mapping users to their groups.
"""
function describe_principal_mapping(
GroupId, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribePrincipalMapping",
Dict{String,Any}("GroupId" => GroupId, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_principal_mapping(
GroupId,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribePrincipalMapping",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GroupId" => GroupId, "IndexId" => IndexId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_query_suggestions_block_list(id, index_id)
describe_query_suggestions_block_list(id, index_id, params::Dict{String,<:Any})
Gets information about a block list used for query suggestions for an index. This is used
to check the current settings that are applied to a block list.
DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
# Arguments
- `id`: The identifier of the block list you want to get information on.
- `index_id`: The identifier of the index for the block list.
"""
function describe_query_suggestions_block_list(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeQuerySuggestionsBlockList",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_query_suggestions_block_list(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeQuerySuggestionsBlockList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_query_suggestions_config(index_id)
describe_query_suggestions_config(index_id, params::Dict{String,<:Any})
Gets information on the settings of query suggestions for an index. This is used to check
the current settings applied to query suggestions. DescribeQuerySuggestionsConfig is
currently not supported in the Amazon Web Services GovCloud (US-West) region.
# Arguments
- `index_id`: The identifier of the index with query suggestions that you want to get
information on.
"""
function describe_query_suggestions_config(
IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeQuerySuggestionsConfig",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_query_suggestions_config(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DescribeQuerySuggestionsConfig",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_thesaurus(id, index_id)
describe_thesaurus(id, index_id, params::Dict{String,<:Any})
Gets information about an Amazon Kendra thesaurus.
# Arguments
- `id`: The identifier of the thesaurus you want to get information on.
- `index_id`: The identifier of the index for the thesaurus.
"""
function describe_thesaurus(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"DescribeThesaurus",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_thesaurus(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DescribeThesaurus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_entities_from_experience(entity_list, id, index_id)
disassociate_entities_from_experience(entity_list, id, index_id, params::Dict{String,<:Any})
Prevents users or groups in your IAM Identity Center identity source from accessing your
Amazon Kendra experience. You can create an Amazon Kendra experience such as a search
application. For more information on creating a search application experience, see Building
a search experience with no code.
# Arguments
- `entity_list`: Lists users or groups in your IAM Identity Center identity source.
- `id`: The identifier of your Amazon Kendra experience.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
"""
function disassociate_entities_from_experience(
EntityList, Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DisassociateEntitiesFromExperience",
Dict{String,Any}("EntityList" => EntityList, "Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_entities_from_experience(
EntityList,
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DisassociateEntitiesFromExperience",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EntityList" => EntityList, "Id" => Id, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_personas_from_entities(entity_ids, id, index_id)
disassociate_personas_from_entities(entity_ids, id, index_id, params::Dict{String,<:Any})
Removes the specific permissions of users or groups in your IAM Identity Center identity
source with access to your Amazon Kendra experience. You can create an Amazon Kendra
experience such as a search application. For more information on creating a search
application experience, see Building a search experience with no code.
# Arguments
- `entity_ids`: The identifiers of users or groups in your IAM Identity Center identity
source. For example, user IDs could be user emails.
- `id`: The identifier of your Amazon Kendra experience.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
"""
function disassociate_personas_from_entities(
EntityIds, Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"DisassociatePersonasFromEntities",
Dict{String,Any}("EntityIds" => EntityIds, "Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_personas_from_entities(
EntityIds,
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"DisassociatePersonasFromEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EntityIds" => EntityIds, "Id" => Id, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_query_suggestions(index_id, query_text)
get_query_suggestions(index_id, query_text, params::Dict{String,<:Any})
Fetches the queries that are suggested to your users. GetQuerySuggestions is currently not
supported in the Amazon Web Services GovCloud (US-West) region.
# Arguments
- `index_id`: The identifier of the index you want to get query suggestions from.
- `query_text`: The text of a user's query to generate query suggestions. A query is
suggested if the query prefix matches what a user starts to type as their query. Amazon
Kendra does not show any suggestions if a user types fewer than two characters or more than
60 characters. A query must also have at least one search result and contain at least one
word of more than four characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeSuggestionsConfig"`: Configuration information for the document
fields/attributes that you want to base query suggestions on.
- `"MaxSuggestionsCount"`: The maximum number of query suggestions you want to show to your
users.
- `"SuggestionTypes"`: The suggestions type to base query suggestions on. The suggestion
types are query history or document fields/attributes. You can set one type or the other.
If you set query history as your suggestions type, Amazon Kendra suggests queries relevant
to your users based on popular queries in the query history. If you set document
fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your
users based on the contents of document fields.
"""
function get_query_suggestions(
IndexId, QueryText; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"GetQuerySuggestions",
Dict{String,Any}("IndexId" => IndexId, "QueryText" => QueryText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_query_suggestions(
IndexId,
QueryText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"GetQuerySuggestions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IndexId" => IndexId, "QueryText" => QueryText),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_snapshots(index_id, interval, metric_type)
get_snapshots(index_id, interval, metric_type, params::Dict{String,<:Any})
Retrieves search metrics data. The data provides a snapshot of how your users interact with
your search application and how effective the application is.
# Arguments
- `index_id`: The identifier of the index to get search metrics data.
- `interval`: The time interval or time window to get search metrics data. The time
interval uses the time zone of your index. You can view data in the following time windows:
THIS_WEEK: The current week, starting on the Sunday and ending on the day before the
current date. ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the
following Saturday. TWO_WEEKS_AGO: The week before the previous week, starting on the
Sunday and ending on the following Saturday. THIS_MONTH: The current month, starting on
the first day of the month and ending on the day before the current date. ONE_MONTH_AGO:
The previous month, starting on the first day of the month and ending on the last day of
the month. TWO_MONTHS_AGO: The month before the previous month, starting on the first
day of the month and ending on last day of the month.
- `metric_type`: The metric you want to retrieve. You can specify only one metric per call.
For more information about the metrics you can view, see Gaining insights with search
analytics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of returned data for the metric.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of search metrics data.
"""
function get_snapshots(
IndexId, Interval, MetricType; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"GetSnapshots",
Dict{String,Any}(
"IndexId" => IndexId, "Interval" => Interval, "MetricType" => MetricType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_snapshots(
IndexId,
Interval,
MetricType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"GetSnapshots",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IndexId" => IndexId, "Interval" => Interval, "MetricType" => MetricType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_control_configurations(index_id)
list_access_control_configurations(index_id, params::Dict{String,<:Any})
Lists one or more access control configurations for an index. This includes user and group
access information for your documents. This is useful for user context filtering, where
search results are filtered based on the user or their group access to documents.
# Arguments
- `index_id`: The identifier of the index for the access control configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of access control configurations to return.
- `"NextToken"`: If the previous response was incomplete (because there's more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of access control configurations.
"""
function list_access_control_configurations(
IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListAccessControlConfigurations",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_control_configurations(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListAccessControlConfigurations",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_source_sync_jobs(id, index_id)
list_data_source_sync_jobs(id, index_id, params::Dict{String,<:Any})
Gets statistics about synchronizing a data source connector.
# Arguments
- `id`: The identifier of the data source connector.
- `index_id`: The identifier of the index used with the data source connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of synchronization jobs to return in the response. If
there are fewer results in the list, this response contains only the actual results.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of jobs.
- `"StartTimeFilter"`: When specified, the synchronization jobs returned in the list are
limited to jobs between the specified dates.
- `"StatusFilter"`: Only returns synchronization jobs with the Status field equal to the
specified status.
"""
function list_data_source_sync_jobs(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListDataSourceSyncJobs",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_source_sync_jobs(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"ListDataSourceSyncJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sources(index_id)
list_data_sources(index_id, params::Dict{String,<:Any})
Lists the data source connectors that you have created.
# Arguments
- `index_id`: The identifier of the index used with one or more data source connectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of data source connectors to return.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of data source connectors.
"""
function list_data_sources(IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"ListDataSources",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sources(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListDataSources",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entity_personas(id, index_id)
list_entity_personas(id, index_id, params::Dict{String,<:Any})
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
# Arguments
- `id`: The identifier of your Amazon Kendra experience.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of returned users or groups.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of users or groups.
"""
function list_entity_personas(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListEntityPersonas",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_entity_personas(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"ListEntityPersonas",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_experience_entities(id, index_id)
list_experience_entities(id, index_id, params::Dict{String,<:Any})
Lists users or groups in your IAM Identity Center identity source that are granted access
to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a
search application. For more information on creating a search application experience, see
Building a search experience with no code.
# Arguments
- `id`: The identifier of your Amazon Kendra experience.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of users or groups.
"""
function list_experience_entities(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListExperienceEntities",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_experience_entities(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"ListExperienceEntities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_experiences(index_id)
list_experiences(index_id, params::Dict{String,<:Any})
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience
such as a search application. For more information on creating a search application
experience, see Building a search experience with no code.
# Arguments
- `index_id`: The identifier of the index for your Amazon Kendra experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of returned Amazon Kendra experiences.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Kendra experiences.
"""
function list_experiences(IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"ListExperiences",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_experiences(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListExperiences",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_faqs(index_id)
list_faqs(index_id, params::Dict{String,<:Any})
Gets a list of FAQ lists associated with an index.
# Arguments
- `index_id`: The index that contains the FAQ lists.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of FAQs to return in the response. If there are fewer
results in the list, this response contains only the actual results.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of FAQs.
"""
function list_faqs(IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"ListFaqs",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_faqs(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListFaqs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_featured_results_sets(index_id)
list_featured_results_sets(index_id, params::Dict{String,<:Any})
Lists all your sets of featured results for a given index. Features results are placed
above all other results for certain queries. If there's an exact match of a query, then one
or more specific documents are featured in the search results.
# Arguments
- `index_id`: The identifier of the index used for featuring results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of featured results sets to return.
- `"NextToken"`: If the response is truncated, Amazon Kendra returns a pagination token in
the response. You can use this pagination token to retrieve the next set of featured
results sets.
"""
function list_featured_results_sets(
IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListFeaturedResultsSets",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_featured_results_sets(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListFeaturedResultsSets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups_older_than_ordering_id(index_id, ordering_id)
list_groups_older_than_ordering_id(index_id, ordering_id, params::Dict{String,<:Any})
Provides a list of groups that are mapped to users before a given ordering or timestamp
identifier. ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
# Arguments
- `index_id`: The identifier of the index for getting a list of groups mapped to users
before a given ordering or timestamp identifier.
- `ordering_id`: The timestamp identifier used for the latest PUT or DELETE action for
mapping users to their groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceId"`: The identifier of the data source for getting a list of groups mapped
to users before a given ordering timestamp identifier.
- `"MaxResults"`: The maximum number of returned groups that are mapped to users before a
given ordering or timestamp identifier.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of groups that are mapped to users before a given
ordering or timestamp identifier.
"""
function list_groups_older_than_ordering_id(
IndexId, OrderingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListGroupsOlderThanOrderingId",
Dict{String,Any}("IndexId" => IndexId, "OrderingId" => OrderingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_groups_older_than_ordering_id(
IndexId,
OrderingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"ListGroupsOlderThanOrderingId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IndexId" => IndexId, "OrderingId" => OrderingId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_indices()
list_indices(params::Dict{String,<:Any})
Lists the Amazon Kendra indexes that you created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of indices to return.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of indexes.
"""
function list_indices(; aws_config::AbstractAWSConfig=global_aws_config())
return kendra("ListIndices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_indices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListIndices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_query_suggestions_block_lists(index_id)
list_query_suggestions_block_lists(index_id, params::Dict{String,<:Any})
Lists the block lists used for query suggestions for an index. For information on the
current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
# Arguments
- `index_id`: The identifier of the index for a list of all block lists that exist for that
index. For information on the current quota limits for block lists, see Quotas for Amazon
Kendra.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of block lists to return.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of block lists (BlockListSummaryItems).
"""
function list_query_suggestions_block_lists(
IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListQuerySuggestionsBlockLists",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_query_suggestions_block_lists(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListQuerySuggestionsBlockLists",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources
can have tags associated with them.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a
list of tags for.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thesauri(index_id)
list_thesauri(index_id, params::Dict{String,<:Any})
Lists the thesauri for an index.
# Arguments
- `index_id`: The identifier of the index with one or more thesauri.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of thesauri to return.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You can use this
pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems).
"""
function list_thesauri(IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"ListThesauri",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_thesauri(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"ListThesauri",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_principal_mapping(group_id, group_members, index_id)
put_principal_mapping(group_id, group_members, index_id, params::Dict{String,<:Any})
Maps users to their groups so that you only need to provide the user ID when you issue the
query. You can also map sub groups to groups. For example, the group \"Company Intellectual
Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups
include their own list of users or people who work in these teams. Only users who work in
research and engineering, and therefore belong in the intellectual property group, can see
top-secret company documents in their search results. This is useful for user context
filtering, where search results are filtered based on the user or their group access to
documents. For more information, see Filtering on user context. If more than five PUT
actions for a group are currently processing, a validation exception is thrown.
# Arguments
- `group_id`: The identifier of the group you want to map its users to.
- `group_members`: The list that contains your users or sub groups that belong the same
group. For example, the group \"Company\" includes the user \"CEO\" and the sub groups
\"Research\", \"Engineering\", and \"Sales and Marketing\". If you have more than 1000
users and/or sub groups for a single group, you need to provide the path to the S3 file
that lists your users and sub groups for a group. Your sub groups can contain more than
1000 users, but the list of sub groups that belong to a group (and/or users) must be no
more than 1000.
- `index_id`: The identifier of the index you want to map users to their groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceId"`: The identifier of the data source you want to map users to their
groups. This is useful if a group is tied to multiple data sources, but you only want the
group to access documents of a certain data source. For example, the groups \"Research\",
\"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored
in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only
needs access to customer-related documents stored in Salesforce.
- `"OrderingId"`: The timestamp identifier you specify to ensure Amazon Kendra does not
override the latest PUT action with previous actions. The highest number ID, which is the
ordering ID, is the latest action you want to process and apply on top of other actions
with lower number IDs. This prevents previous actions with lower number IDs from possibly
overriding the latest action. The ordering ID can be the Unix time of the last update you
made to a group members list. You would then provide this list when calling
PutPrincipalMapping. This ensures your PUT action for that updated group with the latest
members list doesn't get overwritten by earlier PUT actions for the same group which are
yet to be processed. The default ordering ID is the current Unix time in milliseconds that
the action was received by Amazon Kendra.
- `"RoleArn"`: The Amazon Resource Name (ARN) of a role that has access to the S3 file that
contains your list of users or sub groups that belong to a group. For more information, see
IAM roles for Amazon Kendra.
"""
function put_principal_mapping(
GroupId, GroupMembers, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"PutPrincipalMapping",
Dict{String,Any}(
"GroupId" => GroupId, "GroupMembers" => GroupMembers, "IndexId" => IndexId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_principal_mapping(
GroupId,
GroupMembers,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"PutPrincipalMapping",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId,
"GroupMembers" => GroupMembers,
"IndexId" => IndexId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query(index_id)
query(index_id, params::Dict{String,<:Any})
Searches an index given an input query. If you are working with large language models
(LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon
Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend
using the Retrieve API instead of filing a service limit increase to increase the Query API
document excerpt length. You can configure boosting or relevance tuning at the query level
to override boosting at the index level, filter based on document fields/attributes and
faceted search, and filter based on the user or their group access to documents. You can
also include certain fields in the response that might provide useful additional
information. A query response contains three types of results. Relevant suggested
answers. The answers can be either a text excerpt or table excerpt. The answer can be
highlighted in the excerpt. Matching FAQs or questions-answer from your FAQ file.
Relevant documents. This result type includes an excerpt of the document with the document
title. The searched terms can be highlighted in the excerpt. You can specify that the
query return only one type of result using the QueryResultTypeFilter parameter. Each query
returns the 100 most relevant results. If you filter result type to only question-answers,
a maximum of four results are returned. If you filter result type to only answers, a
maximum of three results are returned.
# Arguments
- `index_id`: The identifier of the index for the search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeFilter"`: Filters search results by document fields/attributes. You can only
provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters
parameters contain a list of other filters. The AttributeFilter parameter means you can
create a set of filtering rules that a document must satisfy to be included in the query
results.
- `"CollapseConfiguration"`: Provides configuration to determine how to group results by
document attribute value, and how to display them (collapsed or expanded) under a
designated primary document for each group.
- `"DocumentRelevanceOverrideConfigurations"`: Overrides relevance tuning configurations of
fields/attributes set at the index level. If you use this API to override the relevance
tuning configured at the index level, but there is no relevance tuning configured at the
index level, then Amazon Kendra does not apply any relevance tuning. If there is relevance
tuning configured for fields at the index level, and you use this API to override only some
of these fields, then for the fields you did not override, the importance is set to 1.
- `"Facets"`: An array of documents fields/attributes for faceted search. Amazon Kendra
returns a count for each field key specified. This helps your users narrow their search.
- `"PageNumber"`: Query results are returned in pages the size of the PageSize parameter.
By default, Amazon Kendra returns the first page of results. Use this parameter to get
result pages after the first one.
- `"PageSize"`: Sets the number of results that are returned in each page of results. The
default page size is 10. The maximum number of results returned is 100. If you ask for more
than 100 results, only 100 are returned.
- `"QueryResultTypeFilter"`: Sets the type of query result or response. Only results for
the specified type are returned.
- `"QueryText"`: The input query text for the search. Amazon Kendra truncates queries at 30
token words, which excludes punctuation and stop words. Truncation still applies if you use
Boolean or more advanced, complex queries. For example, Timeoff AND October AND Category:HR
is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with
advanced query syntax in the Amazon Kendra Developer Guide.
- `"RequestedDocumentAttributes"`: An array of document fields/attributes to include in the
response. You can limit the response to include certain document fields. By default, all
document attributes are included in the response.
- `"SortingConfiguration"`: Provides information that determines how the results of the
query are sorted. You can set the field that Amazon Kendra should sort the results on, and
specify whether the results should be sorted in ascending or descending order. In the case
of ties in sorting the results, the results are sorted by relevance. If you don't provide
sorting configuration, the results are sorted by the relevance that Amazon Kendra
determines for the result.
- `"SortingConfigurations"`: Provides configuration information to determine how the
results of a query are sorted. You can set upto 3 fields that Amazon Kendra should sort the
results on, and specify whether the results should be sorted in ascending or descending
order. The sort field quota can be increased. If you don't provide a sorting configuration,
the results are sorted by the relevance that Amazon Kendra determines for the result. In
the case of ties in sorting the results, the results are sorted by relevance.
- `"SpellCorrectionConfiguration"`: Enables suggested spell corrections for queries.
- `"UserContext"`: The user context token or user and group information.
- `"VisitorId"`: Provides an identifier for a specific user. The VisitorId should be a
unique identifier, such as a GUID. Don't use personally identifiable information, such as
the user's email address, as the VisitorId.
"""
function query(IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"Query",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"Query",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retrieve(index_id, query_text)
retrieve(index_id, query_text, params::Dict{String,<:Any})
Retrieves relevant passages or text excerpts given an input query. This API is similar to
the Query API. However, by default, the Query API only returns excerpt passages of up to
100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token
words and up to 100 semantically relevant passages. This doesn't include question-answer or
FAQ type responses from your index. The passages are text excerpts that can be semantically
extracted from multiple documents and multiple parts of the same document. If in extreme
cases your documents produce zero passages using the Retrieve API, you can alternatively
use the Query API and its types of responses. You can also do the following: Override
boosting at the index level Filter based on document fields or attributes Filter based
on the user or their group access to documents View the confidence score bucket for a
retrieved passage result. The confidence bucket provides a relative ranking that indicates
how confident Amazon Kendra is that the response is relevant to the query. Confidence
score buckets are currently available only for English. You can also include certain
fields in the response that might provide useful additional information. The Retrieve API
shares the number of query capacity units that you set for your index. For more information
on what's included in a single capacity unit and the default base capacity for an index,
see Adjusting capacity.
# Arguments
- `index_id`: The identifier of the index to retrieve relevant passages for the search.
- `query_text`: The input query text to retrieve relevant passages for the search. Amazon
Kendra truncates queries at 30 token words, which excludes punctuation and stop words.
Truncation still applies if you use Boolean or more advanced, complex queries. For example,
Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october, hr. For more
information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeFilter"`: Filters search results by document fields/attributes. You can only
provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters
parameters contain a list of other filters. The AttributeFilter parameter means you can
create a set of filtering rules that a document must satisfy to be included in the query
results.
- `"DocumentRelevanceOverrideConfigurations"`: Overrides relevance tuning configurations of
fields/attributes set at the index level. If you use this API to override the relevance
tuning configured at the index level, but there is no relevance tuning configured at the
index level, then Amazon Kendra does not apply any relevance tuning. If there is relevance
tuning configured for fields at the index level, and you use this API to override only some
of these fields, then for the fields you did not override, the importance is set to 1.
- `"PageNumber"`: Retrieved relevant passages are returned in pages the size of the
PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this
parameter to get result pages after the first one.
- `"PageSize"`: Sets the number of retrieved relevant passages that are returned in each
page of results. The default page size is 10. The maximum number of results returned is
100. If you ask for more than 100 results, only 100 are returned.
- `"RequestedDocumentAttributes"`: A list of document fields/attributes to include in the
response. You can limit the response to include certain document fields. By default, all
document fields are included in the response.
- `"UserContext"`: The user context token or user and group information.
"""
function retrieve(IndexId, QueryText; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"Retrieve",
Dict{String,Any}("IndexId" => IndexId, "QueryText" => QueryText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retrieve(
IndexId,
QueryText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"Retrieve",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IndexId" => IndexId, "QueryText" => QueryText),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_data_source_sync_job(id, index_id)
start_data_source_sync_job(id, index_id, params::Dict{String,<:Any})
Starts a synchronization job for a data source connector. If a synchronization job is
already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing
your data source with your index after modifying, adding, or deleting documents from your
data source respository could take up to an hour or more, depending on the number of
documents to sync.
# Arguments
- `id`: The identifier of the data source connector to synchronize.
- `index_id`: The identifier of the index used with the data source connector.
"""
function start_data_source_sync_job(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"StartDataSourceSyncJob",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_data_source_sync_job(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"StartDataSourceSyncJob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_data_source_sync_job(id, index_id)
stop_data_source_sync_job(id, index_id, params::Dict{String,<:Any})
Stops a synchronization job that is currently running. You can't stop a scheduled
synchronization job.
# Arguments
- `id`: The identifier of the data source connector for which to stop the synchronization
jobs.
- `index_id`: The identifier of the index used with the data source connector.
"""
function stop_data_source_sync_job(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"StopDataSourceSyncJob",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_data_source_sync_job(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"StopDataSourceSyncJob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_feedback(index_id, query_id)
submit_feedback(index_id, query_id, params::Dict{String,<:Any})
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
# Arguments
- `index_id`: The identifier of the index that was queried.
- `query_id`: The identifier of the specific query for which you are submitting feedback.
The query ID is returned in the response to the Query API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClickFeedbackItems"`: Tells Amazon Kendra that a particular search result link was
chosen by the user.
- `"RelevanceFeedbackItems"`: Provides Amazon Kendra with relevant or not relevant feedback
for whether a particular item was relevant to the search.
"""
function submit_feedback(
IndexId, QueryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"SubmitFeedback",
Dict{String,Any}("IndexId" => IndexId, "QueryId" => QueryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function submit_feedback(
IndexId,
QueryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"SubmitFeedback",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("IndexId" => IndexId, "QueryId" => QueryId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag
already exists, the existing value is replaced with the new value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.
- `tags`: A list of tag keys to add to the index, FAQ, or data source. If a tag already
exists, the existing value is replaced with the new value.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"TagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from an index, FAQ, or a data source.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the index, FAQ, or data source to
remove the tag from.
- `tag_keys`: A list of tag keys to remove from the index, FAQ, or data source. If a tag
key does not exist on the resource, it is ignored.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UntagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_access_control_configuration(id, index_id)
update_access_control_configuration(id, index_id, params::Dict{String,<:Any})
Updates an access control configuration for your documents in an index. This includes user
and group access information for your documents. This is useful for user context filtering,
where search results are filtered based on the user or their group access to documents. You
can update an access control configuration you created without indexing all of your
documents again. For example, your index contains top-secret company documents that only
certain employees or users should access. You created an 'allow' access control
configuration for one user who recently joined the 'top-secret' team, switching from a team
with 'deny' access to top-secret documents. However, the user suddenly returns to their
previous team and should no longer have access to top secret documents. You can update the
access control configuration to re-configure access control for your documents as
circumstances change. You call the BatchPutDocument API to apply the updated access control
configuration, with the AccessControlConfigurationId included in the Document object. If
you use an S3 bucket as a data source, you synchronize your data source to apply the
AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only
supports access control configuration for S3 data sources and documents indexed using the
BatchPutDocument API.
# Arguments
- `id`: The identifier of the access control configuration you want to update.
- `index_id`: The identifier of the index for an access control configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessControlList"`: Information you want to update on principals (users and/or groups)
and which documents they should have access to. This is useful for user context filtering,
where search results are filtered based on the user or their group access to documents.
- `"Description"`: A new description for the access control configuration.
- `"HierarchicalAccessControlList"`: The updated list of principal lists that define the
hierarchy for which documents users should have access to.
- `"Name"`: A new name for the access control configuration.
"""
function update_access_control_configuration(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UpdateAccessControlConfiguration",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_control_configuration(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UpdateAccessControlConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_source(id, index_id)
update_data_source(id, index_id, params::Dict{String,<:Any})
Updates an Amazon Kendra data source connector.
# Arguments
- `id`: The identifier of the data source connector you want to update.
- `index_id`: The identifier of the index used with the data source connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: Configuration information you want to update for the data source
connector.
- `"CustomDocumentEnrichmentConfiguration"`: Configuration information you want to update
for altering document metadata and content during the document ingestion process. For more
information on how to create, modify and delete document metadata, or make other content
alterations when you ingest documents into Amazon Kendra, see Customizing document metadata
during the ingestion process.
- `"Description"`: A new description for the data source connector.
- `"LanguageCode"`: The code for a language you want to update for the data source
connector. This allows you to support a language for all documents when updating the data
source. English is supported by default. For more information on supported languages,
including their codes, see Adding documents in languages other than English.
- `"Name"`: A new name for the data source connector.
- `"RoleArn"`: The Amazon Resource Name (ARN) of a role with permission to access the data
source and required resources. For more information, see IAM roles for Amazon Kendra.
- `"Schedule"`: The sync schedule you want to update for the data source connector.
- `"VpcConfiguration"`: Configuration information for an Amazon Virtual Private Cloud to
connect to your data source. For more information, see Configuring a VPC.
"""
function update_data_source(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"UpdateDataSource",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UpdateDataSource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_experience(id, index_id)
update_experience(id, index_id, params::Dict{String,<:Any})
Updates your Amazon Kendra experience such as a search application. For more information on
creating a search application experience, see Building a search experience with no code.
# Arguments
- `id`: The identifier of your Amazon Kendra experience you want to update.
- `index_id`: The identifier of the index for your Amazon Kendra experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: Configuration information you want to update for your Amazon Kendra
experience.
- `"Description"`: A new description for your Amazon Kendra experience.
- `"Name"`: A new name for your Amazon Kendra experience.
- `"RoleArn"`: The Amazon Resource Name (ARN) of a role with permission to access Query
API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your
user and group information. For more information, see IAM roles for Amazon Kendra.
"""
function update_experience(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"UpdateExperience",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_experience(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UpdateExperience",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_featured_results_set(featured_results_set_id, index_id)
update_featured_results_set(featured_results_set_id, index_id, params::Dict{String,<:Any})
Updates a set of featured results. Features results are placed above all other results for
certain queries. You map specific queries to specific documents for featuring in the
results. If a query contains an exact match of a query, then one or more specific documents
are featured in the search results.
# Arguments
- `featured_results_set_id`: The identifier of the set of featured results that you want to
update.
- `index_id`: The identifier of the index used for featuring results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description for the set of featured results.
- `"FeaturedDocuments"`: A list of document IDs for the documents you want to feature at
the top of the search results page. For more information on the list of featured documents,
see FeaturedResultsSet.
- `"FeaturedResultsSetName"`: A new name for the set of featured results.
- `"QueryTexts"`: A list of queries for featuring results. For more information on the list
of queries, see FeaturedResultsSet.
- `"Status"`: You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE,
featured results are ready for use. You can still configure your settings before setting
the status to ACTIVE. The queries you specify for featured results must be unique per
featured results set for each index, whether the status is ACTIVE or INACTIVE.
"""
function update_featured_results_set(
FeaturedResultsSetId, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UpdateFeaturedResultsSet",
Dict{String,Any}(
"FeaturedResultsSetId" => FeaturedResultsSetId, "IndexId" => IndexId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_featured_results_set(
FeaturedResultsSetId,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UpdateFeaturedResultsSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeaturedResultsSetId" => FeaturedResultsSetId, "IndexId" => IndexId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_index(id)
update_index(id, params::Dict{String,<:Any})
Updates an Amazon Kendra index.
# Arguments
- `id`: The identifier of the index you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityUnits"`: Sets the number of additional document storage and query capacity
units that should be used by the index. You can change the capacity of the index up to 5
times per day, or make 5 API calls. If you are using extra storage units, you can't reduce
the storage capacity below what is required to meet the storage needs for your index.
- `"Description"`: A new description for the index.
- `"DocumentMetadataConfigurationUpdates"`: The document metadata configuration you want to
update for the index. Document metadata are fields or attributes associated with your
documents. For example, the company department name associated with each document.
- `"Name"`: A new name for the index.
- `"RoleArn"`: An Identity and Access Management (IAM) role that gives Amazon Kendra
permission to access Amazon CloudWatch logs and metrics.
- `"UserContextPolicy"`: The user context policy.
- `"UserGroupResolutionConfiguration"`: Gets users and groups from IAM Identity Center
identity source. To configure this, see UserGroupResolutionConfiguration. This is useful
for user context filtering, where search results are filtered based on the user or their
group access to documents.
- `"UserTokenConfigurations"`: The user token configuration.
"""
function update_index(Id; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"UpdateIndex",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_index(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UpdateIndex",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_query_suggestions_block_list(id, index_id)
update_query_suggestions_block_list(id, index_id, params::Dict{String,<:Any})
Updates a block list used for query suggestions for an index. Updates to a block list might
not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to
apply any updates to the block list. Other changes not related to the block list apply
immediately. If a block list is updating, then you need to wait for the first update to
finish before submitting another update. Amazon Kendra supports partial updates, so you
only need to provide the fields you want to update. UpdateQuerySuggestionsBlockList is
currently not supported in the Amazon Web Services GovCloud (US-West) region.
# Arguments
- `id`: The identifier of the block list you want to update.
- `index_id`: The identifier of the index for the block list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description for the block list.
- `"Name"`: A new name for the block list.
- `"RoleArn"`: The IAM (Identity and Access Management) role used to access the block list
text file in S3.
- `"SourceS3Path"`: The S3 path where your block list text file sits in S3. If you update
your block list and provide the same path to the block list text file in S3, then Amazon
Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically
refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to
refresh you block list. If you update your block list, then Amazon Kendra asynchronously
refreshes all query suggestions with the latest content in the S3 file. This means changes
might not take effect immediately.
"""
function update_query_suggestions_block_list(
Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UpdateQuerySuggestionsBlockList",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_query_suggestions_block_list(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UpdateQuerySuggestionsBlockList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_query_suggestions_config(index_id)
update_query_suggestions_config(index_id, params::Dict{String,<:Any})
Updates the settings of query suggestions for an index. Amazon Kendra supports partial
updates, so you only need to provide the fields you want to update. If an update is
currently processing, you need to wait for the update to finish before making another
update. Updates to query suggestions settings might not take effect right away. The time
for your updated settings to take effect depends on the updates made and the number of
search queries in your index. You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
# Arguments
- `index_id`: The identifier of the index with query suggestions you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeSuggestionsConfig"`: Configuration information for the document
fields/attributes that you want to base query suggestions on.
- `"IncludeQueriesWithoutUserInformation"`: TRUE to include queries without user
information (i.e. all queries, irrespective of the user), otherwise FALSE to only include
queries with user information. If you pass user information to Amazon Kendra along with the
queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries
with user information. If you set to FALSE, Amazon Kendra only considers queries searched
at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
suggestions. If you set to TRUE, Amazon Kendra ignores all user information and learns from
all queries.
- `"MinimumNumberOfQueryingUsers"`: The minimum number of unique users who must search a
query in order for the query to be eligible to suggest to your users. Increasing this
number might decrease the number of suggestions. However, this ensures a query is searched
by many users and is truly popular to suggest to users. How you tune this setting depends
on your specific needs.
- `"MinimumQueryCount"`: The the minimum number of times a query must be searched in order
to be eligible to suggest to your users. Decreasing this number increases the number of
suggestions. However, this affects the quality of suggestions as it sets a low bar for a
query to be considered popular to suggest to users. How you tune this setting depends on
your specific needs.
- `"Mode"`: Set the mode to ENABLED or LEARN_ONLY. By default, Amazon Kendra enables query
suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update
this at any time. In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to
keep suggestions up to date for when you are ready to switch to ENABLED mode again.
- `"QueryLogLookBackWindowInDays"`: How recent your queries are in your query log time
window. The time window is the number of days from current day to past days. By default,
Amazon Kendra sets this to 180.
"""
function update_query_suggestions_config(
IndexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UpdateQuerySuggestionsConfig",
Dict{String,Any}("IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_query_suggestions_config(
IndexId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra(
"UpdateQuerySuggestionsConfig",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IndexId" => IndexId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_thesaurus(id, index_id)
update_thesaurus(id, index_id, params::Dict{String,<:Any})
Updates a thesaurus for an index.
# Arguments
- `id`: The identifier of the thesaurus you want to update.
- `index_id`: The identifier of the index for the thesaurus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description for the thesaurus.
- `"Name"`: A new name for the thesaurus.
- `"RoleArn"`: An IAM role that gives Amazon Kendra permissions to access thesaurus file
specified in SourceS3Path.
- `"SourceS3Path"`:
"""
function update_thesaurus(Id, IndexId; aws_config::AbstractAWSConfig=global_aws_config())
return kendra(
"UpdateThesaurus",
Dict{String,Any}("Id" => Id, "IndexId" => IndexId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_thesaurus(
Id,
IndexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra(
"UpdateThesaurus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "IndexId" => IndexId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 13186 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kendra_ranking
using AWS.Compat
using AWS.UUIDs
"""
create_rescore_execution_plan(name)
create_rescore_execution_plan(name, params::Dict{String,<:Any})
Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent
Ranking resource used for provisioning the Rescore API. You set the number of capacity
units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search
service's results. For an example of using the CreateRescoreExecutionPlan API, including
using the Python and Java SDKs, see Semantically ranking a search service's results.
# Arguments
- `name`: A name for the rescore execution plan.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityUnits"`: You can set additional capacity units to meet the needs of your
rescore execution plan. You are given a single capacity unit by default. If you want to use
the default capacity, you don't set additional capacity units. For more information on the
default capacity and additional capacity units, see Adjusting capacity.
- `"ClientToken"`: A token that you provide to identify the request to create a rescore
execution plan. Multiple calls to the CreateRescoreExecutionPlanRequest API with the same
client token will create only one rescore execution plan.
- `"Description"`: A description for the rescore execution plan.
- `"Tags"`: A list of key-value pairs that identify or categorize your rescore execution
plan. You can also use tags to help control access to the rescore execution plan. Tag keys
and values can consist of Unicode letters, digits, white space, and any of the following
symbols: _ . : / = + - @.
"""
function create_rescore_execution_plan(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"CreateRescoreExecutionPlan",
Dict{String,Any}("Name" => Name, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rescore_execution_plan(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"CreateRescoreExecutionPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rescore_execution_plan(id)
delete_rescore_execution_plan(id, params::Dict{String,<:Any})
Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent
Ranking resource used for provisioning the Rescore API.
# Arguments
- `id`: The identifier of the rescore execution plan that you want to delete.
"""
function delete_rescore_execution_plan(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"DeleteRescoreExecutionPlan",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rescore_execution_plan(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"DeleteRescoreExecutionPlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rescore_execution_plan(id)
describe_rescore_execution_plan(id, params::Dict{String,<:Any})
Gets information about a rescore execution plan. A rescore execution plan is an Amazon
Kendra Intelligent Ranking resource used for provisioning the Rescore API.
# Arguments
- `id`: The identifier of the rescore execution plan that you want to get information on.
"""
function describe_rescore_execution_plan(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"DescribeRescoreExecutionPlan",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_rescore_execution_plan(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"DescribeRescoreExecutionPlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rescore_execution_plans()
list_rescore_execution_plans(params::Dict{String,<:Any})
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra
Intelligent Ranking resource used for provisioning the Rescore API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of rescore execution plans to return.
- `"NextToken"`: If the response is truncated, Amazon Kendra Intelligent Ranking returns a
pagination token in the response. You can use this pagination token to retrieve the next
set of rescore execution plans.
"""
function list_rescore_execution_plans(; aws_config::AbstractAWSConfig=global_aws_config())
return kendra_ranking(
"ListRescoreExecutionPlans"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rescore_execution_plans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"ListRescoreExecutionPlans",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets a list of tags associated with a specified resource. A rescore execution plan is an
example of a resource that can have tags associated with it.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rescore execution plan to get a
list of tags for.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra_ranking(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rescore(documents, rescore_execution_plan_id, search_query)
rescore(documents, rescore_execution_plan_id, search_query, params::Dict{String,<:Any})
Rescores or re-ranks search results from a search service such as OpenSearch (self
managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to
improve the search service's results.
# Arguments
- `documents`: The list of documents for Amazon Kendra Intelligent Ranking to rescore or
rank on.
- `rescore_execution_plan_id`: The identifier of the rescore execution plan. A rescore
execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore API.
- `search_query`: The input query from the search service.
"""
function rescore(
Documents,
RescoreExecutionPlanId,
SearchQuery;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra_ranking(
"Rescore",
Dict{String,Any}(
"Documents" => Documents,
"RescoreExecutionPlanId" => RescoreExecutionPlanId,
"SearchQuery" => SearchQuery,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rescore(
Documents,
RescoreExecutionPlanId,
SearchQuery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra_ranking(
"Rescore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Documents" => Documents,
"RescoreExecutionPlanId" => RescoreExecutionPlanId,
"SearchQuery" => SearchQuery,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an
Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the
tag already exists, the existing value is replaced with the new value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rescore execution plan to tag.
- `tags`: A list of tag keys to add to a rescore execution plan. If a tag already exists,
the existing value is replaced with the new value.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kendra_ranking(
"TagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra_ranking(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra
Intelligent Ranking resource used for provisioning the Rescore operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rescore execution plan to remove
the tag.
- `tag_keys`: A list of tag keys to remove from the rescore execution plan. If a tag key
does not exist on the resource, it is ignored.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"UntagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kendra_ranking(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rescore_execution_plan(id)
update_rescore_execution_plan(id, params::Dict{String,<:Any})
Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent
Ranking resource used for provisioning the Rescore API. You can update the number of
capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a
search service's results.
# Arguments
- `id`: The identifier of the rescore execution plan that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityUnits"`: You can set additional capacity units to meet the needs of your
rescore execution plan. You are given a single capacity unit by default. If you want to use
the default capacity, you don't set additional capacity units. For more information on the
default capacity and additional capacity units, see Adjusting capacity.
- `"Description"`: A new description for the rescore execution plan.
- `"Name"`: A new name for the rescore execution plan.
"""
function update_rescore_execution_plan(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"UpdateRescoreExecutionPlan",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rescore_execution_plan(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kendra_ranking(
"UpdateRescoreExecutionPlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 32851 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: keyspaces
using AWS.Compat
using AWS.UUIDs
"""
create_keyspace(keyspace_name)
create_keyspace(keyspace_name, params::Dict{String,<:Any})
The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services
account, keyspace names must be unique within each Region. CreateKeyspace is an
asynchronous operation. You can monitor the creation status of the new keyspace by using
the GetKeyspace operation. For more information, see Creating keyspaces in the Amazon
Keyspaces Developer Guide.
# Arguments
- `keyspace_name`: The name of the keyspace to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"replicationSpecification"`: The replication specification of the keyspace includes:
replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION. regionList -
if the replicationStrategy is MULTI_REGION, the regionList requires the current Region and
at least one additional Amazon Web Services Region where the keyspace is going to be
replicated in. The maximum number of supported replication Regions including the current
Region is six.
- `"tags"`: A list of key-value pair tags to be attached to the keyspace. For more
information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon
Keyspaces Developer Guide.
"""
function create_keyspace(keyspaceName; aws_config::AbstractAWSConfig=global_aws_config())
return keyspaces(
"CreateKeyspace",
Dict{String,Any}("keyspaceName" => keyspaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_keyspace(
keyspaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"CreateKeyspace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyspaceName" => keyspaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_table(keyspace_name, schema_definition, table_name)
create_table(keyspace_name, schema_definition, table_name, params::Dict{String,<:Any})
The CreateTable operation adds a new table to the specified keyspace. Within a keyspace,
table names must be unique. CreateTable is an asynchronous operation. When the request is
received, the status of the table is set to CREATING. You can monitor the creation status
of the new table by using the GetTable operation, which returns the current status of the
table. You can start using a table when the status is ACTIVE. For more information, see
Creating tables in the Amazon Keyspaces Developer Guide.
# Arguments
- `keyspace_name`: The name of the keyspace that the table is going to be created in.
- `schema_definition`: The schemaDefinition consists of the following parameters. For each
column to be created: name - The name of the column. type - An Amazon Keyspaces data
type. For more information, see Data types in the Amazon Keyspaces Developer Guide. The
primary key of the table consists of the following columns: partitionKeys - The
partition key can be a single column, or it can be a compound value composed of two or more
columns. The partition key portion of the primary key is required and determines how Amazon
Keyspaces stores your data. name - The name of each partition key column.
clusteringKeys - The optional clustering column portion of your primary key determines how
the data is clustered and sorted within each partition. name - The name of the
clustering column. orderBy - Sets the ascendant (ASC) or descendant (DESC) order
modifier. To define a column as static use staticColumns - Static columns store values that
are shared by all rows in the same partition: name - The name of the column. type -
An Amazon Keyspaces data type.
- `table_name`: The name of the table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoScalingSpecification"`: The optional auto scaling settings for a table in
provisioned capacity mode. Specifies if the service can manage throughput capacity
automatically on your behalf. Auto scaling helps you provision throughput capacity for
variable workloads efficiently by increasing and decreasing your table's read and write
capacity automatically in response to application traffic. For more information, see
Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon
Keyspaces Developer Guide. By default, auto scaling is disabled for a table.
- `"capacitySpecification"`: Specifies the read/write throughput capacity mode for the
table. The options are: throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and
writeCapacityUnits as input. The default is throughput_mode:PAY_PER_REQUEST. For more
information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- `"clientSideTimestamps"`: Enables client-side timestamps for the table. By default, the
setting is disabled. You can enable client-side timestamps with the following option:
status: \"enabled\" Once client-side timestamps are enabled for a table, this setting
cannot be disabled.
- `"comment"`: This parameter allows to enter a description of the table.
- `"defaultTimeToLive"`: The default Time to Live setting in seconds for the table. For
more information, see Setting the default TTL value for a table in the Amazon Keyspaces
Developer Guide.
- `"encryptionSpecification"`: Specifies how the encryption key for encryption at rest is
managed for the table. You can choose one of the following KMS key (KMS key):
type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned,
and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon
Resource Name (ARN) format as input. The default is type:AWS_OWNED_KMS_KEY. For more
information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
- `"pointInTimeRecovery"`: Specifies if pointInTimeRecovery is enabled or disabled for the
table. The options are: status=ENABLED status=DISABLED If it's not specified, the
default is status=DISABLED. For more information, see Point-in-time recovery in the Amazon
Keyspaces Developer Guide.
- `"replicaSpecifications"`: The optional Amazon Web Services Region specific settings of a
multi-Region table. These settings overwrite the general settings of the table for the
specified Region. For a multi-Region table in provisioned capacity mode, you can configure
the table's read capacity differently for each Region's replica. The write capacity,
however, remains synchronized between all replicas to ensure that there's enough capacity
to replicate writes across all Regions. To define the read capacity for a table replica in
a specific Region, you can do so by configuring the following parameters. region: The
Region where these settings are applied. (Required) readCapacityUnits: The provisioned
read capacity units. (Optional) readCapacityAutoScaling: The read capacity auto scaling
settings for the table. (Optional)
- `"tags"`: A list of key-value pair tags to be attached to the resource. For more
information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon
Keyspaces Developer Guide.
- `"ttl"`: Enables Time to Live custom settings for the table. The options are:
status:enabled status:disabled The default is status:disabled. After ttl is enabled,
you can't disable it for the table. For more information, see Expiring data by using Amazon
Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
"""
function create_table(
keyspaceName,
schemaDefinition,
tableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"CreateTable",
Dict{String,Any}(
"keyspaceName" => keyspaceName,
"schemaDefinition" => schemaDefinition,
"tableName" => tableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_table(
keyspaceName,
schemaDefinition,
tableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"CreateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"keyspaceName" => keyspaceName,
"schemaDefinition" => schemaDefinition,
"tableName" => tableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_keyspace(keyspace_name)
delete_keyspace(keyspace_name, params::Dict{String,<:Any})
The DeleteKeyspace operation deletes a keyspace and all of its tables.
# Arguments
- `keyspace_name`: The name of the keyspace to be deleted.
"""
function delete_keyspace(keyspaceName; aws_config::AbstractAWSConfig=global_aws_config())
return keyspaces(
"DeleteKeyspace",
Dict{String,Any}("keyspaceName" => keyspaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_keyspace(
keyspaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"DeleteKeyspace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyspaceName" => keyspaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_table(keyspace_name, table_name)
delete_table(keyspace_name, table_name, params::Dict{String,<:Any})
The DeleteTable operation deletes a table and all of its data. After a DeleteTable request
is received, the specified table is in the DELETING state until Amazon Keyspaces completes
the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either
in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException.
If the specified table does not exist, Amazon Keyspaces returns a
ResourceNotFoundException. If the table is already in the DELETING state, no error is
returned.
# Arguments
- `keyspace_name`: The name of the keyspace of the to be deleted table.
- `table_name`: The name of the table to be deleted.
"""
function delete_table(
keyspaceName, tableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"DeleteTable",
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_table(
keyspaceName,
tableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"DeleteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_keyspace(keyspace_name)
get_keyspace(keyspace_name, params::Dict{String,<:Any})
Returns the name and the Amazon Resource Name (ARN) of the specified table.
# Arguments
- `keyspace_name`: The name of the keyspace.
"""
function get_keyspace(keyspaceName; aws_config::AbstractAWSConfig=global_aws_config())
return keyspaces(
"GetKeyspace",
Dict{String,Any}("keyspaceName" => keyspaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_keyspace(
keyspaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"GetKeyspace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyspaceName" => keyspaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table(keyspace_name, table_name)
get_table(keyspace_name, table_name, params::Dict{String,<:Any})
Returns information about the table, including the table's name and current status, the
keyspace name, configuration settings, and metadata. To read table metadata using GetTable,
Select action permissions for the table and system tables are required to complete the
operation.
# Arguments
- `keyspace_name`: The name of the keyspace that the table is stored in.
- `table_name`: The name of the table.
"""
function get_table(
keyspaceName, tableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"GetTable",
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table(
keyspaceName,
tableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"GetTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table_auto_scaling_settings(keyspace_name, table_name)
get_table_auto_scaling_settings(keyspace_name, table_name, params::Dict{String,<:Any})
Returns auto scaling related settings of the specified table in JSON format. If the table
is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of
the table are included. Amazon Keyspaces auto scaling helps you provision throughput
capacity for variable workloads efficiently by increasing and decreasing your table's read
and write capacity automatically in response to application traffic. For more information,
see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the
Amazon Keyspaces Developer Guide. GetTableAutoScalingSettings can't be used as an action
in an IAM policy. To define permissions for GetTableAutoScalingSettings, you must allow
the following two actions in the IAM policy statement's Action element:
application-autoscaling:DescribeScalableTargets
application-autoscaling:DescribeScalingPolicies
# Arguments
- `keyspace_name`: The name of the keyspace.
- `table_name`: The name of the table.
"""
function get_table_auto_scaling_settings(
keyspaceName, tableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"GetTableAutoScalingSettings",
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table_auto_scaling_settings(
keyspaceName,
tableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"GetTableAutoScalingSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_keyspaces()
list_keyspaces(params::Dict{String,<:Any})
Returns a list of keyspaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The total number of keyspaces to return in the output. If the total
number of keyspaces available is more than the value specified, a NextToken is provided in
the output. To resume pagination, provide the NextToken value as an argument of a
subsequent API invocation.
- `"nextToken"`: The pagination token. To resume pagination, provide the NextToken value as
argument of a subsequent API invocation.
"""
function list_keyspaces(; aws_config::AbstractAWSConfig=global_aws_config())
return keyspaces(
"ListKeyspaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_keyspaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"ListKeyspaces", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tables(keyspace_name)
list_tables(keyspace_name, params::Dict{String,<:Any})
Returns a list of tables for a specified keyspace.
# Arguments
- `keyspace_name`: The name of the keyspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The total number of tables to return in the output. If the total number
of tables available is more than the value specified, a NextToken is provided in the
output. To resume pagination, provide the NextToken value as an argument of a subsequent
API invocation.
- `"nextToken"`: The pagination token. To resume pagination, provide the NextToken value as
an argument of a subsequent API invocation.
"""
function list_tables(keyspaceName; aws_config::AbstractAWSConfig=global_aws_config())
return keyspaces(
"ListTables",
Dict{String,Any}("keyspaceName" => keyspaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tables(
keyspaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"ListTables",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyspaceName" => keyspaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The total number of tags to return in the output. If the total number of
tags available is more than the value specified, a NextToken is provided in the output. To
resume pagination, provide the NextToken value as an argument of a subsequent API
invocation.
- `"nextToken"`: The pagination token. To resume pagination, provide the NextToken value as
argument of a subsequent API invocation.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"ListTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_table(source_keyspace_name, source_table_name, target_keyspace_name, target_table_name)
restore_table(source_keyspace_name, source_table_name, target_keyspace_name, target_table_name, params::Dict{String,<:Any})
Restores the table to the specified point in time within the earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR
continuous backups in the Amazon Keyspaces Developer Guide. Any number of users can execute
up to 4 concurrent restores (any type of restore) in a given account. When you restore
using point in time recovery, Amazon Keyspaces restores your source table's schema and data
to the state based on the selected timestamp (day:hour:minute:second) to a new table. The
Time to Live (TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable restores the
capacity mode, auto scaling settings, encryption settings, and point-in-time recovery
settings from the source table. Unlike the table's schema data and TTL settings, which are
restored based on the selected timestamp, these settings are always restored based on the
table's settings as of the current time or when the table was deleted. You can also
overwrite these settings during restore: Read/write capacity mode Provisioned
throughput capacity units Auto scaling settings Point-in-time (PITR) settings Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for
the new table: Identity and Access Management (IAM) policies Amazon CloudWatch metrics
and alarms
# Arguments
- `source_keyspace_name`: The keyspace name of the source table.
- `source_table_name`: The name of the source table.
- `target_keyspace_name`: The name of the target keyspace.
- `target_table_name`: The name of the target table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoScalingSpecification"`: The optional auto scaling settings for the restored table
in provisioned capacity mode. Specifies if the service can manage throughput capacity of a
provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you
provision throughput capacity for variable workloads efficiently by increasing and
decreasing your table's read and write capacity automatically in response to application
traffic. For more information, see Managing throughput capacity automatically with Amazon
Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
- `"capacitySpecificationOverride"`: Specifies the read/write throughput capacity mode for
the target table. The options are: throughputMode:PAY_PER_REQUEST
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and
writeCapacityUnits as input. The default is throughput_mode:PAY_PER_REQUEST. For more
information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- `"encryptionSpecificationOverride"`: Specifies the encryption settings for the target
table. You can choose one of the following KMS key (KMS key): type:AWS_OWNED_KMS_KEY -
This key is owned by Amazon Keyspaces. type:CUSTOMER_MANAGED_KMS_KEY - This key is
stored in your account and is created, owned, and managed by you. This option requires the
kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input. The
default is type:AWS_OWNED_KMS_KEY. For more information, see Encryption at rest in the
Amazon Keyspaces Developer Guide.
- `"pointInTimeRecoveryOverride"`: Specifies the pointInTimeRecovery settings for the
target table. The options are: status=ENABLED status=DISABLED If it's not
specified, the default is status=DISABLED. For more information, see Point-in-time recovery
in the Amazon Keyspaces Developer Guide.
- `"replicaSpecifications"`: The optional Region specific settings of a multi-Regional
table.
- `"restoreTimestamp"`: The restore timestamp in ISO 8601 format.
- `"tagsOverride"`: A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the
Amazon Keyspaces Developer Guide.
"""
function restore_table(
sourceKeyspaceName,
sourceTableName,
targetKeyspaceName,
targetTableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"RestoreTable",
Dict{String,Any}(
"sourceKeyspaceName" => sourceKeyspaceName,
"sourceTableName" => sourceTableName,
"targetKeyspaceName" => targetKeyspaceName,
"targetTableName" => targetTableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_table(
sourceKeyspaceName,
sourceTableName,
targetKeyspaceName,
targetTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"RestoreTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"sourceKeyspaceName" => sourceKeyspaceName,
"sourceTableName" => sourceTableName,
"targetKeyspaceName" => targetKeyspaceName,
"targetTableName" => targetTableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these
user-defined tags so that they appear on the Cost Management Console for cost allocation
tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in
the Amazon Keyspaces Developer Guide. For IAM policy examples that show how to control
access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access
based on tags in the Amazon Keyspaces Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which
to add tags.
- `tags`: The tags to be assigned to the Amazon Keyspaces resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return keyspaces(
"TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tags)
untag_resource(resource_arn, tags, params::Dict{String,<:Any})
Removes the association of tags from a Amazon Keyspaces resource.
# Arguments
- `resource_arn`: The Amazon Keyspaces resource that the tags will be removed from. This
value is an Amazon Resource Name (ARN).
- `tags`: A list of existing tags to be removed from the Amazon Keyspaces resource.
"""
function untag_resource(
resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table(keyspace_name, table_name)
update_table(keyspace_name, table_name, params::Dict{String,<:Any})
Adds new columns to the table or updates one of the table's settings, for example capacity
mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can
only update one specific table setting per update operation.
# Arguments
- `keyspace_name`: The name of the keyspace the specified table is stored in.
- `table_name`: The name of the table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addColumns"`: For each column to be added to the specified table: name - The name of
the column. type - An Amazon Keyspaces data type. For more information, see Data types
in the Amazon Keyspaces Developer Guide.
- `"autoScalingSpecification"`: The optional auto scaling settings to update for a table in
provisioned capacity mode. Specifies if the service can manage throughput capacity of a
provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you
provision throughput capacity for variable workloads efficiently by increasing and
decreasing your table's read and write capacity automatically in response to application
traffic. If auto scaling is already enabled for the table, you can use UpdateTable to
update the minimum and maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces
auto scaling in the Amazon Keyspaces Developer Guide.
- `"capacitySpecification"`: Modifies the read/write throughput capacity mode for the
table. The options are: throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and
writeCapacityUnits as input. The default is throughput_mode:PAY_PER_REQUEST. For more
information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- `"clientSideTimestamps"`: Enables client-side timestamps for the table. By default, the
setting is disabled. You can enable client-side timestamps with the following option:
status: \"enabled\" Once client-side timestamps are enabled for a table, this setting
cannot be disabled.
- `"defaultTimeToLive"`: The default Time to Live setting in seconds for the table. For
more information, see Setting the default TTL value for a table in the Amazon Keyspaces
Developer Guide.
- `"encryptionSpecification"`: Modifies the encryption settings of the table. You can
choose one of the following KMS key (KMS key): type:AWS_OWNED_KMS_KEY - This key is
owned by Amazon Keyspaces. type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
account and is created, owned, and managed by you. This option requires the
kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input. The
default is AWS_OWNED_KMS_KEY. For more information, see Encryption at rest in the Amazon
Keyspaces Developer Guide.
- `"pointInTimeRecovery"`: Modifies the pointInTimeRecovery settings of the table. The
options are: status=ENABLED status=DISABLED If it's not specified, the default is
status=DISABLED. For more information, see Point-in-time recovery in the Amazon Keyspaces
Developer Guide.
- `"replicaSpecifications"`: The Region specific settings of a multi-Regional table.
- `"ttl"`: Modifies Time to Live custom settings for the table. The options are:
status:enabled status:disabled The default is status:disabled. After ttl is enabled,
you can't disable it for the table. For more information, see Expiring data by using Amazon
Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
"""
function update_table(
keyspaceName, tableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return keyspaces(
"UpdateTable",
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table(
keyspaceName,
tableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return keyspaces(
"UpdateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("keyspaceName" => keyspaceName, "tableName" => tableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 84566 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis
using AWS.Compat
using AWS.UUIDs
"""
add_tags_to_stream(tags)
add_tags_to_stream(tags, params::Dict{String,<:Any})
Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to
a data stream. When invoking this API, you must use either the StreamARN or the StreamName
parameter, or both. It is recommended that you use the StreamARN input parameter when you
invoke this API. If tags have already been assigned to the stream, AddTagsToStream
overwrites any existing tags that correspond to the specified tag keys. AddTagsToStream
has a limit of five transactions per second per account.
# Arguments
- `tags`: A set of up to 10 key-value pairs to use to create the tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream.
"""
function add_tags_to_stream(Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"AddTagsToStream",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags_to_stream(
Tags, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"AddTagsToStream",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stream(stream_name)
create_stream(stream_name, params::Dict{String,<:Any})
Creates a Kinesis data stream. A stream captures and transports data records that are
continuously emitted from different data sources or producers. Scale-out within a stream is
explicitly supported by means of shards, which are uniquely identified groups of data
records in a stream. You can create your data stream using either on-demand or provisioned
capacity mode. Data streams with an on-demand mode require no capacity planning and
automatically scale to handle gigabytes of write and read throughput per minute. With the
on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide
the necessary throughput. For the data streams with a provisioned mode, you must specify
the number of shards for the data stream. Each shard can support reads up to five
transactions per second, up to a maximum data read total of 2 MiB per second. Each shard
can support writes up to 1,000 records per second, up to a maximum data write total of 1
MiB per second. If the amount of data input increases or decreases, you can add or remove
shards. The stream name identifies the stream. The name is scoped to the Amazon Web
Services account used by the application. It is also scoped by Amazon Web Services Region.
That is, two streams in two different accounts can have the same name, and two streams in
the same account, but in two different Regions, can have the same name. CreateStream is an
asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams
immediately returns and sets the stream status to CREATING. After the stream is created,
Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write
operations only on an ACTIVE stream. You receive a LimitExceededException when making a
CreateStream request when you try to do one of the following: Have more than five streams
in the CREATING state at any point in time. Create more shards than are authorized for
your account. For the default shard limit for an Amazon Web Services account, see Amazon
Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase
this limit, contact Amazon Web Services Support. You can use DescribeStreamSummary to check
the stream status, which is returned in StreamStatus. CreateStream has a limit of five
transactions per second per account.
# Arguments
- `stream_name`: A name to identify the stream. The stream name is scoped to the Amazon Web
Services account used by the application that creates the stream. It is also scoped by
Amazon Web Services Region. That is, two streams in two different Amazon Web Services
accounts can have the same name. Two streams in the same Amazon Web Services account but in
two different Regions can also have the same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ShardCount"`: The number of shards that the stream will use. The throughput of the
stream is a function of the number of shards; more shards are required for greater
provisioned throughput.
- `"StreamModeDetails"`: Indicates the capacity mode of the data stream. Currently, in
Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned
capacity mode for your data streams.
"""
function create_stream(StreamName; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"CreateStream",
Dict{String,Any}("StreamName" => StreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_stream(
StreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"CreateStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StreamName" => StreamName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decrease_stream_retention_period(retention_period_hours)
decrease_stream_retention_period(retention_period_hours, params::Dict{String,<:Any})
Decreases the Kinesis data stream's retention period, which is the length of time data
records are accessible after they are added to the stream. The minimum value of a stream's
retention period is 24 hours. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API. This operation may result in lost data. For example,
if the stream's retention period is 48 hours and is decreased to 24 hours, any data already
in the stream that is older than 24 hours is inaccessible.
# Arguments
- `retention_period_hours`: The new retention period of the stream, in hours. Must be less
than the current retention period.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream to modify.
"""
function decrease_stream_retention_period(
RetentionPeriodHours; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DecreaseStreamRetentionPeriod",
Dict{String,Any}("RetentionPeriodHours" => RetentionPeriodHours);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decrease_stream_retention_period(
RetentionPeriodHours,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"DecreaseStreamRetentionPeriod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RetentionPeriodHours" => RetentionPeriodHours),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Delete a policy for the specified data stream or consumer. Request patterns can be one of
the following: Data stream pattern: arn:aws.*:kinesis:.*:d{12}:.*stream/S+ Consumer
pattern:
^(arn):aws.*:kinesis:.*:d{12}:.*stream/[a-zA-Z0-9_.-]+/consumer/[a-zA-Z0-9_.-]+:[0-9]+
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the data stream or consumer.
"""
function delete_resource_policy(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DeleteResourcePolicy",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stream()
delete_stream(params::Dict{String,<:Any})
Deletes a Kinesis data stream and all its shards and data. You must shut down any
applications that are operating on the stream before you delete the stream. If an
application attempts to operate on a deleted stream, it receives the exception
ResourceNotFoundException. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API. If the stream is in the ACTIVE state, you can delete
it. After a DeleteStream request, the specified stream is in the DELETING state until
Kinesis Data Streams completes the deletion. Note: Kinesis Data Streams might continue to
accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a
stream in the DELETING state until the stream deletion is complete. When you delete a
stream, any shards in that stream are also deleted, and any tags are dissociated from the
stream. You can use the DescribeStreamSummary operation to check the state of the stream,
which is returned in StreamStatus. DeleteStream has a limit of five transactions per
second per account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnforceConsumerDeletion"`: If this parameter is unset (null) or if you set it to false,
and the stream has registered consumers, the call to DeleteStream fails with a
ResourceInUseException.
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream to delete.
"""
function delete_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis("DeleteStream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function delete_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DeleteStream", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
deregister_stream_consumer()
deregister_stream_consumer(params::Dict{String,<:Any})
To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the
data stream and the name you gave the consumer when you registered it. You may also provide
all three parameters, as long as they don't conflict with each other. If you don't know the
name or ARN of the consumer that you want to deregister, you can use the
ListStreamConsumers operation to get a list of the descriptions of all the consumers that
are currently registered with a given data stream. The description of a consumer contains
its name and ARN. This operation has a limit of five transactions per second per stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConsumerARN"`: The ARN returned by Kinesis Data Streams when you registered the
consumer. If you don't know the ARN of the consumer that you want to deregister, you can
use the ListStreamConsumers operation to get a list of the descriptions of all the
consumers that are currently registered with a given data stream. The description of a
consumer contains its ARN.
- `"ConsumerName"`: The name that you gave to the consumer.
- `"StreamARN"`: The ARN of the Kinesis data stream that the consumer is registered with.
For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service
Namespaces.
"""
function deregister_stream_consumer(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"DeregisterStreamConsumer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function deregister_stream_consumer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DeregisterStreamConsumer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_limits()
describe_limits(params::Dict{String,<:Any})
Describes the shard limits and usage for the account. If you update your account limits,
the old limits might be returned for a few minutes. This operation has a limit of one
transaction per second per account.
"""
function describe_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis("DescribeLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DescribeLimits", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_stream()
describe_stream(params::Dict{String,<:Any})
Describes the specified Kinesis data stream. This API has been revised. It's highly
recommended that you use the DescribeStreamSummary API to get a summarized description of
the specified Kinesis data stream and the ListShards API to list the shards in a specified
data stream and obtain information about each shard. When invoking this API, you must
use either the StreamARN or the StreamName parameter, or both. It is recommended that you
use the StreamARN input parameter when you invoke this API. The information returned
includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric
configuration, and shard map. The shard map is an array of shard objects. For each shard
object, there is the hash key and sequence number ranges that the shard spans, and the IDs
of any earlier shards that played in a role in creating the shard. Every record ingested in
the stream is identified by a sequence number, which is assigned when the record is put
into the stream. You can limit the number of shards returned by each call. For more
information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams
Developer Guide. There are no guarantees about the chronological order shards returned. To
process shards in chronological order, use the ID of the parent shard to track the lineage
to the oldest shard. This operation has a limit of 10 transactions per second per account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartShardId"`: The shard ID of the shard to start with. Specify this
parameter to indicate that you want to describe the stream starting with the shard whose ID
immediately follows ExclusiveStartShardId. If you don't specify this parameter, the default
behavior for DescribeStream is to describe the stream starting with the first shard in the
stream.
- `"Limit"`: The maximum number of shards to return in a single call. The default value is
100. If you specify a value greater than 100, at most 100 results are returned.
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream to describe.
"""
function describe_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis("DescribeStream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DescribeStream", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_stream_consumer()
describe_stream_consumer(params::Dict{String,<:Any})
To get the description of a registered consumer, provide the ARN of the consumer.
Alternatively, you can provide the ARN of the data stream and the name you gave the
consumer when you registered it. You may also provide all three parameters, as long as they
don't conflict with each other. If you don't know the name or ARN of the consumer that you
want to describe, you can use the ListStreamConsumers operation to get a list of the
descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per stream. When making a
cross-account call with DescribeStreamConsumer, make sure to provide the ARN of the
consumer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConsumerARN"`: The ARN returned by Kinesis Data Streams when you registered the
consumer.
- `"ConsumerName"`: The name that you gave to the consumer.
- `"StreamARN"`: The ARN of the Kinesis data stream that the consumer is registered with.
For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service
Namespaces.
"""
function describe_stream_consumer(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"DescribeStreamConsumer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_stream_consumer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DescribeStreamConsumer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stream_summary()
describe_stream_summary(params::Dict{String,<:Any})
Provides a summarized description of the specified Kinesis data stream without the shard
list. When invoking this API, you must use either the StreamARN or the StreamName
parameter, or both. It is recommended that you use the StreamARN input parameter when you
invoke this API. The information returned includes the stream name, Amazon Resource Name
(ARN), status, record retention period, approximate creation time, monitoring, encryption
details, and open shard count. DescribeStreamSummary has a limit of 20 transactions per
second per account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream to describe.
"""
function describe_stream_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"DescribeStreamSummary"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_stream_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DescribeStreamSummary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_enhanced_monitoring(shard_level_metrics)
disable_enhanced_monitoring(shard_level_metrics, params::Dict{String,<:Any})
Disables enhanced monitoring. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API.
# Arguments
- `shard_level_metrics`: List of shard-level metrics to disable. The following are the
valid shard-level metrics. The value \"ALL\" disables every metric. IncomingBytes
IncomingRecords OutgoingBytes OutgoingRecords
WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis
Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer
Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the Kinesis data stream for which to disable enhanced
monitoring.
"""
function disable_enhanced_monitoring(
ShardLevelMetrics; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"DisableEnhancedMonitoring",
Dict{String,Any}("ShardLevelMetrics" => ShardLevelMetrics);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_enhanced_monitoring(
ShardLevelMetrics,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"DisableEnhancedMonitoring",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ShardLevelMetrics" => ShardLevelMetrics), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_enhanced_monitoring(shard_level_metrics)
enable_enhanced_monitoring(shard_level_metrics, params::Dict{String,<:Any})
Enables enhanced Kinesis data stream monitoring for shard-level metrics. When invoking
this API, you must use either the StreamARN or the StreamName parameter, or both. It is
recommended that you use the StreamARN input parameter when you invoke this API.
# Arguments
- `shard_level_metrics`: List of shard-level metrics to enable. The following are the valid
shard-level metrics. The value \"ALL\" enables every metric. IncomingBytes
IncomingRecords OutgoingBytes OutgoingRecords
WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis
Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer
Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream for which to enable enhanced monitoring.
"""
function enable_enhanced_monitoring(
ShardLevelMetrics; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"EnableEnhancedMonitoring",
Dict{String,Any}("ShardLevelMetrics" => ShardLevelMetrics);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_enhanced_monitoring(
ShardLevelMetrics,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"EnableEnhancedMonitoring",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ShardLevelMetrics" => ShardLevelMetrics), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_records(shard_iterator)
get_records(shard_iterator, params::Dict{String,<:Any})
Gets data records from a Kinesis data stream's shard. When invoking this API, you must use
either the StreamARN or the StreamName parameter, or both. It is recommended that you use
the StreamARN input parameter when you invoke this API. Specify a shard iterator using the
ShardIterator parameter. The shard iterator specifies the position in the shard from which
you want to start reading data records sequentially. If there are no records available in
the portion of the shard that the iterator points to, GetRecords returns an empty list. It
might take multiple calls to get to a portion of the shard that contains records. You can
scale by provisioning multiple shards per stream while considering service limits (for more
information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams
Developer Guide). Your application should have one thread per shard, each reading
continuously from its stream. To read from a stream continually, call GetRecords in a loop.
Use GetShardIterator to get the shard iterator to specify in the first GetRecords call.
GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator
returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been
closed, the shard iterator can't return more data and GetRecords returns null in
NextShardIterator. You can terminate the loop when the shard is closed, or when the shard
iterator reaches the record with the sequence number or other attribute that marks it as
the last record to process. Each data record can be up to 1 MiB in size, and each shard can
read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum
supported size or throughput by using the Limit parameter to specify the maximum number of
records that GetRecords can return. Consider your average record size when determining this
limit. The maximum number of records that can be returned per call is 10,000. The size of
the data returned by GetRecords varies depending on the utilization of the shard. It is
recommended that consumer applications retrieve records via the GetRecords command using
the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to
consumer applications falling behind. The maximum size of data that GetRecords can return
is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5
seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned
throughput on the stream, subsequent calls made within the next 1 second throw
ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws
an exception. For this reason, we recommend that you wait 1 second between calls to
GetRecords. However, it's possible that the application will get exceptions for longer than
1 second. To detect whether the application is falling behind in processing, you can use
the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch
metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer
Guide). Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is
set when a stream successfully receives and stores a record. This is commonly referred to
as a server-side time stamp, whereas a client-side time stamp is set when a data producer
creates or sends the record to a stream (a data producer is any data source putting data
records into a stream, for example with PutRecords). The time stamp has millisecond
precision. There are no guarantees about the time stamp accuracy, or that the time stamp is
always increasing. For example, records in a shard or across a stream might have time
stamps that are out of order. This operation has a limit of five transactions per second
per shard.
# Arguments
- `shard_iterator`: The position in the shard from which you want to start sequentially
reading data records. A shard iterator specifies this position using the sequence number of
a data record in the shard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of records to return. Specify a value of up to 10,000. If
you specify a value that is greater than 10,000, GetRecords throws
InvalidArgumentException. The default value is 10,000.
- `"StreamARN"`: The ARN of the stream.
"""
function get_records(ShardIterator; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"GetRecords",
Dict{String,Any}("ShardIterator" => ShardIterator);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_records(
ShardIterator,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"GetRecords",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ShardIterator" => ShardIterator), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})
Returns a policy attached to the specified data stream or consumer. Request patterns can be
one of the following: Data stream pattern: arn:aws.*:kinesis:.*:d{12}:.*stream/S+
Consumer pattern:
^(arn):aws.*:kinesis:.*:d{12}:.*stream/[a-zA-Z0-9_.-]+/consumer/[a-zA-Z0-9_.-]+:[0-9]+
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the data stream or consumer.
"""
function get_resource_policy(ResourceARN; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"GetResourcePolicy",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policy(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_shard_iterator(shard_id, shard_iterator_type)
get_shard_iterator(shard_id, shard_iterator_type, params::Dict{String,<:Any})
Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is
returned to the requester. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API. A shard iterator specifies the shard position from
which to start reading data records sequentially. The position is specified using the
sequence number of a data record in a shard. A sequence number is the identifier associated
with every record ingested in the stream, and is assigned when a record is put into the
stream. Each stream has one or more shards. You must specify the shard iterator type. For
example, you can set the ShardIteratorType parameter to read exactly from the position
denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type.
Alternatively, the parameter can read right after the sequence number by using the
AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls
to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify
the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time,
TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in
the system (the oldest data record in the shard), or LATEST so that you always read the
most recent data in the shard. When you read repeatedly from a stream, use a
GetShardIterator request to get the first shard iterator for use in your first GetRecords
request and for subsequent reads use the shard iterator returned by the GetRecords request
in NextShardIterator. A new shard iterator is returned by every GetRecords request in
NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords
request. If a GetShardIterator request is made too often, you receive a
ProvisionedThroughputExceededException. For more information about throughput limits, see
GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide. If the
shard is closed, GetShardIterator returns a valid iterator for the last sequence number of
the shard. A shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of five transactions per second per account per open shard.
# Arguments
- `shard_id`: The shard ID of the Kinesis Data Streams shard to get the iterator for.
- `shard_iterator_type`: Determines how the shard iterator is used to start reading data
records from the shard. The following are the valid Amazon Kinesis shard iterator types:
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number,
provided in the value StartingSequenceNumber. AFTER_SEQUENCE_NUMBER - Start reading right
after the position denoted by a specific sequence number, provided in the value
StartingSequenceNumber. AT_TIMESTAMP - Start reading from the position denoted by a
specific time stamp, provided in the value Timestamp. TRIM_HORIZON - Start reading at the
last untrimmed record in the shard in the system, which is the oldest data record in the
shard. LATEST - Start reading just after the most recent record in the shard, so that you
always read the most recent data in the shard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StartingSequenceNumber"`: The sequence number of the data record in the shard from
which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and
AFTER_SEQUENCE_NUMBER.
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the Amazon Kinesis data stream.
- `"Timestamp"`: The time stamp of the data record from which to start reading. Used with
shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in
milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record
with this exact time stamp does not exist, the iterator returned is for the next (later)
record. If the time stamp is older than the current trim horizon, the iterator returned is
for the oldest untrimmed data record (TRIM_HORIZON).
"""
function get_shard_iterator(
ShardId, ShardIteratorType; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"GetShardIterator",
Dict{String,Any}("ShardId" => ShardId, "ShardIteratorType" => ShardIteratorType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_shard_iterator(
ShardId,
ShardIteratorType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"GetShardIterator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ShardId" => ShardId, "ShardIteratorType" => ShardIteratorType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
increase_stream_retention_period(retention_period_hours)
increase_stream_retention_period(retention_period_hours, params::Dict{String,<:Any})
Increases the Kinesis data stream's retention period, which is the length of time data
records are accessible after they are added to the stream. The maximum value of a stream's
retention period is 8760 hours (365 days). When invoking this API, you must use either the
StreamARN or the StreamName parameter, or both. It is recommended that you use the
StreamARN input parameter when you invoke this API. If you choose a longer stream
retention period, this operation increases the time period during which records that have
not yet expired are accessible. However, it does not make previous, expired data (older
than the stream's previous retention period) accessible after the operation has been
called. For example, if a stream's retention period is set to 24 hours and is increased to
168 hours, any data that is older than 24 hours remains inaccessible to consumer
applications.
# Arguments
- `retention_period_hours`: The new retention period of the stream, in hours. Must be more
than the current retention period.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream to modify.
"""
function increase_stream_retention_period(
RetentionPeriodHours; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"IncreaseStreamRetentionPeriod",
Dict{String,Any}("RetentionPeriodHours" => RetentionPeriodHours);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function increase_stream_retention_period(
RetentionPeriodHours,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"IncreaseStreamRetentionPeriod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RetentionPeriodHours" => RetentionPeriodHours),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_shards()
list_shards(params::Dict{String,<:Any})
Lists the shards in a stream and provides information about each shard. This operation has
a limit of 1000 transactions per second per data stream. When invoking this API, you must
use either the StreamARN or the StreamName parameter, or both. It is recommended that you
use the StreamARN input parameter when you invoke this API. This action does not list
expired shards. For information about expired shards, see Data Routing, Data Persistence,
and Shard State after a Reshard. This API is a new operation that is used by the Amazon
Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows
specific operations, you must update your policy to allow calls to this API. For more
information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartShardId"`: Specify this parameter to indicate that you want to list the
shards starting with the shard whose ID immediately follows ExclusiveStartShardId. If you
don't specify this parameter, the default behavior is for ListShards to list the shards
starting with the first one in the stream. You cannot specify this parameter if you specify
NextToken.
- `"MaxResults"`: The maximum number of shards to return in a single call to ListShards.
The maximum number of shards to return in a single call. The default value is 1000. If you
specify a value greater than 1000, at most 1000 results are returned. When the number of
shards to be listed is greater than the value of MaxResults, the response contains a
NextToken value that you can use in a subsequent call to ListShards to list the next set of
shards.
- `"NextToken"`: When the number of shards in the data stream is greater than the default
value for the MaxResults parameter, or if you explicitly specify a value for MaxResults
that is less than the number of shards in the data stream, the response includes a
pagination token named NextToken. You can specify this NextToken value in a subsequent call
to ListShards to list the next set of shards. Don't specify StreamName or
StreamCreationTimestamp if you specify NextToken because the latter unambiguously
identifies the stream. You can optionally specify a value for the MaxResults parameter when
you specify NextToken. If you specify a MaxResults value that is less than the number of
shards that the operation returns if you don't specify MaxResults, the response will
contain a new NextToken value. You can use the new NextToken value in a subsequent call to
the ListShards operation. Tokens expire after 300 seconds. When you obtain a value for
NextToken in the response to a call to ListShards, you have 300 seconds to use that value.
If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
- `"ShardFilter"`: Enables you to filter out the response of the ListShards API. You can
only specify one filter at a time. If you use the ShardFilter parameter when invoking the
ListShards API, the Type is the required property and must be specified. If you specify the
AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or AT_LATEST types, you do not need to specify either
the ShardId or the Timestamp optional properties. If you specify the AFTER_SHARD_ID type,
you must also provide the value for the optional ShardId property. The ShardId property is
identical in fuctionality to the ExclusiveStartShardId parameter of the ListShards API.
When ShardId property is specified, the response includes the shards starting with the
shard whose ID immediately follows the ShardId that you provided. If you specify the
AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must also provide the value for the optional
Timestamp property. If you specify the AT_TIMESTAMP type, then all shards that were open at
the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all
shards starting from the provided timestamp to TIP are returned.
- `"StreamARN"`: The ARN of the stream.
- `"StreamCreationTimestamp"`: Specify this input parameter to distinguish data streams
that have the same name. For example, if you create a data stream and then delete it, and
you later create another data stream with the same name, you can use this input parameter
to specify which of the two streams you want to list the shards for. You cannot specify
this parameter if you specify the NextToken parameter.
- `"StreamName"`: The name of the data stream whose shards you want to list. You cannot
specify this parameter if you specify the NextToken parameter.
"""
function list_shards(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis("ListShards"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_shards(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"ListShards", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_stream_consumers(stream_arn)
list_stream_consumers(stream_arn, params::Dict{String,<:Any})
Lists the consumers registered to receive data from a stream using enhanced fan-out, and
provides information about each consumer. This operation has a limit of 5 transactions per
second per stream.
# Arguments
- `stream_arn`: The ARN of the Kinesis data stream for which you want to list the
registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web
Services Service Namespaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of consumers that you want a single call of
ListStreamConsumers to return. The default value is 100. If you specify a value greater
than 100, at most 100 results are returned.
- `"NextToken"`: When the number of consumers that are registered with the data stream is
greater than the default value for the MaxResults parameter, or if you explicitly specify a
value for MaxResults that is less than the number of consumers that are registered with the
data stream, the response includes a pagination token named NextToken. You can specify this
NextToken value in a subsequent call to ListStreamConsumers to list the next set of
registered consumers. Don't specify StreamName or StreamCreationTimestamp if you specify
NextToken because the latter unambiguously identifies the stream. You can optionally
specify a value for the MaxResults parameter when you specify NextToken. If you specify a
MaxResults value that is less than the number of consumers that the operation returns if
you don't specify MaxResults, the response will contain a new NextToken value. You can use
the new NextToken value in a subsequent call to the ListStreamConsumers operation to list
the next set of consumers. Tokens expire after 300 seconds. When you obtain a value for
NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use
that value. If you specify an expired token in a call to ListStreamConsumers, you get
ExpiredNextTokenException.
- `"StreamCreationTimestamp"`: Specify this input parameter to distinguish data streams
that have the same name. For example, if you create a data stream and then delete it, and
you later create another data stream with the same name, you can use this input parameter
to specify which of the two streams you want to list the consumers for. You can't specify
this parameter if you specify the NextToken parameter.
"""
function list_stream_consumers(StreamARN; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"ListStreamConsumers",
Dict{String,Any}("StreamARN" => StreamARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_stream_consumers(
StreamARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"ListStreamConsumers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StreamARN" => StreamARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streams()
list_streams(params::Dict{String,<:Any})
Lists your Kinesis data streams. The number of streams may be too large to return from a
single call to ListStreams. You can limit the number of returned streams using the Limit
parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses
the default limit, which is currently 100. You can detect if there are more streams
available to list by using the HasMoreStreams flag from the returned output. If there are
more streams available, you can request more streams by using the name of the last stream
returned by the ListStreams request in the ExclusiveStartStreamName parameter in a
subsequent request to ListStreams. The group of stream names returned by the subsequent
request is then added to the list. You can continue this process until all the stream names
have been collected in the list. ListStreams has a limit of five transactions per second
per account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartStreamName"`: The name of the stream to start the list with.
- `"Limit"`: The maximum number of streams to list. The default value is 100. If you
specify a value greater than 100, at most 100 results are returned.
- `"NextToken"`:
"""
function list_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis("ListStreams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"ListStreams", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_stream()
list_tags_for_stream(params::Dict{String,<:Any})
Lists the tags for the specified Kinesis data stream. This operation has a limit of five
transactions per second per account. When invoking this API, you must use either the
StreamARN or the StreamName parameter, or both. It is recommended that you use the
StreamARN input parameter when you invoke this API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartTagKey"`: The key to use as the starting point for the list of tags. If
this parameter is set, ListTagsForStream gets all tags that occur after
ExclusiveStartTagKey.
- `"Limit"`: The number of tags to return. If this number is less than the total number of
tags associated with the stream, HasMoreTags is set to true. To list additional tags, set
ExclusiveStartTagKey to the last key in the response.
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream.
"""
function list_tags_for_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"ListTagsForStream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tags_for_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"ListTagsForStream", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
merge_shards(adjacent_shard_to_merge, shard_to_merge)
merge_shards(adjacent_shard_to_merge, shard_to_merge, params::Dict{String,<:Any})
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard
to reduce the stream's capacity to ingest and transport data. This API is only supported
for the data streams with the provisioned capacity mode. Two shards are considered adjacent
if the union of the hash key ranges for the two shards form a contiguous set with no gaps.
For example, if you have two shards, one with a hash key range of 276...381 and the other
with a hash key range of 382...454, then you could merge these two shards into a single
shard that would have a hash key range of 276...454. After the merge, the single child
shard receives data for all hash key values covered by the two parent shards. When
invoking this API, you must use either the StreamARN or the StreamName parameter, or both.
It is recommended that you use the StreamARN input parameter when you invoke this API.
MergeShards is called when there is a need to reduce the overall capacity of a stream
because of excess capacity that is not being used. You must specify the shard to be merged
and the adjacent shard for a stream. For more information about merging shards, see Merge
Two Shards in the Amazon Kinesis Data Streams Developer Guide. If the stream is in the
ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or
DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does
not exist, MergeShards returns a ResourceNotFoundException. You can use
DescribeStreamSummary to check the state of the stream, which is returned in StreamStatus.
MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon
Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING.
After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE.
Read and write operations continue to work while the stream is in the UPDATING state. You
use DescribeStreamSummary and the ListShards APIs to determine the shard IDs that are
specified in the MergeShards request. If you try to operate on too many streams in
parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a
LimitExceededException. MergeShards has a limit of five transactions per second per
account.
# Arguments
- `adjacent_shard_to_merge`: The shard ID of the adjacent shard for the merge.
- `shard_to_merge`: The shard ID of the shard to combine with the adjacent shard for the
merge.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream for the merge.
"""
function merge_shards(
AdjacentShardToMerge, ShardToMerge; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"MergeShards",
Dict{String,Any}(
"AdjacentShardToMerge" => AdjacentShardToMerge, "ShardToMerge" => ShardToMerge
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function merge_shards(
AdjacentShardToMerge,
ShardToMerge,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"MergeShards",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdjacentShardToMerge" => AdjacentShardToMerge,
"ShardToMerge" => ShardToMerge,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_record(data, partition_key)
put_record(data, partition_key, params::Dict{String,<:Any})
Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data
into the stream for real-time ingestion and subsequent processing, one record at a time.
Each shard can support writes up to 1,000 records per second, up to a maximum data write
total of 1 MiB per second. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API. You must specify the name of the stream that captures,
stores, and transports the data; a partition key; and the data blob itself. The data blob
can be any type of data; for example, a segment from a log file, geographic/location data,
website clickstream data, and so on. The partition key is used by Kinesis Data Streams to
distribute data across shards. Kinesis Data Streams segregates the data records that belong
to a stream into multiple shards, using the partition key associated with each data record
to determine the shard to which a given data record belongs. Partition keys are Unicode
strings, with a maximum length limit of 256 characters for each key. An MD5 hash function
is used to map partition keys to 128-bit integer values and to map associated data records
to shards using the hash key ranges of the shards. You can override hashing the partition
key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey
parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data
Streams Developer Guide. PutRecord returns the shard ID of where the data record was
placed and the sequence number that was assigned to the data record. Sequence numbers
increase over time and are specific to a shard within a stream, not across all shards
within a stream. To guarantee strictly increasing ordering, write serially to a shard and
use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a
Stream in the Amazon Kinesis Data Streams Developer Guide. After you write a record to a
stream, you cannot modify that record or its order within the stream. If a PutRecord
request cannot be processed because of insufficient provisioned throughput on the shard
involved in the request, PutRecord throws ProvisionedThroughputExceededException. By
default, data records are accessible for 24 hours from the time that they are added to a
stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to
modify this retention period.
# Arguments
- `data`: The data blob to put into the record, which is base64-encoded when the blob is
serialized. When the data blob (the payload before base64-encoding) is added to the
partition key size, the total size must not exceed the maximum record size (1 MiB).
- `partition_key`: Determines which shard in the stream the data record is assigned to.
Partition keys are Unicode strings with a maximum length limit of 256 characters for each
key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that
maps the partition key and associated data to a specific shard. Specifically, an MD5 hash
function is used to map partition keys to 128-bit integer values and to map associated data
records to shards. As a result of this hashing mechanism, all data records with the same
partition key map to the same shard within the stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExplicitHashKey"`: The hash value used to explicitly determine the shard the data
record is assigned to by overriding the partition key hash.
- `"SequenceNumberForOrdering"`: Guarantees strictly increasing sequence numbers, for puts
from the same client and to the same partition key. Usage: set the
SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in
the result when putting record n-1). If this parameter is not set, records are coarsely
ordered based on arrival time.
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream to put the data record into.
"""
function put_record(Data, PartitionKey; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"PutRecord",
Dict{String,Any}("Data" => Data, "PartitionKey" => PartitionKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_record(
Data,
PartitionKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"PutRecord",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Data" => Data, "PartitionKey" => PartitionKey),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_records(records)
put_records(records, params::Dict{String,<:Any})
Writes multiple data records into a Kinesis data stream in a single call (also referred to
as a PutRecords request). Use this operation to send data into the stream for data
ingestion and processing. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API. Each PutRecords request can support up to 500 records.
Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire
request, including partition keys. Each shard can support writes up to 1,000 records per
second, up to a maximum data write total of 1 MiB per second. You must specify the name of
the stream that captures, stores, and transports the data; and an array of request Records,
with each record in the array requiring a partition key and data blob. The record size
limit applies to the total size of the partition key and data blob. The data blob can be
any type of data; for example, a segment from a log file, geographic/location data, website
clickstream data, and so on. The partition key is used by Kinesis Data Streams as input to
a hash function that maps the partition key and associated data to a specific shard. An MD5
hash function is used to map partition keys to 128-bit integer values and to map associated
data records to shards. As a result of this hashing mechanism, all data records with the
same partition key map to the same shard within the stream. For more information, see
Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. Each record in
the Records array may include an optional parameter, ExplicitHashKey, which overrides the
partition key to shard mapping. This parameter allows a data producer to determine
explicitly the shard where the record is stored. For more information, see Adding Multiple
Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. The PutRecords
response includes an array of response Records. Each record in the response array directly
correlates with a record in the request array using natural ordering, from the top to the
bottom of the request and response. The response Records array always includes the same
number of records as the request array. The response Records array includes both
successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process
all records in each PutRecords request. A single record failure does not stop the
processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of
records. If you need to read records in the same order they are written to the stream, use
PutRecord instead of PutRecords, and write to the same shard. A successfully processed
record includes ShardId and SequenceNumber values. The ShardId parameter identifies the
shard in the stream where the record is stored. The SequenceNumber parameter is an
identifier assigned to the put record, unique to all records in the stream. An
unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode
reflects the type of error and can be one of the following values:
ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more
detailed information about the ProvisionedThroughputExceededException exception including
the account ID, stream name, and shard ID of the record that was throttled. For more
information about partially successful responses, see Adding Multiple Records with
PutRecords in the Amazon Kinesis Data Streams Developer Guide. After you write a record to
a stream, you cannot modify that record or its order within the stream. By default, data
records are accessible for 24 hours from the time that they are added to a stream. You can
use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention
period.
# Arguments
- `records`: The records associated with the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The stream name associated with the request.
"""
function put_records(Records; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"PutRecords",
Dict{String,Any}("Records" => Records);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_records(
Records, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"PutRecords",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Records" => Records), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Attaches a resource-based policy to a data stream or registered consumer. If you are using
an identity other than the root user of the Amazon Web Services account that owns the
resource, the calling identity must have the PutResourcePolicy permissions on the specified
Kinesis Data Streams resource and belong to the owner's account in order to use this
operation. If you don't have PutResourcePolicy permissions, Amazon Kinesis Data Streams
returns a 403 Access Denied error. If you receive a ResourceNotFoundException, check to see
if you passed a valid stream or consumer resource. Request patterns can be one of the
following: Data stream pattern: arn:aws.*:kinesis:.*:d{12}:.*stream/S+ Consumer
pattern:
^(arn):aws.*:kinesis:.*:d{12}:.*stream/[a-zA-Z0-9_.-]+/consumer/[a-zA-Z0-9_.-]+:[0-9]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using
IAM.
# Arguments
- `policy`: Details of the resource policy. It must include the identity of the principal
and the actions allowed on this resource. This is formatted as a JSON string.
- `resource_arn`: The Amazon Resource Name (ARN) of the data stream or consumer.
"""
function put_resource_policy(
Policy, ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"PutResourcePolicy",
Dict{String,Any}("Policy" => Policy, "ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
Policy,
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceARN" => ResourceARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_stream_consumer(consumer_name, stream_arn)
register_stream_consumer(consumer_name, stream_arn, params::Dict{String,<:Any})
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer
you register can then call SubscribeToShard to receive data from the stream using enhanced
fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is
unaffected by the total number of consumers that read from the same stream. You can
register up to 20 consumers per stream. A given consumer can only be registered with one
stream at a time. For an example of how to use this operations, see Enhanced Fan-Out Using
the Kinesis Data Streams API. The use of this operation has a limit of five transactions
per second per account. Also, only 5 consumers can be created simultaneously. In other
words, you cannot have more than 5 consumers in a CREATING status at the same time.
Registering a 6th consumer while there are 5 in a CREATING status results in a
LimitExceededException.
# Arguments
- `consumer_name`: For a given Kinesis data stream, each consumer must have a unique name.
However, consumer names don't have to be unique across data streams.
- `stream_arn`: The ARN of the Kinesis data stream that you want to register the consumer
with. For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service
Namespaces.
"""
function register_stream_consumer(
ConsumerName, StreamARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"RegisterStreamConsumer",
Dict{String,Any}("ConsumerName" => ConsumerName, "StreamARN" => StreamARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_stream_consumer(
ConsumerName,
StreamARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"RegisterStreamConsumer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConsumerName" => ConsumerName, "StreamARN" => StreamARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags_from_stream(tag_keys)
remove_tags_from_stream(tag_keys, params::Dict{String,<:Any})
Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be
recovered after this operation successfully completes. When invoking this API, you must
use either the StreamARN or the StreamName parameter, or both. It is recommended that you
use the StreamARN input parameter when you invoke this API. If you specify a tag that does
not exist, it is ignored. RemoveTagsFromStream has a limit of five transactions per second
per account.
# Arguments
- `tag_keys`: A list of tag keys. Each corresponding tag is removed from the stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream.
"""
function remove_tags_from_stream(TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis(
"RemoveTagsFromStream",
Dict{String,Any}("TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags_from_stream(
TagKeys, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"RemoveTagsFromStream",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TagKeys" => TagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
split_shard(new_starting_hash_key, shard_to_split)
split_shard(new_starting_hash_key, shard_to_split, params::Dict{String,<:Any})
Splits a shard into two new shards in the Kinesis data stream, to increase the stream's
capacity to ingest and transport data. SplitShard is called when there is a need to
increase the overall capacity of a stream because of an expected increase in the volume of
data records being ingested. This API is only supported for the data streams with the
provisioned capacity mode. When invoking this API, you must use either the StreamARN or
the StreamName parameter, or both. It is recommended that you use the StreamARN input
parameter when you invoke this API. You can also use SplitShard when a shard appears to be
approaching its maximum utilization; for example, the producers sending data into the
specific shard are suddenly sending more than previously anticipated. You can also call
SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can
simultaneously read data from the stream for real-time processing. You must specify the
shard to be split and the new hash key, which is the position in the shard where the shard
gets split in two. In many cases, the new hash key might be the average of the beginning
and ending hash key, but it can be any hash key value in the range being mapped into the
shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer
Guide. You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID
and hash key values for the ShardToSplit and NewStartingHashKey parameters that are
specified in the SplitShard request. SplitShard is an asynchronous operation. Upon
receiving a SplitShard request, Kinesis Data Streams immediately returns a response and
sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams
sets the stream status to ACTIVE. Read and write operations continue to work while the
stream is in the UPDATING state. You can use DescribeStreamSummary to check the status of
the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you
can call SplitShard. If the specified stream does not exist, DescribeStreamSummary returns
a ResourceNotFoundException. If you try to create more shards than are authorized for your
account, you receive a LimitExceededException. For the default shard limit for an Amazon
Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams
Developer Guide. To increase this limit, contact Amazon Web Services Support. If you try to
operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards,
and/or SplitShard, you receive a LimitExceededException. SplitShard has a limit of five
transactions per second per account.
# Arguments
- `new_starting_hash_key`: A hash key value for the starting hash key of one of the child
shards created by the split. The hash key range for a given shard constitutes a set of
ordered contiguous positive integers. The value for NewStartingHashKey must be in the range
of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all
higher hash key values in hash key range are distributed to one of the child shards. All
the lower hash key values in the range are distributed to the other child shard.
- `shard_to_split`: The shard ID of the shard to split.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream for the shard split.
"""
function split_shard(
NewStartingHashKey, ShardToSplit; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"SplitShard",
Dict{String,Any}(
"NewStartingHashKey" => NewStartingHashKey, "ShardToSplit" => ShardToSplit
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function split_shard(
NewStartingHashKey,
ShardToSplit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"SplitShard",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NewStartingHashKey" => NewStartingHashKey,
"ShardToSplit" => ShardToSplit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_stream_encryption(encryption_type, key_id)
start_stream_encryption(encryption_type, key_id, params::Dict{String,<:Any})
Enables or updates server-side encryption using an Amazon Web Services KMS key for a
specified stream. When invoking this API, you must use either the StreamARN or the
StreamName parameter, or both. It is recommended that you use the StreamARN input parameter
when you invoke this API. Starting encryption is an asynchronous operation. Upon receiving
the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream
back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete,
but it can take minutes. You can continue to read and write data to your stream while its
status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records
written to the stream. API Limits: You can successfully apply a new Amazon Web Services
KMS key for server-side encryption 25 times in a rolling 24-hour period. Note: It can take
up to 5 seconds after the stream is in an ACTIVE status before all records written to the
stream are encrypted. After you enable encryption, you can verify that encryption is
applied by inspecting the API response from PutRecord or PutRecords.
# Arguments
- `encryption_type`: The encryption type to use. The only valid value is KMS.
- `key_id`: The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully specified Amazon
Resource Name (ARN) to either an alias or a key, or an alias name prefixed by
\"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the
alias aws/kinesis. Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN
example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally unique key ID
example: 12345678-1234-1234-1234-123456789012 Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream for which to start encrypting records.
"""
function start_stream_encryption(
EncryptionType, KeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"StartStreamEncryption",
Dict{String,Any}("EncryptionType" => EncryptionType, "KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_stream_encryption(
EncryptionType,
KeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"StartStreamEncryption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EncryptionType" => EncryptionType, "KeyId" => KeyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_stream_encryption(encryption_type, key_id)
stop_stream_encryption(encryption_type, key_id, params::Dict{String,<:Any})
Disables server-side encryption for a specified stream. When invoking this API, you must
use either the StreamARN or the StreamName parameter, or both. It is recommended that you
use the StreamARN input parameter when you invoke this API. Stopping encryption is an
asynchronous operation. Upon receiving the request, Kinesis Data Streams returns
immediately and sets the status of the stream to UPDATING. After the update is complete,
Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption
normally takes a few seconds to complete, but it can take minutes. You can continue to read
and write data to your stream while its status is UPDATING. Once the status of the stream
is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.
API Limits: You can successfully disable server-side encryption 25 times in a rolling
24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status
before all records written to the stream are no longer subject to encryption. After you
disabled encryption, you can verify that encryption is not applied by inspecting the API
response from PutRecord or PutRecords.
# Arguments
- `encryption_type`: The encryption type. The only valid value is KMS.
- `key_id`: The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully specified Amazon
Resource Name (ARN) to either an alias or a key, or an alias name prefixed by
\"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the
alias aws/kinesis. Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN
example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally unique key ID
example: 12345678-1234-1234-1234-123456789012 Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream on which to stop encrypting records.
"""
function stop_stream_encryption(
EncryptionType, KeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"StopStreamEncryption",
Dict{String,Any}("EncryptionType" => EncryptionType, "KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_stream_encryption(
EncryptionType,
KeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"StopStreamEncryption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EncryptionType" => EncryptionType, "KeyId" => KeyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_shard_count(scaling_type, target_shard_count)
update_shard_count(scaling_type, target_shard_count, params::Dict{String,<:Any})
Updates the shard count of the specified stream to the specified number of shards. This API
is only supported for the data streams with the provisioned capacity mode. When invoking
this API, you must use either the StreamARN or the StreamName parameter, or both. It is
recommended that you use the StreamARN input parameter when you invoke this API. Updating
the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data
Streams returns immediately and sets the status of the stream to UPDATING. After the update
is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending
on the size of the stream, the scaling action could take a few minutes to complete. You can
continue to read and write data to your stream while its status is UPDATING. To update the
shard count, Kinesis Data Streams performs splits or merges on individual shards. This can
cause short-lived shards to be created, in addition to the final shards. These short-lived
shards count towards your total shard limit for your account in the Region. When using this
operation, we recommend that you specify a target shard count that is a multiple of 25%
(25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However,
if you specify a target that isn't a multiple of 25%, the scaling action might take longer
to complete. This operation has the following default limits. By default, you cannot do
the following: Scale more than ten times per rolling 24-hour period per stream Scale up
to more than double your current shard count for a stream Scale down below half your
current shard count for a stream Scale up to more than 10000 shards in a stream Scale a
stream with more than 10000 shards down unless the result is less than 10000 shards Scale
up to more than the shard limit for your account Make over 10 TPS. TPS over 10 will
trigger the LimitExceededException For the default limits for an Amazon Web Services
account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request
an increase in the call rate limit, the shard limit for this API, or your overall shard
limit, use the limits form.
# Arguments
- `scaling_type`: The scaling type. Uniform scaling creates shards of equal size.
- `target_shard_count`: The new number of shards. This value has the following default
limits. By default, you cannot do the following: Set this value to more than double your
current shard count for a stream. Set this value below half your current shard count for
a stream. Set this value to more than 10000 shards in a stream (the default limit for
shard count per stream is 10000 per account per region), unless you request a limit
increase. Scale a stream with more than 10000 shards down unless you set this value to
less than 10000 shards.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream.
- `"StreamName"`: The name of the stream.
"""
function update_shard_count(
ScalingType, TargetShardCount; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"UpdateShardCount",
Dict{String,Any}(
"ScalingType" => ScalingType, "TargetShardCount" => TargetShardCount
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_shard_count(
ScalingType,
TargetShardCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"UpdateShardCount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ScalingType" => ScalingType, "TargetShardCount" => TargetShardCount
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_stream_mode(stream_arn, stream_mode_details)
update_stream_mode(stream_arn, stream_mode_details, params::Dict{String,<:Any})
Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can
choose between an on-demand capacity mode and a provisioned capacity mode for your data
stream.
# Arguments
- `stream_arn`: Specifies the ARN of the data stream whose capacity mode you want to
update.
- `stream_mode_details`: Specifies the capacity mode to which you want to set your data
stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity
mode and a provisioned capacity mode for your data streams.
"""
function update_stream_mode(
StreamARN, StreamModeDetails; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis(
"UpdateStreamMode",
Dict{String,Any}(
"StreamARN" => StreamARN, "StreamModeDetails" => StreamModeDetails
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_stream_mode(
StreamARN,
StreamModeDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis(
"UpdateStreamMode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StreamARN" => StreamARN, "StreamModeDetails" => StreamModeDetails
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 49496 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_analytics
using AWS.Compat
using AWS.UUIDs
"""
add_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option, current_application_version_id)
add_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option, current_application_version_id, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Adds a CloudWatch log stream to monitor application configuration errors. For more
information about using CloudWatch log streams with Amazon Kinesis Analytics applications,
see Working with Amazon CloudWatch Logs.
# Arguments
- `application_name`: The Kinesis Analytics application name.
- `cloud_watch_logging_option`: Provides the CloudWatch log stream Amazon Resource Name
(ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role
that is used must have the PutLogEvents policy action enabled.
- `current_application_version_id`: The version ID of the Kinesis Analytics application.
"""
function add_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOption,
CurrentApplicationVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationCloudWatchLoggingOption",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOption" => CloudWatchLoggingOption,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOption,
CurrentApplicationVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationCloudWatchLoggingOption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOption" => CloudWatchLoggingOption,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_input(application_name, current_application_version_id, input)
add_application_input(application_name, current_application_version_id, input, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Adds a streaming source to your Amazon Kinesis application. For conceptual information, see
Configuring Application Input. You can add a streaming source either when you create an
application or you can use this operation to add a streaming source after you create an
application. For more information, see CreateApplication. Any configuration update,
including adding a streaming source using this operation, results in a new version of the
application. You can use the DescribeApplication operation to find the current application
version. This operation requires permissions to perform the
kinesisanalytics:AddApplicationInput action.
# Arguments
- `application_name`: Name of your existing Amazon Kinesis Analytics application to which
you want to add the streaming source.
- `current_application_version_id`: Current version of your Amazon Kinesis Analytics
application. You can use the DescribeApplication operation to find the current application
version.
- `input`: The Input to add.
"""
function add_application_input(
ApplicationName,
CurrentApplicationVersionId,
Input;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationInput",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Input" => Input,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_input(
ApplicationName,
CurrentApplicationVersionId,
Input,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationInput",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Input" => Input,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_input_processing_configuration(application_name, current_application_version_id, input_id, input_processing_configuration)
add_application_input_processing_configuration(application_name, current_application_version_id, input_id, input_processing_configuration, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Adds an InputProcessingConfiguration to an application. An input processor preprocesses
records on the input stream before the application's SQL code executes. Currently, the only
input processor available is AWS Lambda.
# Arguments
- `application_name`: Name of the application to which you want to add the input processing
configuration.
- `current_application_version_id`: Version of the application to which you want to add the
input processing configuration. You can use the DescribeApplication operation to get the
current application version. If the version specified is not the current version, the
ConcurrentModificationException is returned.
- `input_id`: The ID of the input configuration to add the input processing configuration
to. You can get a list of the input IDs for an application using the DescribeApplication
operation.
- `input_processing_configuration`: The InputProcessingConfiguration to add to the
application.
"""
function add_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId,
InputProcessingConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationInputProcessingConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
"InputProcessingConfiguration" => InputProcessingConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId,
InputProcessingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationInputProcessingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
"InputProcessingConfiguration" => InputProcessingConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_output(application_name, current_application_version_id, output)
add_application_output(application_name, current_application_version_id, output, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Adds an external destination to your Amazon Kinesis Analytics application. If you want
Amazon Kinesis Analytics to deliver data from an in-application stream within your
application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis
Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to
your application using this operation. You can configure one or more outputs for your
application. Each output configuration maps an in-application stream and an external
destination. You can use one of the output configurations to deliver data from your
in-application error stream to an external destination so that you can analyze the errors.
For more information, see Understanding Application Output (Destination). Any
configuration update, including adding a streaming source using this operation, results in
a new version of the application. You can use the DescribeApplication operation to find the
current application version. For the limits on the number of application inputs and outputs
you can configure, see Limits. This operation requires permissions to perform the
kinesisanalytics:AddApplicationOutput action.
# Arguments
- `application_name`: Name of the application to which you want to add the output
configuration.
- `current_application_version_id`: Version of the application to which you want to add the
output configuration. You can use the DescribeApplication operation to get the current
application version. If the version specified is not the current version, the
ConcurrentModificationException is returned.
- `output`: An array of objects, each describing one output configuration. In the output
configuration, you specify the name of an in-application stream, a destination (that is, an
Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda
function), and record the formation to use when writing to the destination.
"""
function add_application_output(
ApplicationName,
CurrentApplicationVersionId,
Output;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationOutput",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Output" => Output,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_output(
ApplicationName,
CurrentApplicationVersionId,
Output,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationOutput",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Output" => Output,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_reference_data_source(application_name, current_application_version_id, reference_data_source)
add_application_reference_data_source(application_name, current_application_version_id, reference_data_source, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Adds a reference data source to an existing application. Amazon Kinesis Analytics reads
reference data (that is, an Amazon S3 object) and creates an in-application table within
your application. In the request, you provide the source (S3 bucket name and object key
name), name of the in-application table to create, and the necessary mapping information
that describes how data in Amazon S3 object maps to columns in the resulting in-application
table. For conceptual information, see Configuring Application Input. For the limits on
data sources you can add to your application, see Limits. This operation requires
permissions to perform the kinesisanalytics:AddApplicationOutput action.
# Arguments
- `application_name`: Name of an existing application.
- `current_application_version_id`: Version of the application for which you are adding the
reference data source. You can use the DescribeApplication operation to get the current
application version. If the version specified is not the current version, the
ConcurrentModificationException is returned.
- `reference_data_source`: The reference data source can be an object in your Amazon S3
bucket. Amazon Kinesis Analytics reads the object and copies the data into the
in-application table that is created. You provide an S3 bucket, object key name, and the
resulting in-application table that is created. You must also provide an IAM role with the
necessary permissions that Amazon Kinesis Analytics can assume to read the object from your
S3 bucket on your behalf.
"""
function add_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceDataSource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationReferenceDataSource",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceDataSource" => ReferenceDataSource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceDataSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"AddApplicationReferenceDataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceDataSource" => ReferenceDataSource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(application_name)
create_application(application_name, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Creates an Amazon Kinesis Analytics application. You can configure each application with
one streaming source as input, application code to process the input, and up to three
destinations where you want Amazon Kinesis Analytics to write the output data from your
application. For an overview, see How it Works. In the input configuration, you map the
streaming source to an in-application stream, which you can think of as a constantly
updating table. In the mapping, you must provide a schema for the in-application stream and
map each data column in the in-application stream to a data element in the streaming
source. Your application code is one or more SQL statements that read input data, transform
it, and generate output. Your application code can create one or more SQL artifacts like
SQL streams or pumps. In the output configuration, you can configure the application to
write data from in-application streams created in your applications to up to three
destinations. To read data from your source stream or write data to destination streams,
Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating
IAM roles. This operation requires permissions to perform the
kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon
Kinesis Analytics application, see Getting Started.
# Arguments
- `application_name`: Name of your Amazon Kinesis Analytics application (for example,
sample-app).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationCode"`: One or more SQL statements that read input data, transform it, and
generate output. For example, you can write a SQL statement that reads data from one
in-application stream, generates a running average of the number of advertisement clicks by
vendor, and insert resulting rows in another in-application stream using pumps. For more
information about the typical pattern, see Application Code. You can provide such series
of SQL statements, where output of one statement can be used as the input for the next
statement. You store intermediate results by creating in-application streams and pumps.
Note that the application code must create the streams with names specified in the Outputs.
For example, if your Outputs defines output streams named ExampleOutputStream1 and
ExampleOutputStream2, then your application code must create these streams.
- `"ApplicationDescription"`: Summary description of the application.
- `"CloudWatchLoggingOptions"`: Use this parameter to configure a CloudWatch log stream to
monitor application configuration errors. For more information, see Working with Amazon
CloudWatch Logs.
- `"Inputs"`: Use this parameter to configure the application input. You can configure your
application to receive input from a single streaming source. In this configuration, you map
this streaming source to an in-application stream that is created. Your application code
can then query the in-application stream like a table (you can think of it as a constantly
updating table). For the streaming source, you provide its Amazon Resource Name (ARN) and
format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM
role that Amazon Kinesis Analytics can assume to read this stream on your behalf. To create
the in-application stream, you need to specify a schema to transform your data into a
schematized version used in SQL. In the schema, you provide the necessary mapping of the
data elements in the streaming source to record columns in the in-app stream.
- `"Outputs"`: You can configure application output to write data from any of the
in-application streams to up to three destinations. These destinations can be Amazon
Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any
combination of the three. In the configuration, you specify the in-application stream name,
the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use
when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can
assume to write to the destination stream or Lambda function on your behalf. In the output
configuration, you also provide the output stream or Lambda function ARN. For stream
destinations, you provide the format of data in the stream (for example, JSON, CSV). You
also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the
stream or Lambda function on your behalf.
- `"Tags"`: A list of one or more tags to assign to the application. A tag is a key-value
pair that identifies an application. Note that the maximum number of application tags
includes system tags. The maximum number of user-defined application tags is 50. For more
information, see Using Tagging.
"""
function create_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"CreateApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"CreateApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_name, create_timestamp)
delete_application(application_name, create_timestamp, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Deletes the specified application. Amazon Kinesis Analytics halts application execution and
deletes the application, including any application artifacts (such as in-application
streams, reference table, and application code). This operation requires permissions to
perform the kinesisanalytics:DeleteApplication action.
# Arguments
- `application_name`: Name of the Amazon Kinesis Analytics application to delete.
- `create_timestamp`: You can use the DescribeApplication operation to get this value.
"""
function delete_application(
ApplicationName, CreateTimestamp; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"DeleteApplication",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "CreateTimestamp" => CreateTimestamp
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
ApplicationName,
CreateTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CreateTimestamp" => CreateTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option_id, current_application_version_id)
delete_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option_id, current_application_version_id, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Deletes a CloudWatch log stream from an application. For more information about using
CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon
CloudWatch Logs.
# Arguments
- `application_name`: The Kinesis Analytics application name.
- `cloud_watch_logging_option_id`: The CloudWatchLoggingOptionId of the CloudWatch logging
option to delete. You can get the CloudWatchLoggingOptionId by using the
DescribeApplication operation.
- `current_application_version_id`: The version ID of the Kinesis Analytics application.
"""
function delete_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOptionId,
CurrentApplicationVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationCloudWatchLoggingOption",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOptionId" => CloudWatchLoggingOptionId,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOptionId,
CurrentApplicationVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationCloudWatchLoggingOption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOptionId" => CloudWatchLoggingOptionId,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_input_processing_configuration(application_name, current_application_version_id, input_id)
delete_application_input_processing_configuration(application_name, current_application_version_id, input_id, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Deletes an InputProcessingConfiguration from an input.
# Arguments
- `application_name`: The Kinesis Analytics application name.
- `current_application_version_id`: The version ID of the Kinesis Analytics application.
- `input_id`: The ID of the input configuration from which to delete the input processing
configuration. You can get a list of the input IDs for an application by using the
DescribeApplication operation.
"""
function delete_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationInputProcessingConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationInputProcessingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_output(application_name, current_application_version_id, output_id)
delete_application_output(application_name, current_application_version_id, output_id, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Deletes output destination configuration from your application configuration. Amazon
Kinesis Analytics will no longer write data from the corresponding in-application stream to
the external output destination. This operation requires permissions to perform the
kinesisanalytics:DeleteApplicationOutput action.
# Arguments
- `application_name`: Amazon Kinesis Analytics application name.
- `current_application_version_id`: Amazon Kinesis Analytics application version. You can
use the DescribeApplication operation to get the current application version. If the
version specified is not the current version, the ConcurrentModificationException is
returned.
- `output_id`: The ID of the configuration to delete. Each output configuration that is
added to the application, either when the application is created or later using the
AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely
identify the output configuration that you want to delete from the application
configuration. You can use the DescribeApplication operation to get the specific OutputId.
"""
function delete_application_output(
ApplicationName,
CurrentApplicationVersionId,
OutputId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationOutput",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"OutputId" => OutputId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_output(
ApplicationName,
CurrentApplicationVersionId,
OutputId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationOutput",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"OutputId" => OutputId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_reference_data_source(application_name, current_application_version_id, reference_id)
delete_application_reference_data_source(application_name, current_application_version_id, reference_id, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Deletes a reference data source configuration from the specified application configuration.
If the application is running, Amazon Kinesis Analytics immediately removes the
in-application table that you created using the AddApplicationReferenceDataSource
operation. This operation requires permissions to perform the
kinesisanalytics.DeleteApplicationReferenceDataSource action.
# Arguments
- `application_name`: Name of an existing application.
- `current_application_version_id`: Version of the application. You can use the
DescribeApplication operation to get the current application version. If the version
specified is not the current version, the ConcurrentModificationException is returned.
- `reference_id`: ID of the reference data source. When you add a reference data source to
your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics
assigns an ID. You can use the DescribeApplication operation to get the reference ID.
"""
function delete_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationReferenceDataSource",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceId" => ReferenceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DeleteApplicationReferenceDataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceId" => ReferenceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application(application_name)
describe_application(application_name, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Returns information about a specific Amazon Kinesis Analytics application. If you want to
retrieve a list of all applications in your account, use the ListApplications operation.
This operation requires permissions to perform the kinesisanalytics:DescribeApplication
action. You can use DescribeApplication to get the current application versionId, which you
need to call other operations such as Update.
# Arguments
- `application_name`: Name of the application.
"""
function describe_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"DescribeApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"DescribeApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
discover_input_schema()
discover_input_schema(params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Infers a schema by evaluating sample records on the specified streaming source (Amazon
Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response,
the operation returns the inferred schema and also the sample records that the operation
used to infer the schema. You can use the inferred schema when configuring a streaming
source for your application. For conceptual information, see Configuring Application Input.
Note that when you create an application using the Amazon Kinesis Analytics console, the
console uses this operation to infer a schema and show it in the console user interface.
This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema
action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InputProcessingConfiguration"`: The InputProcessingConfiguration to use to preprocess
the records before discovering the schema of the records.
- `"InputStartingPositionConfiguration"`: Point at which you want Amazon Kinesis Analytics
to start reading records from the specified streaming source discovery purposes.
- `"ResourceARN"`: Amazon Resource Name (ARN) of the streaming source.
- `"RoleARN"`: ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
stream on your behalf.
- `"S3Configuration"`: Specify this parameter to discover a schema from data in an Amazon
S3 object.
"""
function discover_input_schema(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_analytics(
"DiscoverInputSchema"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function discover_input_schema(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"DiscoverInputSchema",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Returns a list of Amazon Kinesis Analytics applications in your account. For each
application, the response includes the application name, Amazon Resource Name (ARN), and
status. If the response returns the HasMoreApplications value as true, you can send another
request by adding the ExclusiveStartApplicationName in the request body, and set the value
of this to the last application name from the previous response. If you want detailed
information about a specific application, use DescribeApplication. This operation requires
permissions to perform the kinesisanalytics:ListApplications action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartApplicationName"`: Name of the application to start the list with. When
using pagination to retrieve the list, you don't need to specify this parameter in the
first request. However, in subsequent requests, you add the last application name from the
previous response to get the next page of applications.
- `"Limit"`: Maximum number of applications to list.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_analytics(
"ListApplications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"ListApplications", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the list of key-value tags assigned to the application. For more information, see
Using Tagging.
# Arguments
- `resource_arn`: The ARN of the application for which to retrieve tags.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_application(application_name, input_configurations)
start_application(application_name, input_configurations, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Starts the specified Amazon Kinesis Analytics application. After creating an application,
you must exclusively call this operation to start your application. After the application
starts, it begins consuming the input data, processes it, and writes the output to the
configured destination. The application status must be READY for you to start an
application. You can get the application status in the console or using the
DescribeApplication operation. After you start the application, you can stop the
application from processing the input by calling the StopApplication operation. This
operation requires permissions to perform the kinesisanalytics:StartApplication action.
# Arguments
- `application_name`: Name of the application.
- `input_configurations`: Identifies the specific input, by ID, that the application starts
consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the
input. You can also specify where in the streaming source you want Amazon Kinesis Analytics
to start reading.
"""
function start_application(
ApplicationName, InputConfigurations; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"StartApplication",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"InputConfigurations" => InputConfigurations,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_application(
ApplicationName,
InputConfigurations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"StartApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"InputConfigurations" => InputConfigurations,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_application(application_name)
stop_application(application_name, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Stops the application from processing input data. You can stop an application only if it is
in the running state. You can use the DescribeApplication operation to find the application
state. After the application is stopped, Amazon Kinesis Analytics stops reading data from
the input, the application stops processing data, and there is no output written to the
destination. This operation requires permissions to perform the
kinesisanalytics:StopApplication action.
# Arguments
- `application_name`: Name of the running application to stop.
"""
function stop_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"StopApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"StopApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum
number of application tags includes system tags. The maximum number of user-defined
application tags is 50. For more information, see Using Tagging.
# Arguments
- `resource_arn`: The ARN of the application to assign the tags.
- `tags`: The key-value tags to assign to the application.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_analytics(
"TagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from a Kinesis Analytics application. For more information, see
Using Tagging.
# Arguments
- `resource_arn`: The ARN of the Kinesis Analytics application from which to remove the
tags.
- `tag_keys`: A list of keys of tags to remove from the specified application.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics(
"UntagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_name, application_update, current_application_version_id)
update_application(application_name, application_update, current_application_version_id, params::Dict{String,<:Any})
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only
supports SQL applications. Version 2 of the API supports SQL and Java applications. For
more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Updates an existing Amazon Kinesis Analytics application. Using this API, you can update
application code, input configuration, and output configuration. Note that Amazon Kinesis
Analytics updates the CurrentApplicationVersionId each time you update your application.
This operation requires permission for the kinesisanalytics:UpdateApplication action.
# Arguments
- `application_name`: Name of the Amazon Kinesis Analytics application to update.
- `application_update`: Describes application updates.
- `current_application_version_id`: The current application version ID. You can use the
DescribeApplication operation to get this value.
"""
function update_application(
ApplicationName,
ApplicationUpdate,
CurrentApplicationVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"UpdateApplication",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"ApplicationUpdate" => ApplicationUpdate,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
ApplicationName,
ApplicationUpdate,
CurrentApplicationVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics(
"UpdateApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"ApplicationUpdate" => ApplicationUpdate,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 64121 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_analytics_v2
using AWS.Compat
using AWS.UUIDs
"""
add_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option)
add_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option, params::Dict{String,<:Any})
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
# Arguments
- `application_name`: The Kinesis Data Analytics application name.
- `cloud_watch_logging_option`: Provides the Amazon CloudWatch log stream Amazon Resource
Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionalToken"`: A value you use to implement strong concurrency for application
updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get
the application's current ConditionalToken using DescribeApplication. For better
concurrency support, use the ConditionalToken parameter instead of
CurrentApplicationVersionId.
- `"CurrentApplicationVersionId"`: The version ID of the SQL-based Kinesis Data Analytics
application. You must provide the CurrentApplicationVersionId or the ConditionalToken.You
can retrieve the application version ID using DescribeApplication. For better concurrency
support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
"""
function add_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOption;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationCloudWatchLoggingOption",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOption" => CloudWatchLoggingOption,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOption,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationCloudWatchLoggingOption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOption" => CloudWatchLoggingOption,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_input(application_name, current_application_version_id, input)
add_application_input(application_name, current_application_version_id, input, params::Dict{String,<:Any})
Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add
a streaming source when you create an application, or you can use this operation to add a
streaming source after you create an application. For more information, see
CreateApplication. Any configuration update, including adding a streaming source using this
operation, results in a new version of the application. You can use the DescribeApplication
operation to find the current application version.
# Arguments
- `application_name`: The name of your existing application to which you want to add the
streaming source.
- `current_application_version_id`: The current version of your application. You must
provide the ApplicationVersionID or the ConditionalToken.You can use the
DescribeApplication operation to find the current application version.
- `input`: The Input to add.
"""
function add_application_input(
ApplicationName,
CurrentApplicationVersionId,
Input;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationInput",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Input" => Input,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_input(
ApplicationName,
CurrentApplicationVersionId,
Input,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationInput",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Input" => Input,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_input_processing_configuration(application_name, current_application_version_id, input_id, input_processing_configuration)
add_application_input_processing_configuration(application_name, current_application_version_id, input_id, input_processing_configuration, params::Dict{String,<:Any})
Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An
input processor pre-processes records on the input stream before the application's SQL code
executes. Currently, the only input processor available is Amazon Lambda.
# Arguments
- `application_name`: The name of the application to which you want to add the input
processing configuration.
- `current_application_version_id`: The version of the application to which you want to add
the input processing configuration. You can use the DescribeApplication operation to get
the current application version. If the version specified is not the current version, the
ConcurrentModificationException is returned.
- `input_id`: The ID of the input configuration to add the input processing configuration
to. You can get a list of the input IDs for an application using the DescribeApplication
operation.
- `input_processing_configuration`: The InputProcessingConfiguration to add to the
application.
"""
function add_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId,
InputProcessingConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationInputProcessingConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
"InputProcessingConfiguration" => InputProcessingConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId,
InputProcessingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationInputProcessingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
"InputProcessingConfiguration" => InputProcessingConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_output(application_name, current_application_version_id, output)
add_application_output(application_name, current_application_version_id, output, params::Dict{String,<:Any})
Adds an external destination to your SQL-based Kinesis Data Analytics application. If you
want Kinesis Data Analytics to deliver data from an in-application stream within your
application to an external destination (such as an Kinesis data stream, a Kinesis Data
Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration
to your application using this operation. You can configure one or more outputs for your
application. Each output configuration maps an in-application stream and an external
destination. You can use one of the output configurations to deliver data from your
in-application error stream to an external destination so that you can analyze the errors.
Any configuration update, including adding a streaming source using this operation,
results in a new version of the application. You can use the DescribeApplication operation
to find the current application version.
# Arguments
- `application_name`: The name of the application to which you want to add the output
configuration.
- `current_application_version_id`: The version of the application to which you want to add
the output configuration. You can use the DescribeApplication operation to get the current
application version. If the version specified is not the current version, the
ConcurrentModificationException is returned.
- `output`: An array of objects, each describing one output configuration. In the output
configuration, you specify the name of an in-application stream, a destination (that is, a
Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda
function), and record the formation to use when writing to the destination.
"""
function add_application_output(
ApplicationName,
CurrentApplicationVersionId,
Output;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationOutput",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Output" => Output,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_output(
ApplicationName,
CurrentApplicationVersionId,
Output,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationOutput",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"Output" => Output,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_reference_data_source(application_name, current_application_version_id, reference_data_source)
add_application_reference_data_source(application_name, current_application_version_id, reference_data_source, params::Dict{String,<:Any})
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an
in-application table within your application. In the request, you provide the source (S3
bucket name and object key name), name of the in-application table to create, and the
necessary mapping information that describes how data in an Amazon S3 object maps to
columns in the resulting in-application table.
# Arguments
- `application_name`: The name of an existing application.
- `current_application_version_id`: The version of the application for which you are adding
the reference data source. You can use the DescribeApplication operation to get the current
application version. If the version specified is not the current version, the
ConcurrentModificationException is returned.
- `reference_data_source`: The reference data source can be an object in your Amazon S3
bucket. Kinesis Data Analytics reads the object and copies the data into the in-application
table that is created. You provide an S3 bucket, object key name, and the resulting
in-application table that is created.
"""
function add_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceDataSource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationReferenceDataSource",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceDataSource" => ReferenceDataSource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceDataSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationReferenceDataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceDataSource" => ReferenceDataSource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_application_vpc_configuration(application_name, vpc_configuration)
add_application_vpc_configuration(application_name, vpc_configuration, params::Dict{String,<:Any})
Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use
VPCs to store and access resources securely. Note the following about VPC configurations
for Managed Service for Apache Flink applications: VPC configurations are not supported
for SQL applications. When a VPC is added to a Managed Service for Apache Flink
application, the application can no longer be accessed from the Internet directly. To
enable Internet access to the application, add an Internet gateway to your VPC.
# Arguments
- `application_name`: The name of an existing application.
- `vpc_configuration`: Description of the VPC to add to the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionalToken"`: A value you use to implement strong concurrency for application
updates. You must provide the ApplicationVersionID or the ConditionalToken. You get the
application's current ConditionalToken using DescribeApplication. For better concurrency
support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
- `"CurrentApplicationVersionId"`: The version of the application to which you want to add
the VPC configuration. You must provide the CurrentApplicationVersionId or the
ConditionalToken. You can use the DescribeApplication operation to get the current
application version. If the version specified is not the current version, the
ConcurrentModificationException is returned. For better concurrency support, use the
ConditionalToken parameter instead of CurrentApplicationVersionId.
"""
function add_application_vpc_configuration(
ApplicationName, VpcConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"AddApplicationVpcConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VpcConfiguration" => VpcConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_application_vpc_configuration(
ApplicationName,
VpcConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"AddApplicationVpcConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"VpcConfiguration" => VpcConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(application_name, runtime_environment, service_execution_role)
create_application(application_name, runtime_environment, service_execution_role, params::Dict{String,<:Any})
Creates a Managed Service for Apache Flink application. For information about creating a
Managed Service for Apache Flink application, see Creating an Application.
# Arguments
- `application_name`: The name of your application (for example, sample-app).
- `runtime_environment`: The runtime environment for the application.
- `service_execution_role`: The IAM role used by the application to access Kinesis data
streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external
resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationConfiguration"`: Use this parameter to configure the application.
- `"ApplicationDescription"`: A summary description of the application.
- `"ApplicationMode"`: Use the STREAMING mode to create a Managed Service for Apache Flink
application. To create a Managed Service for Apache Flink Studio notebook, use the
INTERACTIVE mode.
- `"CloudWatchLoggingOptions"`: Use this parameter to configure an Amazon CloudWatch log
stream to monitor application configuration errors.
- `"Tags"`: A list of one or more tags to assign to the application. A tag is a key-value
pair that identifies an application. Note that the maximum number of application tags
includes system tags. The maximum number of user-defined application tags is 50. For more
information, see Using Tagging.
"""
function create_application(
ApplicationName,
RuntimeEnvironment,
ServiceExecutionRole;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"CreateApplication",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"RuntimeEnvironment" => RuntimeEnvironment,
"ServiceExecutionRole" => ServiceExecutionRole,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
ApplicationName,
RuntimeEnvironment,
ServiceExecutionRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"CreateApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"RuntimeEnvironment" => RuntimeEnvironment,
"ServiceExecutionRole" => ServiceExecutionRole,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application_presigned_url(application_name, url_type)
create_application_presigned_url(application_name, url_type, params::Dict{String,<:Any})
Creates and returns a URL that you can use to connect to an application's extension. The
IAM role or user used to call this API defines the permissions to access the extension.
After the presigned URL is created, no additional permission is required to access this
URL. IAM authorization policies for this API are also enforced for every HTTP request that
attempts to connect to the extension. You control the amount of time that the URL will be
valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this
parameter, the returned URL is valid for twelve hours. The URL that you get from a call to
CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try
to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden
error.
# Arguments
- `application_name`: The name of the application.
- `url_type`: The type of the extension for which to create and return a URL. Currently,
the only valid extension URL type is FLINK_DASHBOARD_URL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SessionExpirationDurationInSeconds"`: The duration in seconds for which the returned
URL will be valid.
"""
function create_application_presigned_url(
ApplicationName, UrlType; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"CreateApplicationPresignedUrl",
Dict{String,Any}("ApplicationName" => ApplicationName, "UrlType" => UrlType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application_presigned_url(
ApplicationName,
UrlType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"CreateApplicationPresignedUrl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "UrlType" => UrlType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application_snapshot(application_name, snapshot_name)
create_application_snapshot(application_name, snapshot_name, params::Dict{String,<:Any})
Creates a snapshot of the application's state data.
# Arguments
- `application_name`: The name of an existing application
- `snapshot_name`: An identifier for the application snapshot.
"""
function create_application_snapshot(
ApplicationName, SnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"CreateApplicationSnapshot",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "SnapshotName" => SnapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application_snapshot(
ApplicationName,
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"CreateApplicationSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "SnapshotName" => SnapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_name, create_timestamp)
delete_application(application_name, create_timestamp, params::Dict{String,<:Any})
Deletes the specified application. Managed Service for Apache Flink halts application
execution and deletes the application.
# Arguments
- `application_name`: The name of the application to delete.
- `create_timestamp`: Use the DescribeApplication operation to get this value.
"""
function delete_application(
ApplicationName, CreateTimestamp; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"DeleteApplication",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "CreateTimestamp" => CreateTimestamp
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
ApplicationName,
CreateTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CreateTimestamp" => CreateTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option_id)
delete_application_cloud_watch_logging_option(application_name, cloud_watch_logging_option_id, params::Dict{String,<:Any})
Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics
application.
# Arguments
- `application_name`: The application name.
- `cloud_watch_logging_option_id`: The CloudWatchLoggingOptionId of the Amazon CloudWatch
logging option to delete. You can get the CloudWatchLoggingOptionId by using the
DescribeApplication operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionalToken"`: A value you use to implement strong concurrency for application
updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get
the application's current ConditionalToken using DescribeApplication. For better
concurrency support, use the ConditionalToken parameter instead of
CurrentApplicationVersionId.
- `"CurrentApplicationVersionId"`: The version ID of the application. You must provide the
CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application
version ID using DescribeApplication. For better concurrency support, use the
ConditionalToken parameter instead of CurrentApplicationVersionId.
"""
function delete_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOptionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationCloudWatchLoggingOption",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOptionId" => CloudWatchLoggingOptionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_cloud_watch_logging_option(
ApplicationName,
CloudWatchLoggingOptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationCloudWatchLoggingOption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CloudWatchLoggingOptionId" => CloudWatchLoggingOptionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_input_processing_configuration(application_name, current_application_version_id, input_id)
delete_application_input_processing_configuration(application_name, current_application_version_id, input_id, params::Dict{String,<:Any})
Deletes an InputProcessingConfiguration from an input.
# Arguments
- `application_name`: The name of the application.
- `current_application_version_id`: The application version. You can use the
DescribeApplication operation to get the current application version. If the version
specified is not the current version, the ConcurrentModificationException is returned.
- `input_id`: The ID of the input configuration from which to delete the input processing
configuration. You can get a list of the input IDs for an application by using the
DescribeApplication operation.
"""
function delete_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationInputProcessingConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_input_processing_configuration(
ApplicationName,
CurrentApplicationVersionId,
InputId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationInputProcessingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"InputId" => InputId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_output(application_name, current_application_version_id, output_id)
delete_application_output(application_name, current_application_version_id, output_id, params::Dict{String,<:Any})
Deletes the output destination configuration from your SQL-based Kinesis Data Analytics
application's configuration. Kinesis Data Analytics will no longer write data from the
corresponding in-application stream to the external output destination.
# Arguments
- `application_name`: The application name.
- `current_application_version_id`: The application version. You can use the
DescribeApplication operation to get the current application version. If the version
specified is not the current version, the ConcurrentModificationException is returned.
- `output_id`: The ID of the configuration to delete. Each output configuration that is
added to the application (either when the application is created or later) using the
AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely
identify the output configuration that you want to delete from the application
configuration. You can use the DescribeApplication operation to get the specific OutputId.
"""
function delete_application_output(
ApplicationName,
CurrentApplicationVersionId,
OutputId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationOutput",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"OutputId" => OutputId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_output(
ApplicationName,
CurrentApplicationVersionId,
OutputId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationOutput",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"OutputId" => OutputId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_reference_data_source(application_name, current_application_version_id, reference_id)
delete_application_reference_data_source(application_name, current_application_version_id, reference_id, params::Dict{String,<:Any})
Deletes a reference data source configuration from the specified SQL-based Kinesis Data
Analytics application's configuration. If the application is running, Kinesis Data
Analytics immediately removes the in-application table that you created using the
AddApplicationReferenceDataSource operation.
# Arguments
- `application_name`: The name of an existing application.
- `current_application_version_id`: The current application version. You can use the
DescribeApplication operation to get the current application version. If the version
specified is not the current version, the ConcurrentModificationException is returned.
- `reference_id`: The ID of the reference data source. When you add a reference data source
to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics
assigns an ID. You can use the DescribeApplication operation to get the reference ID.
"""
function delete_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationReferenceDataSource",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceId" => ReferenceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_reference_data_source(
ApplicationName,
CurrentApplicationVersionId,
ReferenceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationReferenceDataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
"ReferenceId" => ReferenceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_snapshot(application_name, snapshot_creation_timestamp, snapshot_name)
delete_application_snapshot(application_name, snapshot_creation_timestamp, snapshot_name, params::Dict{String,<:Any})
Deletes a snapshot of application state.
# Arguments
- `application_name`: The name of an existing application.
- `snapshot_creation_timestamp`: The creation timestamp of the application snapshot to
delete. You can retrieve this value using or .
- `snapshot_name`: The identifier for the snapshot delete.
"""
function delete_application_snapshot(
ApplicationName,
SnapshotCreationTimestamp,
SnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationSnapshot",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"SnapshotCreationTimestamp" => SnapshotCreationTimestamp,
"SnapshotName" => SnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_snapshot(
ApplicationName,
SnapshotCreationTimestamp,
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"SnapshotCreationTimestamp" => SnapshotCreationTimestamp,
"SnapshotName" => SnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_vpc_configuration(application_name, vpc_configuration_id)
delete_application_vpc_configuration(application_name, vpc_configuration_id, params::Dict{String,<:Any})
Removes a VPC configuration from a Managed Service for Apache Flink application.
# Arguments
- `application_name`: The name of an existing application.
- `vpc_configuration_id`: The ID of the VPC configuration to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionalToken"`: A value you use to implement strong concurrency for application
updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get
the application's current ConditionalToken using DescribeApplication. For better
concurrency support, use the ConditionalToken parameter instead of
CurrentApplicationVersionId.
- `"CurrentApplicationVersionId"`: The current application version ID. You must provide the
CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application
version ID using DescribeApplication. For better concurrency support, use the
ConditionalToken parameter instead of CurrentApplicationVersionId.
"""
function delete_application_vpc_configuration(
ApplicationName, VpcConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"DeleteApplicationVpcConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VpcConfigurationId" => VpcConfigurationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_vpc_configuration(
ApplicationName,
VpcConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DeleteApplicationVpcConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"VpcConfigurationId" => VpcConfigurationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application(application_name)
describe_application(application_name, params::Dict{String,<:Any})
Returns information about a specific Managed Service for Apache Flink application. If you
want to retrieve a list of all applications in your account, use the ListApplications
operation.
# Arguments
- `application_name`: The name of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeAdditionalDetails"`: Displays verbose information about a Managed Service for
Apache Flink application, including the application's job plan.
"""
function describe_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"DescribeApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DescribeApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_snapshot(application_name, snapshot_name)
describe_application_snapshot(application_name, snapshot_name, params::Dict{String,<:Any})
Returns information about a snapshot of application state data.
# Arguments
- `application_name`: The name of an existing application.
- `snapshot_name`: The identifier of an application snapshot. You can retrieve this value
using .
"""
function describe_application_snapshot(
ApplicationName, SnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"DescribeApplicationSnapshot",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "SnapshotName" => SnapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_snapshot(
ApplicationName,
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DescribeApplicationSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "SnapshotName" => SnapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_version(application_name, application_version_id)
describe_application_version(application_name, application_version_id, params::Dict{String,<:Any})
Provides a detailed description of a specified version of the application. To see a list of
all the versions of an application, invoke the ListApplicationVersions operation. This
operation is supported only for Managed Service for Apache Flink.
# Arguments
- `application_name`: The name of the application for which you want to get the version
description.
- `application_version_id`: The ID of the application version for which you want to get the
description.
"""
function describe_application_version(
ApplicationName, ApplicationVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"DescribeApplicationVersion",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"ApplicationVersionId" => ApplicationVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_version(
ApplicationName,
ApplicationVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DescribeApplicationVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"ApplicationVersionId" => ApplicationVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
discover_input_schema(service_execution_role)
discover_input_schema(service_execution_role, params::Dict{String,<:Any})
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample
records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose
delivery stream) or Amazon S3 object. In the response, the operation returns the inferred
schema and also the sample records that the operation used to infer the schema. You can
use the inferred schema when configuring a streaming source for your application. When you
create an application using the Kinesis Data Analytics console, the console uses this
operation to infer a schema and show it in the console user interface.
# Arguments
- `service_execution_role`: The ARN of the role that is used to access the streaming source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InputProcessingConfiguration"`: The InputProcessingConfiguration to use to preprocess
the records before discovering the schema of the records.
- `"InputStartingPositionConfiguration"`: The point at which you want Kinesis Data
Analytics to start reading records from the specified streaming source for discovery
purposes.
- `"ResourceARN"`: The Amazon Resource Name (ARN) of the streaming source.
- `"S3Configuration"`: Specify this parameter to discover a schema from data in an Amazon
S3 object.
"""
function discover_input_schema(
ServiceExecutionRole; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"DiscoverInputSchema",
Dict{String,Any}("ServiceExecutionRole" => ServiceExecutionRole);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function discover_input_schema(
ServiceExecutionRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"DiscoverInputSchema",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServiceExecutionRole" => ServiceExecutionRole),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_snapshots(application_name)
list_application_snapshots(application_name, params::Dict{String,<:Any})
Lists information about the current application snapshots.
# Arguments
- `application_name`: The name of an existing application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of application snapshots to list.
- `"NextToken"`: Use this parameter if you receive a NextToken response in a previous
request that indicates that there is more output available. Set it to the value of the
previous call's NextToken response to indicate where the output should continue from.
"""
function list_application_snapshots(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"ListApplicationSnapshots",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_snapshots(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"ListApplicationSnapshots",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_versions(application_name)
list_application_versions(application_name, params::Dict{String,<:Any})
Lists all the versions for the specified application, including versions that were rolled
back. The response also includes a summary of the configuration associated with each
version. To get the complete description of a specific application version, invoke the
DescribeApplicationVersion operation. This operation is supported only for Managed Service
for Apache Flink.
# Arguments
- `application_name`: The name of the application for which you want to list all versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of versions to list in this invocation of the operation.
- `"NextToken"`: If a previous invocation of this operation returned a pagination token,
pass it into this value to retrieve the next set of results. For more information about
pagination, see Using the Amazon Command Line Interface's Pagination Options.
"""
function list_application_versions(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"ListApplicationVersions",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_versions(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"ListApplicationVersions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Returns a list of Managed Service for Apache Flink applications in your account. For each
application, the response includes the application name, Amazon Resource Name (ARN), and
status. If you want detailed information about a specific application, use
DescribeApplication.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of applications to list.
- `"NextToken"`: If a previous command returned a pagination token, pass it into this value
to retrieve the next set of results. For more information about pagination, see Using the
Amazon Command Line Interface's Pagination Options.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_analytics_v2(
"ListApplications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"ListApplications", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the list of key-value tags assigned to the application. For more information, see
Using Tagging.
# Arguments
- `resource_arn`: The ARN of the application for which to retrieve tags.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rollback_application(application_name, current_application_version_id)
rollback_application(application_name, current_application_version_id, params::Dict{String,<:Any})
Reverts the application to the previous running version. You can roll back an application
if you suspect it is stuck in a transient status. You can roll back an application only if
it is in the UPDATING or AUTOSCALING status. When you rollback an application, it loads
state data from the last successful snapshot. If the application has no snapshots, Managed
Service for Apache Flink rejects the rollback request. This action is not supported for
Managed Service for Apache Flink for SQL applications.
# Arguments
- `application_name`: The name of the application.
- `current_application_version_id`: The current application version ID. You can retrieve
the application version ID using DescribeApplication.
"""
function rollback_application(
ApplicationName,
CurrentApplicationVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"RollbackApplication",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rollback_application(
ApplicationName,
CurrentApplicationVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"RollbackApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"CurrentApplicationVersionId" => CurrentApplicationVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_application(application_name)
start_application(application_name, params::Dict{String,<:Any})
Starts the specified Managed Service for Apache Flink application. After creating an
application, you must exclusively call this operation to start your application.
# Arguments
- `application_name`: The name of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RunConfiguration"`: Identifies the run configuration (start parameters) of a Managed
Service for Apache Flink application.
"""
function start_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"StartApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"StartApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_application(application_name)
stop_application(application_name, params::Dict{String,<:Any})
Stops the application from processing data. You can stop an application only if it is in
the running status, unless you set the Force parameter to true. You can use the
DescribeApplication operation to find the application status. Managed Service for Apache
Flink takes a snapshot when the application is stopped, unless Force is set to true.
# Arguments
- `application_name`: The name of the running application to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: Set to true to force the application to stop. If you set Force to true,
Managed Service for Apache Flink stops the application without taking a snapshot.
Force-stopping your application may lead to data loss or duplication. To prevent data loss
or duplicate processing of data during application restarts, we recommend you to take
frequent snapshots of your application. You can only force stop a Managed Service for
Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics
application. The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or
RUNNING status.
"""
function stop_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"StopApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"StopApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more key-value tags to a Managed Service for Apache Flink application. Note
that the maximum number of application tags includes system tags. The maximum number of
user-defined application tags is 50. For more information, see Using Tagging.
# Arguments
- `resource_arn`: The ARN of the application to assign the tags.
- `tags`: The key-value tags to assign to the application.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_analytics_v2(
"TagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from a Managed Service for Apache Flink application. For more
information, see Using Tagging.
# Arguments
- `resource_arn`: The ARN of the Managed Service for Apache Flink application from which to
remove the tags.
- `tag_keys`: A list of keys of tags to remove from the specified application.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"UntagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_name)
update_application(application_name, params::Dict{String,<:Any})
Updates an existing Managed Service for Apache Flink application. Using this operation, you
can update application code, input configuration, and output configuration. Managed
Service for Apache Flink updates the ApplicationVersionId each time you update your
application.
# Arguments
- `application_name`: The name of the application to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationConfigurationUpdate"`: Describes application configuration updates.
- `"CloudWatchLoggingOptionUpdates"`: Describes application Amazon CloudWatch logging
option updates. You can only update existing CloudWatch logging options with this action.
To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
- `"ConditionalToken"`: A value you use to implement strong concurrency for application
updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get
the application's current ConditionalToken using DescribeApplication. For better
concurrency support, use the ConditionalToken parameter instead of
CurrentApplicationVersionId.
- `"CurrentApplicationVersionId"`: The current application version ID. You must provide the
CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application
version ID using DescribeApplication. For better concurrency support, use the
ConditionalToken parameter instead of CurrentApplicationVersionId.
- `"RunConfigurationUpdate"`: Describes updates to the application's starting parameters.
- `"RuntimeEnvironmentUpdate"`: Updates the Managed Service for Apache Flink runtime
environment used to run your code. To avoid issues you must: Ensure your new jar and
dependencies are compatible with the new runtime selected. Ensure your new code's state
is compatible with the snapshot from which your application will start
- `"ServiceExecutionRoleUpdate"`: Describes updates to the service execution role.
"""
function update_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_analytics_v2(
"UpdateApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"UpdateApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application_maintenance_configuration(application_maintenance_configuration_update, application_name)
update_application_maintenance_configuration(application_maintenance_configuration_update, application_name, params::Dict{String,<:Any})
Updates the maintenance configuration of the Managed Service for Apache Flink application.
You can invoke this operation on an application that is in one of the two following states:
READY or RUNNING. If you invoke it when the application is in a state other than these two
states, it throws a ResourceInUseException. The service makes use of the updated
configuration the next time it schedules maintenance for the application. If you invoke
this operation after the service schedules maintenance, the service will apply the
configuration update the next time it schedules maintenance for the application. This means
that you might not see the maintenance configuration update applied to the maintenance
process that follows a successful invocation of this operation, but to the following
maintenance process instead. To see the current maintenance configuration of your
application, invoke the DescribeApplication operation. For information about application
maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance. This
operation is supported only for Managed Service for Apache Flink.
# Arguments
- `application_maintenance_configuration_update`: Describes the application maintenance
configuration update.
- `application_name`: The name of the application for which you want to update the
maintenance configuration.
"""
function update_application_maintenance_configuration(
ApplicationMaintenanceConfigurationUpdate,
ApplicationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"UpdateApplicationMaintenanceConfiguration",
Dict{String,Any}(
"ApplicationMaintenanceConfigurationUpdate" =>
ApplicationMaintenanceConfigurationUpdate,
"ApplicationName" => ApplicationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_maintenance_configuration(
ApplicationMaintenanceConfigurationUpdate,
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_analytics_v2(
"UpdateApplicationMaintenanceConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationMaintenanceConfigurationUpdate" =>
ApplicationMaintenanceConfigurationUpdate,
"ApplicationName" => ApplicationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 49450 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_video
using AWS.Compat
using AWS.UUIDs
"""
create_signaling_channel(channel_name)
create_signaling_channel(channel_name, params::Dict{String,<:Any})
Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.
# Arguments
- `channel_name`: A name for the signaling channel that you are creating. It must be unique
for each Amazon Web Services account and Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChannelType"`: A type of the signaling channel that you are creating. Currently,
SINGLE_MASTER is the only supported channel type.
- `"SingleMasterConfiguration"`: A structure containing the configuration for the
SINGLE_MASTER channel type.
- `"Tags"`: A set of tags (key-value pairs) that you want to associate with this channel.
"""
function create_signaling_channel(
ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/createSignalingChannel",
Dict{String,Any}("ChannelName" => ChannelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_signaling_channel(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/createSignalingChannel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChannelName" => ChannelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stream(stream_name)
create_stream(stream_name, params::Dict{String,<:Any})
Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams
assigns it a version number. When you change the stream's metadata, Kinesis Video Streams
updates the version. CreateStream is an asynchronous operation. For information about how
the service works, see How it Works. You must have permissions for the
KinesisVideo:CreateStream action.
# Arguments
- `stream_name`: A name for the stream that you are creating. The stream name is an
identifier for the stream, and must be unique for each account and region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataRetentionInHours"`: The number of hours that you want to retain the data in the
stream. Kinesis Video Streams retains the data in a data store that is associated with the
stream. The default value is 0, indicating that the stream does not persist data. When the
DataRetentionInHours value is 0, consumers can still consume the fragments that remain in
the service host buffer, which has a retention time limit of 5 minutes and a retention
memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.
- `"DeviceName"`: The name of the device that is writing to the stream. In the current
implementation, Kinesis Video Streams does not use this name.
- `"KmsKeyId"`: The ID of the Key Management Service (KMS) key that you want Kinesis Video
Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis
Video-managed key (Amazon Web Services/kinesisvideo) is used. For more information, see
DescribeKey.
- `"MediaType"`: The media type of the stream. Consumers of the stream can use this
information when processing the stream. For more information about media types, see Media
Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.
Example valid values include \"video/h264\" and \"video/h264,audio/aac\". This parameter is
optional; the default value is null (or empty in JSON).
- `"Tags"`: A list of tags to associate with the specified stream. Each tag is a key-value
pair (the value is optional).
"""
function create_stream(StreamName; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/createStream",
Dict{String,Any}("StreamName" => StreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_stream(
StreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/createStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StreamName" => StreamName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_edge_configuration()
delete_edge_configuration(params::Dict{String,<:Any})
An asynchronous API that deletes a stream’s existing edge configuration, as well as the
corresponding media from the Edge Agent. When you invoke this API, the sync status is set
to DELETING. A deletion process starts, in which active edge jobs are stopped and all media
is deleted from the edge device. The time to delete varies, depending on the total amount
of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED.
You will need to re-try the deletion. When the deletion process has completed successfully,
the edge configuration is no longer accessible.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream. Specify either the
StreamName or the StreamARN.
- `"StreamName"`: The name of the stream from which to delete the edge configuration.
Specify either the StreamName or the StreamARN.
"""
function delete_edge_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/deleteEdgeConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_edge_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/deleteEdgeConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_signaling_channel(channel_arn)
delete_signaling_channel(channel_arn, params::Dict{String,<:Any})
Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation.
If you don't specify the channel's current version, the most recent version is deleted.
# Arguments
- `channel_arn`: The Amazon Resource Name (ARN) of the signaling channel that you want to
delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CurrentVersion"`: The current version of the signaling channel that you want to delete.
You can obtain the current version by invoking the DescribeSignalingChannel or
ListSignalingChannels API operations.
"""
function delete_signaling_channel(
ChannelARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/deleteSignalingChannel",
Dict{String,Any}("ChannelARN" => ChannelARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_signaling_channel(
ChannelARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/deleteSignalingChannel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChannelARN" => ChannelARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stream(stream_arn)
delete_stream(stream_arn, params::Dict{String,<:Any})
Deletes a Kinesis video stream and the data contained in the stream. This method marks the
stream for deletion, and makes the data in the stream inaccessible immediately. To
ensure that you have the latest version of the stream before deleting it, you can specify
the stream version. Kinesis Video Streams assigns a version to each stream. When you update
a stream, Kinesis Video Streams assigns a new version number. To get the latest stream
version, use the DescribeStream API. This operation requires permission for the
KinesisVideo:DeleteStream action.
# Arguments
- `stream_arn`: The Amazon Resource Name (ARN) of the stream that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CurrentVersion"`: Optional: The version of the stream that you want to delete. Specify
the version as a safeguard to ensure that your are deleting the correct stream. To get the
stream version, use the DescribeStream API. If not specified, only the CreationTime is
checked before deleting the stream.
"""
function delete_stream(StreamARN; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/deleteStream",
Dict{String,Any}("StreamARN" => StreamARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stream(
StreamARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/deleteStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StreamARN" => StreamARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_edge_configuration()
describe_edge_configuration(params::Dict{String,<:Any})
Describes a stream’s edge configuration that was set using the
StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and
uploader jobs. Use this API to get the status of the configuration to determine if the
configuration is in sync with the Edge Agent. Use this API to evaluate the health of the
Edge Agent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream. Specify either the
StreamNameor the StreamARN.
- `"StreamName"`: The name of the stream whose edge configuration you want to update.
Specify either the StreamName or the StreamARN.
"""
function describe_edge_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/describeEdgeConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_edge_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeEdgeConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image_generation_configuration()
describe_image_generation_configuration(params::Dict{String,<:Any})
Gets the ImageGenerationConfiguration for a given Kinesis video stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the Kinesis video stream from which to
retrieve the image generation configuration. You must specify either the StreamName or the
StreamARN.
- `"StreamName"`: The name of the stream from which to retrieve the image generation
configuration. You must specify either the StreamName or the StreamARN.
"""
function describe_image_generation_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeImageGenerationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image_generation_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeImageGenerationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mapped_resource_configuration()
describe_mapped_resource_configuration(params::Dict{String,<:Any})
Returns the most current information about the stream. The streamName or streamARN should
be provided in the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return in the response.
- `"NextToken"`: The token to provide in your next request, to get another batch of results.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream.
- `"StreamName"`: The name of the stream.
"""
function describe_mapped_resource_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeMappedResourceConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_mapped_resource_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeMappedResourceConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_media_storage_configuration()
describe_media_storage_configuration(params::Dict{String,<:Any})
Returns the most current information about the channel. Specify the ChannelName or
ChannelARN in the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChannelARN"`: The Amazon Resource Name (ARN) of the channel.
- `"ChannelName"`: The name of the channel.
"""
function describe_media_storage_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeMediaStorageConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_media_storage_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeMediaStorageConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_notification_configuration()
describe_notification_configuration(params::Dict{String,<:Any})
Gets the NotificationConfiguration for a given Kinesis video stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the Kinesis video stream from where you
want to retrieve the notification configuration. You must specify either the StreamName or
the StreamARN.
- `"StreamName"`: The name of the stream from which to retrieve the notification
configuration. You must specify either the StreamName or the StreamARN.
"""
function describe_notification_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeNotificationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_notification_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeNotificationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_signaling_channel()
describe_signaling_channel(params::Dict{String,<:Any})
Returns the most current information about the signaling channel. You must specify either
the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChannelARN"`: The ARN of the signaling channel that you want to describe.
- `"ChannelName"`: The name of the signaling channel that you want to describe.
"""
function describe_signaling_channel(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/describeSignalingChannel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_signaling_channel(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeSignalingChannel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stream()
describe_stream(params::Dict{String,<:Any})
Returns the most current information about the specified stream. You must specify either
the StreamName or the StreamARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream.
- `"StreamName"`: The name of the stream.
"""
function describe_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST", "/describeStream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/describeStream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_endpoint(apiname)
get_data_endpoint(apiname, params::Dict{String,<:Any})
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in
your application to read from the specified stream (using the GetMedia or
GetMediaForFragmentList operations) or write to it (using the PutMedia operation). The
returned endpoint does not have the API name appended. The client needs to add the API name
to the returned endpoint. In the request, specify the stream either by StreamName or
StreamARN.
# Arguments
- `apiname`: The name of the API action for which to get an endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream that you want to get the
endpoint for. You must specify either this parameter or a StreamName in the request.
- `"StreamName"`: The name of the stream that you want to get the endpoint for. You must
specify either this parameter or a StreamARN in the request.
"""
function get_data_endpoint(APIName; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/getDataEndpoint",
Dict{String,Any}("APIName" => APIName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_endpoint(
APIName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/getDataEndpoint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("APIName" => APIName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signaling_channel_endpoint(channel_arn)
get_signaling_channel_endpoint(channel_arn, params::Dict{String,<:Any})
Provides an endpoint for the specified signaling channel to send and receive messages. This
API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of
the Protocols and Role properties. Protocols is used to determine the communication
mechanism. For example, if you specify WSS as the protocol, this API produces a secure
websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS
endpoint. Role determines the messaging permissions. A MASTER role results in this API
generating an endpoint that a client can use to communicate with any of the viewers on the
channel. A VIEWER role results in this API generating an endpoint that a client can use to
communicate only with a MASTER.
# Arguments
- `channel_arn`: The Amazon Resource Name (ARN) of the signalling channel for which you
want to get an endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SingleMasterChannelEndpointConfiguration"`: A structure containing the endpoint
configuration for the SINGLE_MASTER channel type.
"""
function get_signaling_channel_endpoint(
ChannelARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/getSignalingChannelEndpoint",
Dict{String,Any}("ChannelARN" => ChannelARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_signaling_channel_endpoint(
ChannelARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/getSignalingChannelEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChannelARN" => ChannelARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_edge_agent_configurations(hub_device_arn)
list_edge_agent_configurations(hub_device_arn, params::Dict{String,<:Any})
Returns an array of edge configurations associated with the specified Edge Agent. In the
request, you must specify the Edge Agent HubDeviceArn.
# Arguments
- `hub_device_arn`: The \"Internet of Things (IoT) Thing\" Arn of the edge agent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of edge configurations to return in the response. The
default is 5.
- `"NextToken"`: If you specify this parameter, when the result of a
ListEdgeAgentConfigurations operation is truncated, the call returns the NextToken in the
response. To get another batch of edge configurations, provide this token in your next
request.
"""
function list_edge_agent_configurations(
HubDeviceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/listEdgeAgentConfigurations",
Dict{String,Any}("HubDeviceArn" => HubDeviceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_edge_agent_configurations(
HubDeviceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/listEdgeAgentConfigurations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HubDeviceArn" => HubDeviceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signaling_channels()
list_signaling_channels(params::Dict{String,<:Any})
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To
retrieve only those channels that satisfy a specific condition, you can specify a
ChannelNameCondition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChannelNameCondition"`: Optional: Returns only the channels that satisfy a specific
condition.
- `"MaxResults"`: The maximum number of channels to return in the response. The default is
500.
- `"NextToken"`: If you specify this parameter, when the result of a ListSignalingChannels
operation is truncated, the call returns the NextToken in the response. To get another
batch of channels, provide this token in your next request.
"""
function list_signaling_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/listSignalingChannels";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_signaling_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/listSignalingChannels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streams()
list_streams(params::Dict{String,<:Any})
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only
streams that satisfy a specific condition, you can specify a StreamNameCondition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of streams to return in the response. The default is
10,000.
- `"NextToken"`: If you specify this parameter, when the result of a ListStreams operation
is truncated, the call returns the NextToken in the response. To get another batch of
streams, provide this token in your next request.
- `"StreamNameCondition"`: Optional: Returns only streams that satisfy a specific
condition. Currently, you can specify only the prefix of a stream name as a condition.
"""
function list_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST", "/listStreams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/listStreams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of tags associated with the specified signaling channel.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the signaling channel for which you
want to list tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you specify this parameter and the result of a ListTagsForResource call
is truncated, the response includes a token that you can use in the next request to fetch
the next batch of tags.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_stream()
list_tags_for_stream(params::Dict{String,<:Any})
Returns a list of tags associated with the specified stream. In the request, you must
specify either the StreamName or the StreamARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you specify this parameter and the result of a ListTagsForStream call
is truncated, the response includes a token that you can use in the next request to fetch
the next batch of tags.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream that you want to list tags
for.
- `"StreamName"`: The name of the stream that you want to list tags for.
"""
function list_tags_for_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST", "/listTagsForStream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tags_for_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/listTagsForStream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_edge_configuration_update(edge_config)
start_edge_configuration_update(edge_config, params::Dict{String,<:Any})
An asynchronous API that updates a stream’s existing edge configuration. The Kinesis
Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass
component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary
and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the
edge configuration is acknowledged, and synced with the Edge Agent. If this API is invoked
for the first time, a new edge configuration will be created for the stream, and the sync
status will be set to SYNCING. You will have to wait for the sync status to reach a
terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke
this API during the syncing process, a ResourceInUseException will be thrown. The
connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15
minutes. After 15 minutes, the status will transition into the SYNC_FAILED state. To move
an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the
current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an
updated Hub Device ARN.
# Arguments
- `edge_config`: The edge configuration details required to invoke the update process.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream. Specify either the
StreamName or the StreamARN.
- `"StreamName"`: The name of the stream whose edge configuration you want to update.
Specify either the StreamName or the StreamARN.
"""
function start_edge_configuration_update(
EdgeConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/startEdgeConfigurationUpdate",
Dict{String,Any}("EdgeConfig" => EdgeConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_edge_configuration_update(
EdgeConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/startEdgeConfigurationUpdate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EdgeConfig" => EdgeConfig), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is
optional) that you can define and assign to Amazon Web Services resources. If you specify a
tag that already exists, the tag value is replaced with the value that you specify in the
request. For more information, see Using Cost Allocation Tags in the Billing and Cost
Management and Cost Management User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the signaling channel to which you want
to add tags.
- `tags`: A list of tags to associate with the specified signaling channel. Each tag is a
key-value pair.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/TagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_stream(tags)
tag_stream(tags, params::Dict{String,<:Any})
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that
you can define and assign to Amazon Web Services resources. If you specify a tag that
already exists, the tag value is replaced with the value that you specify in the request.
For more information, see Using Cost Allocation Tags in the Billing and Cost Management and
Cost Management User Guide. You must provide either the StreamName or the StreamARN. This
operation requires permission for the KinesisVideo:TagStream action. A Kinesis video stream
can support up to 50 tags.
# Arguments
- `tags`: A list of tags to associate with the specified stream. Each tag is a key-value
pair (the value is optional).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the resource that you want to add the
tag or tags to.
- `"StreamName"`: The name of the stream that you want to add the tag or tags to.
"""
function tag_stream(Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/tagStream",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_stream(
Tags, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/tagStream",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_key_list)
untag_resource(resource_arn, tag_key_list, params::Dict{String,<:Any})
Removes one or more tags from a signaling channel. In the request, specify only a tag key
or keys; don't specify the value. If you specify a tag key that does not exist, it's
ignored.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the signaling channel from which you
want to remove tags.
- `tag_key_list`: A list of the keys of the tags that you want to remove.
"""
function untag_resource(
ResourceARN, TagKeyList; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/UntagResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeyList" => TagKeyList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
TagKeyList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeyList" => TagKeyList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_stream(tag_key_list)
untag_stream(tag_key_list, params::Dict{String,<:Any})
Removes one or more tags from a stream. In the request, specify only a tag key or keys;
don't specify the value. If you specify a tag key that does not exist, it's ignored. In the
request, you must provide the StreamName or StreamARN.
# Arguments
- `tag_key_list`: A list of the keys of the tags that you want to remove.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream that you want to remove tags
from.
- `"StreamName"`: The name of the stream that you want to remove tags from.
"""
function untag_stream(TagKeyList; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/untagStream",
Dict{String,Any}("TagKeyList" => TagKeyList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_stream(
TagKeyList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/untagStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TagKeyList" => TagKeyList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_retention(current_version, data_retention_change_in_hours, operation)
update_data_retention(current_version, data_retention_change_in_hours, operation, params::Dict{String,<:Any})
Increases or decreases the stream's data retention period by the value that you specify. To
indicate whether you want to increase or decrease the data retention period, specify the
Operation parameter in the request body. In the request, you must specify either the
StreamName or the StreamARN. This operation requires permission for the
KinesisVideo:UpdateDataRetention action. Changing the data retention period affects the
data in the stream as follows: If the data retention period is increased, existing data
is retained for the new retention period. For example, if the data retention period is
increased from one hour to seven hours, all existing data is retained for seven hours. If
the data retention period is decreased, existing data is retained for the new retention
period. For example, if the data retention period is decreased from seven hours to one
hour, all existing data is retained for one hour, and any data older than one hour is
deleted immediately.
# Arguments
- `current_version`: The version of the stream whose retention period you want to change.
To get the version, call either the DescribeStream or the ListStreams API.
- `data_retention_change_in_hours`: The number of hours to adjust the current retention by.
The value you specify is added to or subtracted from the current value, depending on the
operation. The minimum value for data retention is 0 and the maximum value is 87600 (ten
years).
- `operation`: Indicates whether you want to increase or decrease the retention period.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream whose retention period you
want to change.
- `"StreamName"`: The name of the stream whose retention period you want to change.
"""
function update_data_retention(
CurrentVersion,
DataRetentionChangeInHours,
Operation;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/updateDataRetention",
Dict{String,Any}(
"CurrentVersion" => CurrentVersion,
"DataRetentionChangeInHours" => DataRetentionChangeInHours,
"Operation" => Operation,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_retention(
CurrentVersion,
DataRetentionChangeInHours,
Operation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/updateDataRetention",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CurrentVersion" => CurrentVersion,
"DataRetentionChangeInHours" => DataRetentionChangeInHours,
"Operation" => Operation,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_image_generation_configuration()
update_image_generation_configuration(params::Dict{String,<:Any})
Updates the StreamInfo and ImageProcessingConfiguration fields.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ImageGenerationConfiguration"`: The structure that contains the information required
for the KVS images delivery. If the structure is null, the configuration will be deleted
from the stream.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the Kinesis video stream from where you
want to update the image generation configuration. You must specify either the StreamName
or the StreamARN.
- `"StreamName"`: The name of the stream from which to update the image generation
configuration. You must specify either the StreamName or the StreamARN.
"""
function update_image_generation_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/updateImageGenerationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_image_generation_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/updateImageGenerationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_media_storage_configuration(channel_arn, media_storage_configuration)
update_media_storage_configuration(channel_arn, media_storage_configuration, params::Dict{String,<:Any})
Associates a SignalingChannel to a stream to store the media. There are two signaling modes
that you can specify : If StorageStatus is enabled, the data will be stored in the
StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data
retention enabled. If StorageStatus is disabled, no data will be stored, and the
StreamARN parameter will not be needed. If StorageStatus is enabled, direct
peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the
storage session. You must call the JoinStorageSession API to trigger an SDP offer send and
establish a connection between a peer and the storage session.
# Arguments
- `channel_arn`: The Amazon Resource Name (ARN) of the channel.
- `media_storage_configuration`: A structure that encapsulates, or contains, the media
storage configuration properties.
"""
function update_media_storage_configuration(
ChannelARN, MediaStorageConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/updateMediaStorageConfiguration",
Dict{String,Any}(
"ChannelARN" => ChannelARN,
"MediaStorageConfiguration" => MediaStorageConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_media_storage_configuration(
ChannelARN,
MediaStorageConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/updateMediaStorageConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChannelARN" => ChannelARN,
"MediaStorageConfiguration" => MediaStorageConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_notification_configuration()
update_notification_configuration(params::Dict{String,<:Any})
Updates the notification information for a stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NotificationConfiguration"`: The structure containing the information required for
notifications. If the structure is null, the configuration will be deleted from the stream.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the Kinesis video stream from where you
want to update the notification configuration. You must specify either the StreamName or
the StreamARN.
- `"StreamName"`: The name of the stream from which to update the notification
configuration. You must specify either the StreamName or the StreamARN.
"""
function update_notification_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/updateNotificationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_notification_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/updateNotificationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_signaling_channel(channel_arn, current_version)
update_signaling_channel(channel_arn, current_version, params::Dict{String,<:Any})
Updates the existing signaling channel. This is an asynchronous operation and takes time to
complete. If the MessageTtlSeconds value is updated (either increased or reduced), it only
applies to new messages sent via this channel after it's been updated. Existing messages
are still expired as per the previous MessageTtlSeconds value.
# Arguments
- `channel_arn`: The Amazon Resource Name (ARN) of the signaling channel that you want to
update.
- `current_version`: The current version of the signaling channel that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SingleMasterConfiguration"`: The structure containing the configuration for the
SINGLE_MASTER type of the signaling channel that you want to update.
"""
function update_signaling_channel(
ChannelARN, CurrentVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video(
"POST",
"/updateSignalingChannel",
Dict{String,Any}("ChannelARN" => ChannelARN, "CurrentVersion" => CurrentVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_signaling_channel(
ChannelARN,
CurrentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/updateSignalingChannel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChannelARN" => ChannelARN, "CurrentVersion" => CurrentVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_stream(current_version)
update_stream(current_version, params::Dict{String,<:Any})
Updates stream metadata, such as the device name and media type. You must provide the
stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the
latest version of the stream before updating it, you can specify the stream version.
Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis
Video Streams assigns a new version number. To get the latest stream version, use the
DescribeStream API. UpdateStream is an asynchronous operation, and takes time to complete.
# Arguments
- `current_version`: The version of the stream whose metadata you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceName"`: The name of the device that is writing to the stream. In the current
implementation, Kinesis Video Streams does not use this name.
- `"MediaType"`: The stream's media type. Use MediaType to specify the type of content that
the stream contains to the consumers of the stream. For more information about media types,
see Media Types. If you choose to specify the MediaType, see Naming Requirements. To play
video on the console, you must specify the correct video type. For example, if the video in
the stream is H.264, specify video/h264 as the MediaType.
- `"StreamARN"`: The ARN of the stream whose metadata you want to update.
- `"StreamName"`: The name of the stream whose metadata you want to update. The stream name
is an identifier for the stream, and must be unique for each account and region.
"""
function update_stream(CurrentVersion; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video(
"POST",
"/updateStream",
Dict{String,Any}("CurrentVersion" => CurrentVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_stream(
CurrentVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video(
"POST",
"/updateStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CurrentVersion" => CurrentVersion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 43084 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_video_archived_media
using AWS.Compat
using AWS.UUIDs
"""
get_clip(clip_fragment_selector)
get_clip(clip_fragment_selector, params::Dict{String,<:Any})
Downloads an MP4 file (clip) containing the archived, on-demand media from the specified
video stream over the specified time range. Both the StreamName and the StreamARN
parameters are optional, but you must specify either the StreamName or the StreamARN when
invoking this API operation. As a prerequisite to using GetCLip API, you must obtain an
endpoint using GetDataEndpoint, specifying GET_CLIP for the APIName parameter. An Amazon
Kinesis video stream has the following requirements for providing data through MP4: The
media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded
audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or
V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC)
or A_MS/ACM (for G.711). Data retention must be greater than 0. The video track of each
fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264
format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC
14496-15. For information about adapting stream data to a given format, see NAL Adaptation
Flags. The audio track (if present) of each fragment must contain codec private data in
the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format. You can monitor
the amount of outgoing data by monitoring the GetClip.OutgoingBytes Amazon CloudWatch
metric. For information about using CloudWatch to monitor Kinesis Video Streams, see
Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams
Pricing and Amazon Web Services Pricing. Charges for outgoing Amazon Web Services data
apply.
# Arguments
- `clip_fragment_selector`: The time range of the requested clip and the source of the
timestamps.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream for which to retrieve the
media clip. You must specify either the StreamName or the StreamARN.
- `"StreamName"`: The name of the stream for which to retrieve the media clip. You must
specify either the StreamName or the StreamARN.
"""
function get_clip(ClipFragmentSelector; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video_archived_media(
"POST",
"/getClip",
Dict{String,Any}("ClipFragmentSelector" => ClipFragmentSelector);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_clip(
ClipFragmentSelector,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_archived_media(
"POST",
"/getClip",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClipFragmentSelector" => ClipFragmentSelector),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dashstreaming_session_url()
get_dashstreaming_session_url(params::Dict{String,<:Any})
Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can
then open the URL in a media player to view the stream contents. Both the StreamName and
the StreamARN parameters are optional, but you must specify either the StreamName or the
StreamARN when invoking this API operation. An Amazon Kinesis video stream has the
following requirements for providing data through MPEG-DASH: The media must contain h.264
or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec
ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265).
Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).
Data retention must be greater than 0. The video track of each fragment must contain
codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265
format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information
about adapting stream data to a given format, see NAL Adaptation Flags. The audio track
(if present) of each fragment must contain codec private data in the AAC format (AAC
specification ISO/IEC 13818-7) or the MS Wave format. The following procedure shows how
to use MPEG-DASH with Kinesis Video Streams: Get an endpoint using GetDataEndpoint,
specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter. Retrieve the
MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH
streaming session to be used for accessing content in a stream using the MPEG-DASH
protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an
encrypted session token) for the session's MPEG-DASH manifest (the root resource needed for
streaming with MPEG-DASH). Don't share or store this token where an unauthorized entity
can access it. The token provides access to the content of the stream. Safeguard the token
with the same measures that you use with your Amazon Web Services credentials. The media
that is made available through the manifest consists only of the requested stream, time
range, and format. No other media data (such as frames outside the requested window or
alternate bitrates) is made available. Provide the URL (containing the encrypted session
token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol.
Kinesis Video Streams makes the initialization fragment and media fragments available
through the manifest URL. The initialization fragment contains the codec private data for
the stream, and other data needed to set up the video or audio decoder and renderer. The
media fragments contain encoded video frames or encoded audio samples. The media player
receives the authenticated URL and requests stream metadata and media data normally. When
the media player requests data, it calls the following actions: GetDASHManifest:
Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to
playback. GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media
player typically loads the initialization fragment before loading any media fragments. This
fragment contains the \"fytp\" and \"moov\" MP4 atoms, and the child atoms that are needed
to initialize the media player decoder. The initialization fragment does not correspond to
a fragment in a Kinesis video stream. It contains only the codec private data for the
stream and respective track, which the media player needs to decode the media frames.
GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the \"moof\"
and \"mdat\" MP4 atoms and their child atoms, containing the encoded fragment's media
frames and their timestamps. After the first media fragment is made available in a
streaming session, any fragments that don't contain the same codec private data cause an
error to be returned when those different media fragments are loaded. Therefore, the codec
private data should not change between fragments in a session. This also means that the
session fails if the fragments in a stream change from having only video to having both
audio and video. Data retrieved with this action is billable. See Pricing for details.
For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits. You
can monitor the amount of data that the media player consumes by monitoring the
GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using
CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For
pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services
Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply. For
more information about HLS, see HTTP Live Streaming on the Apple Developer site. If an
error is thrown after invoking a Kinesis Video Streams archived media API, in addition to
the HTTP status code and the response body, it includes the following pieces of
information: x-amz-ErrorType HTTP header – contains a more specific error type in
addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you
want to report an issue to Amazon Web Services the support team can better diagnose the
problem if given the Request Id. Both the HTTP status code and the ErrorType header can
be utilized to make programmatic decisions about whether errors are retry-able and under
what conditions, as well as provide information on what actions the client programmer might
need to take in order to successfully try again. For more information, see the Errors
section at the bottom of this topic, as well as Common Errors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DASHFragmentSelector"`: The time range of the requested fragment and the source of the
timestamps. This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This
parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode
is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.
- `"DisplayFragmentNumber"`: Fragments are identified in the manifest file based on their
sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis
Video Streams fragment number is added to each S element in the manifest file with the
attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with
other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is
necessary to leverage these this custom attribute. The default value is NEVER.
- `"DisplayFragmentTimestamp"`: Per the MPEG-DASH specification, the wall-clock time of
fragments in the manifest file can be derived using attributes in the manifest itself.
However, typically, MPEG-DASH compatible media players do not properly handle gaps in the
media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to
enable playback of media with discontinuities. Therefore, the wall-clock time derived from
the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the
accurate fragment timestamp is added to each S element in the manifest file with the
attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this
custom attribute. The default value is NEVER. When DASHFragmentSelector is
SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when
DASHFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start
timestamps.
- `"Expires"`: The time in seconds until the requested session expires. This value can be
between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new calls to
GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.
The default is 300 (5 minutes).
- `"MaxManifestFragmentResults"`: The maximum number of fragments that are returned in the
MPEG-DASH manifest. When the PlaybackMode is LIVE, the most recent fragments are returned
up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up
to this maximum number. When there are a higher number of fragments available in a live
MPEG-DASH manifest, video players often buffer content before starting playback. Increasing
the buffer size increases the playback latency, but it decreases the likelihood that
rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a
minimum of 3 fragments and a maximum of 10 fragments. The default is 5 fragments if
PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND. The maximum
value of 1,000 fragments corresponds to more than 16 minutes of video on streams with
1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.
- `"PlaybackMode"`: Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following: LIVE : For sessions of
this type, the MPEG-DASH manifest is continually updated with the latest fragments as they
become available. We recommend that the media player retrieve a new manifest on a
one-second interval. When this type of session is played in a media player, the user
interface typically displays a \"live\" notification, with no scrubber control for choosing
the position in the playback window to display. In LIVE mode, the newest available
fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments
(that is, if a fragment is missing). A gap like this might cause a media player to halt or
cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest
if they are older than the newest fragment in the playlist. If the missing fragment becomes
available after a subsequent fragment is added to the manifest, the older fragment is not
added, and the gap is not filled. LIVE_REPLAY : For sessions of this type, the
MPEG-DASH manifest is updated similarly to how it is updated for LIVE mode except that it
starts by including fragments from a given start time. Instead of fragments being added as
they are ingested, fragments are added as the duration of the next fragment elapses. For
example, if the fragments in the session are two seconds long, then a new fragment is added
to the manifest every two seconds. This mode is useful to be able to start playback from
when an event is detected and continue live streaming media that has not yet been ingested
as of the time of the session creation. This mode is also useful to stream previously
archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.
ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments
for the session, up to the number that is specified in MaxManifestFragmentResults. The
manifest must be retrieved only once for each session. When this type of session is played
in a media player, the user interface typically displays a scrubber control for choosing
the position in the playback window to display. In all playback modes, if
FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the
same start timestamp, the fragment that has the larger fragment number (that is, the newer
fragment) is included in the MPEG-DASH manifest. The other fragments are not included.
Fragments that have different timestamps but have overlapping durations are still included
in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player. The
default is LIVE.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream for which to retrieve the
MPEG-DASH manifest URL. You must specify either the StreamName or the StreamARN.
- `"StreamName"`: The name of the stream for which to retrieve the MPEG-DASH manifest URL.
You must specify either the StreamName or the StreamARN.
"""
function get_dashstreaming_session_url(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video_archived_media(
"POST",
"/getDASHStreamingSessionURL";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dashstreaming_session_url(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video_archived_media(
"POST",
"/getDASHStreamingSessionURL",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_hlsstreaming_session_url()
get_hlsstreaming_session_url(params::Dict{String,<:Any})
Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a
browser or media player to view the stream contents. Both the StreamName and the StreamARN
parameters are optional, but you must specify either the StreamName or the StreamARN when
invoking this API operation. An Amazon Kinesis video stream has the following requirements
for providing data through HLS: For streaming video, the media must contain H.264 or
H.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track
1 should be V_MPEG/ISO/AVC (for H.264) or V_MPEG/ISO/HEVC (for H.265). Optionally, the
codec ID of track 2 should be A_AAC. For audio only streaming, the codec ID of track 1
should be A_AAC. Data retention must be greater than 0. The video track of each
fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264
format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15). For information
about adapting stream data to a given format, see NAL Adaptation Flags. The audio track
(if present) of each fragment must contain codec private data in the AAC format (AAC
specification ISO/IEC 13818-7). Kinesis Video Streams HLS sessions contain fragments in
the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS
chunks, which the HLS specification also supports). For more information about HLS fragment
types, see the HLS specification. The following procedure shows how to use HLS with Kinesis
Video Streams: Get an endpoint using GetDataEndpoint, specifying
GET_HLS_STREAMING_SESSION_URL for the APIName parameter. Retrieve the HLS URL using
GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be
used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL
returns an authenticated URL (that includes an encrypted session token) for the session's
HLS master playlist (the root resource needed for streaming with HLS). Don't share or
store this token where an unauthorized entity could access it. The token provides access to
the content of the stream. Safeguard the token with the same measures that you would use
with your Amazon Web Services credentials. The media that is made available through the
playlist consists only of the requested stream, time range, and format. No other media data
(such as frames outside the requested window or alternate bitrates) is made available.
Provide the URL (containing the encrypted session token) for the HLS master playlist to a
media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media
playlist, initialization fragment, and media fragments available through the master
playlist URL. The initialization fragment contains the codec private data for the stream,
and other data needed to set up the video or audio decoder and renderer. The media
fragments contain H.264-encoded video frames or AAC-encoded audio samples. The media
player receives the authenticated URL and requests stream metadata and media data normally.
When the media player requests data, it calls the following actions:
GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the
GetHLSMediaPlaylist action for each track, and additional metadata for the media player,
including estimated bitrate and resolution. GetHLSMediaPlaylist: Retrieves an HLS media
playlist, which contains a URL to access the MP4 initialization fragment with the
GetMP4InitFragment action, and URLs to access the MP4 media fragments with the
GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream
that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND.
The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND.
The HLS media playlist is continually updated with new fragments for sessions with a
PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the
audio track (if applicable) that contains MP4 media URLs for the specific track.
GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically
loads the initialization fragment before loading any media fragments. This fragment
contains the \"fytp\" and \"moov\" MP4 atoms, and the child atoms that are needed to
initialize the media player decoder. The initialization fragment does not correspond to a
fragment in a Kinesis video stream. It contains only the codec private data for the stream
and respective track, which the media player needs to decode the media frames.
GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the \"moof\"
and \"mdat\" MP4 atoms and their child atoms, containing the encoded fragment's media
frames and their timestamps. For the HLS streaming session, in-track codec private data
(CPD) changes are supported. After the first media fragment is made available in a
streaming session, fragments can contain CPD changes for each track. Therefore, the
fragments in a session can have a different resolution, bit rate, or other information in
the CPD without interrupting playback. However, any change made in the track number or
track codec format can return an error when those different media fragments are loaded. For
example, streaming will fail if the fragments in the stream change from having only video
to having both audio and video, or if an AAC audio track is changed to an ALAW audio track.
For each streaming session, only 500 CPD changes are allowed. Data retrieved with this
action is billable. For information, see Pricing. GetTSFragment: Retrieves MPEG TS
fragments containing both initialization and media data for all tracks in the stream. If
the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and
GetMP4MediaFragment to retrieve stream media. Data retrieved with this action is billable.
For more information, see Kinesis Video Streams pricing. A streaming session URL must
not be shared between players. The service might throttle a session if multiple media
players are sharing it. For connection limits, see Kinesis Video Streams Limits. You can
monitor the amount of data that the media player consumes by monitoring the
GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using
CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For
pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services
Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply. For
more information about HLS, see HTTP Live Streaming on the Apple Developer site. If an
error is thrown after invoking a Kinesis Video Streams archived media API, in addition to
the HTTP status code and the response body, it includes the following pieces of
information: x-amz-ErrorType HTTP header – contains a more specific error type in
addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you
want to report an issue to Amazon Web Services, the support team can better diagnose the
problem if given the Request Id. Both the HTTP status code and the ErrorType header can
be utilized to make programmatic decisions about whether errors are retry-able and under
what conditions, as well as provide information on what actions the client programmer might
need to take in order to successfully try again. For more information, see the Errors
section at the bottom of this topic, as well as Common Errors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContainerFormat"`: Specifies which format should be used for packaging the media.
Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4
or CMAF). This is the recommended packaging because there is minimal packaging overhead.
The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was
released and is sometimes the only supported packaging on older HLS players. MPEG TS
typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25
percent more bandwidth and cost than fMP4. The default is FRAGMENTED_MP4.
- `"DiscontinuityMode"`: Specifies when flags marking discontinuities between fragments are
added to the media playlists. Media players typically build a timeline of media content to
play, based on the timestamps of each fragment. This means that if there is any overlap or
gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP),
the media player timeline will also have small gaps between fragments in some places, and
will overwrite frames in other places. Gaps in the media player timeline can cause playback
to stall and overlaps can cause playback to be jittery. When there are discontinuity flags
between fragments, the media player is expected to reset the timeline, resulting in the
next fragment being played immediately after the previous fragment. The following modes
are supported: ALWAYS: a discontinuity marker is placed between every fragment in the
HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps
are not accurate. NEVER: no discontinuity markers are placed anywhere. It is recommended
to use a value of NEVER to ensure the media player timeline most accurately maps to the
producer timestamps. ON_DISCONTINUITY: a discontinuity marker is placed between
fragments that have a gap or overlap of more than 50 milliseconds. For most playback
scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player
timeline is only reset when there is a significant issue with the media timeline (e.g. a
missing fragment). The default is ALWAYS when HLSFragmentSelector is set to
SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.
- `"DisplayFragmentTimestamp"`: Specifies when the fragment start timestamps should be
included in the HLS media playlist. Typically, media players report the playhead position
as a time relative to the start of the first fragment in the playback session. However,
when the start timestamps are included in the HLS media playlist, some media players might
report the current playhead as an absolute time based on the fragment timestamps. This can
be useful for creating a playback experience that shows viewers the wall-clock time of the
media. The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps
will be the server start timestamps. Similarly, when HLSFragmentSelector is
PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.
- `"Expires"`: The time in seconds until the requested session expires. This value can be
between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new calls to
GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, GetMP4MediaFragment, or
GetTSFragment can be made for that session. The default is 300 (5 minutes).
- `"HLSFragmentSelector"`: The time range of the requested fragment and the source of the
timestamps. This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This
parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode
is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.
- `"MaxMediaPlaylistFragmentResults"`: The maximum number of fragments that are returned in
the HLS media playlists. When the PlaybackMode is LIVE, the most recent fragments are
returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are
returned, up to this maximum number. When there are a higher number of fragments available
in a live HLS media playlist, video players often buffer content before starting playback.
Increasing the buffer size increases the playback latency, but it decreases the likelihood
that rebuffering will occur during playback. We recommend that a live HLS media playlist
have a minimum of 3 fragments and a maximum of 10 fragments. The default is 5 fragments if
PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND. The maximum
value of 5,000 fragments corresponds to more than 80 minutes of video on streams with
1-second fragments, and more than 13 hours of video on streams with 10-second fragments.
- `"PlaybackMode"`: Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following: LIVE : For sessions of
this type, the HLS media playlist is continually updated with the latest fragments as they
become available. We recommend that the media player retrieve a new playlist on a
one-second interval. When this type of session is played in a media player, the user
interface typically displays a \"live\" notification, with no scrubber control for choosing
the position in the playback window to display. In LIVE mode, the newest available
fragments are included in an HLS media playlist, even if there is a gap between fragments
(that is, if a fragment is missing). A gap like this might cause a media player to halt or
cause a jump in playback. In this mode, fragments are not added to the HLS media playlist
if they are older than the newest fragment in the playlist. If the missing fragment becomes
available after a subsequent fragment is added to the playlist, the older fragment is not
added, and the gap is not filled. LIVE_REPLAY : For sessions of this type, the HLS
media playlist is updated similarly to how it is updated for LIVE mode except that it
starts by including fragments from a given start time. Instead of fragments being added as
they are ingested, fragments are added as the duration of the next fragment elapses. For
example, if the fragments in the session are two seconds long, then a new fragment is added
to the media playlist every two seconds. This mode is useful to be able to start playback
from when an event is detected and continue live streaming media that has not yet been
ingested as of the time of the session creation. This mode is also useful to stream
previously archived media without being limited by the 1,000 fragment limit in the
ON_DEMAND mode. ON_DEMAND : For sessions of this type, the HLS media playlist contains
all the fragments for the session, up to the number that is specified in
MaxMediaPlaylistFragmentResults. The playlist must be retrieved only once for each session.
When this type of session is played in a media player, the user interface typically
displays a scrubber control for choosing the position in the playback window to display.
In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are
multiple fragments with the same start timestamp, the fragment that has the largest
fragment number (that is, the newest fragment) is included in the HLS media playlist. The
other fragments are not included. Fragments that have different timestamps but have
overlapping durations are still included in the HLS media playlist. This can lead to
unexpected behavior in the media player. The default is LIVE.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS
master playlist URL. You must specify either the StreamName or the StreamARN.
- `"StreamName"`: The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the StreamARN.
"""
function get_hlsstreaming_session_url(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video_archived_media(
"POST",
"/getHLSStreamingSessionURL";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_hlsstreaming_session_url(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video_archived_media(
"POST",
"/getHLSStreamingSessionURL",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_images(end_timestamp, format, image_selector_type, start_timestamp)
get_images(end_timestamp, format, image_selector_type, start_timestamp, params::Dict{String,<:Any})
Retrieves a list of images corresponding to each timestamp for a given time range, sampling
interval, and image format configuration.
# Arguments
- `end_timestamp`: The end timestamp for the range of images to be generated. If the time
range between StartTimestamp and EndTimestamp is more than 300 seconds above
StartTimestamp, you will receive an IllegalArgumentException.
- `format`: The format that will be used to encode the image.
- `image_selector_type`: The origin of the Server or Producer timestamps to use to generate
the images.
- `start_timestamp`: The starting point from which the images should be generated. This
StartTimestamp must be within an inclusive range of timestamps for an image to be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FormatConfig"`: The list of a key-value pair structure that contains extra parameters
that can be applied when the image is generated. The FormatConfig key is the JPEGQuality,
which indicates the JPEG quality key to be used to generate the image. The FormatConfig
value accepts ints from 1 to 100. If the value is 1, the image will be generated with less
quality and the best compression. If the value is 100, the image will be generated with the
best quality and less compression. If no value is provided, the default value of the
JPEGQuality key will be set to 80.
- `"HeightPixels"`: The height of the output image that is used in conjunction with the
WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the
image will be stretched to fit the specified aspect ratio. If only the HeightPixels
parameter is provided, its original aspect ratio will be used to calculate the WidthPixels
ratio. If neither parameter is provided, the original image size will be returned.
- `"MaxResults"`: The maximum number of images to be returned by the API. The default
limit is 25 images per API response. Providing a MaxResults greater than this value will
result in a page size of 25. Any additional results will be paginated.
- `"NextToken"`: A token that specifies where to start paginating the next set of Images.
This is the GetImages:NextToken from a previously truncated response.
- `"SamplingInterval"`: The time interval in milliseconds (ms) at which the images need to
be generated from the stream. The minimum value that can be provided is 200 ms (5 images
per second). If the timestamp range is less than the sampling interval, the image from the
startTimestamp will be returned if available.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream from which to retrieve the
images. You must specify either the StreamName or the StreamARN.
- `"StreamName"`: The name of the stream from which to retrieve the images. You must
specify either the StreamName or the StreamARN.
- `"WidthPixels"`: The width of the output image that is used in conjunction with the
HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the
image will be stretched to fit the specified aspect ratio. If only the WidthPixels
parameter is provided or if only the HeightPixels is provided, a ValidationException will
be thrown. If neither parameter is provided, the original image size from the stream will
be returned.
"""
function get_images(
EndTimestamp,
Format,
ImageSelectorType,
StartTimestamp;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_archived_media(
"POST",
"/getImages",
Dict{String,Any}(
"EndTimestamp" => EndTimestamp,
"Format" => Format,
"ImageSelectorType" => ImageSelectorType,
"StartTimestamp" => StartTimestamp,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_images(
EndTimestamp,
Format,
ImageSelectorType,
StartTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_archived_media(
"POST",
"/getImages",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTimestamp" => EndTimestamp,
"Format" => Format,
"ImageSelectorType" => ImageSelectorType,
"StartTimestamp" => StartTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_media_for_fragment_list(fragments)
get_media_for_fragment_list(fragments, params::Dict{String,<:Any})
Gets media for a list of fragments (specified by fragment number) from the archived data in
an Amazon Kinesis video stream. You must first call the GetDataEndpoint API to get an
endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the
--endpoint-url parameter. For limits, see Kinesis Video Streams Limits. If an error is
thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP
status code and the response body, it includes the following pieces of information:
x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the
HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an
issue to Amazon Web Services, the support team can better diagnose the problem if given the
Request Id. Both the HTTP status code and the ErrorType header can be utilized to make
programmatic decisions about whether errors are retry-able and under what conditions, as
well as provide information on what actions the client programmer might need to take in
order to successfully try again. For more information, see the Errors section at the bottom
of this topic, as well as Common Errors.
# Arguments
- `fragments`: A list of the numbers of fragments for which to retrieve media. You retrieve
these values with ListFragments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream from which to retrieve
fragment media. Specify either this parameter or the StreamName parameter.
- `"StreamName"`: The name of the stream from which to retrieve fragment media. Specify
either this parameter or the StreamARN parameter.
"""
function get_media_for_fragment_list(
Fragments; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video_archived_media(
"POST",
"/getMediaForFragmentList",
Dict{String,Any}("Fragments" => Fragments);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_media_for_fragment_list(
Fragments,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_archived_media(
"POST",
"/getMediaForFragmentList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Fragments" => Fragments), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fragments()
list_fragments(params::Dict{String,<:Any})
Returns a list of Fragment objects from the specified stream and timestamp range within the
archived data. Listing fragments is eventually consistent. This means that even if the
producer receives an acknowledgment that a fragment is persisted, the result might not be
returned immediately from a request to ListFragments. However, results are typically
available in less than one second. You must first call the GetDataEndpoint API to get an
endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url
parameter. If an error is thrown after invoking a Kinesis Video Streams archived media
API, in addition to the HTTP status code and the response body, it includes the following
pieces of information: x-amz-ErrorType HTTP header – contains a more specific error
type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header –
if you want to report an issue to Amazon Web Services, the support team can better diagnose
the problem if given the Request Id. Both the HTTP status code and the ErrorType header
can be utilized to make programmatic decisions about whether errors are retry-able and
under what conditions, as well as provide information on what actions the client programmer
might need to take in order to successfully try again. For more information, see the Errors
section at the bottom of this topic, as well as Common Errors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FragmentSelector"`: Describes the timestamp range and timestamp origin for the range of
fragments to return. This is only required when the NextToken isn't passed in the API.
- `"MaxResults"`: The total number of fragments to return. If the total number of fragments
available is more than the value specified in max-results, then a
ListFragmentsOutputNextToken is provided in the output that you can use to resume
pagination.
- `"NextToken"`: A token to specify where to start paginating. This is the
ListFragmentsOutputNextToken from a previously truncated response.
- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream from which to retrieve a
fragment list. Specify either this parameter or the StreamName parameter.
- `"StreamName"`: The name of the stream from which to retrieve a fragment list. Specify
either this parameter or the StreamARN parameter.
"""
function list_fragments(; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video_archived_media(
"POST", "/listFragments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_fragments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video_archived_media(
"POST",
"/listFragments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 3269 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_video_media
using AWS.Compat
using AWS.UUIDs
"""
get_media(start_selector)
get_media(start_selector, params::Dict{String,<:Any})
Use this API to retrieve media content from a Kinesis video stream. In the request, you
identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk.
Kinesis Video Streams then returns a stream of chunks in order by fragment number. You
must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests
to this endpoint using the --endpoint-url parameter. When you put media data (fragments)
on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in
what is called a \"chunk.\" For more information, see PutMedia. The GetMedia API returns a
stream of these chunks starting from the chunk that you specify in the request. The
following limits apply when using the GetMedia API: A client can call GetMedia up to five
times per second per stream. Kinesis Video Streams sends media data at a rate of up to
25 megabytes per second (or 200 megabits per second) during a GetMedia session. If an
error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP
status code and the response body, it includes the following pieces of information:
x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the
HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an
issue to AWS, the support team can better diagnose the problem if given the Request Id.
Both the HTTP status code and the ErrorType header can be utilized to make programmatic
decisions about whether errors are retry-able and under what conditions, as well as provide
information on what actions the client programmer might need to take in order to
successfully try again. For more information, see the Errors section at the bottom of this
topic, as well as Common Errors.
# Arguments
- `start_selector`: Identifies the starting chunk to get from the specified stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamARN"`: The ARN of the stream from where you want to get the media content. If you
don't specify the streamARN, you must specify the streamName.
- `"StreamName"`: The Kinesis video stream name from where you want to get the media
content. If you don't specify the streamName, you must specify the streamARN.
"""
function get_media(StartSelector; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video_media(
"POST",
"/getMedia",
Dict{String,Any}("StartSelector" => StartSelector);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_media(
StartSelector,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_media(
"POST",
"/getMedia",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StartSelector" => StartSelector), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 4531 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_video_signaling
using AWS.Compat
using AWS.UUIDs
"""
get_ice_server_config(channel_arn)
get_ice_server_config(channel_arn, params::Dict{String,<:Any})
Gets the Interactive Connectivity Establishment (ICE) server configuration information,
including URIs, username, and password which can be used to configure the WebRTC
connection. The ICE component uses this configuration information to setup the WebRTC
connection, including authenticating with the Traversal Using Relays around NAT (TURN)
relay server. TURN is a protocol that is used to improve the connectivity of peer-to-peer
applications. By providing a cloud-based relay service, TURN ensures that a connection can
be established even when one or more peers are incapable of a direct peer-to-peer
connection. For more information, see A REST API For Access To TURN Services. You can
invoke this API to establish a fallback mechanism in case either of the peers is unable to
establish a direct peer-to-peer connection over a signaling channel. You must specify
either a signaling channel ARN or the client ID in order to invoke this API.
# Arguments
- `channel_arn`: The ARN of the signaling channel to be used for the peer-to-peer
connection between configured peers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientId"`: Unique identifier for the viewer. Must be unique within the signaling
channel.
- `"Service"`: Specifies the desired service. Currently, TURN is the only valid value.
- `"Username"`: An optional user ID to be associated with the credentials.
"""
function get_ice_server_config(
ChannelARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return kinesis_video_signaling(
"POST",
"/v1/get-ice-server-config",
Dict{String,Any}("ChannelARN" => ChannelARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ice_server_config(
ChannelARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_signaling(
"POST",
"/v1/get-ice-server-config",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChannelARN" => ChannelARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_alexa_offer_to_master(channel_arn, message_payload, sender_client_id)
send_alexa_offer_to_master(channel_arn, message_payload, sender_client_id, params::Dict{String,<:Any})
This API allows you to connect WebRTC-enabled devices with Alexa display devices. When
invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer.
The offer is delivered as soon as the master is connected to the specified signaling
channel. This API returns the SDP answer from the connected master. If the master is not
connected to the signaling channel, redelivery requests are made until the message expires.
# Arguments
- `channel_arn`: The ARN of the signaling channel by which Alexa and the master peer
communicate.
- `message_payload`: The base64-encoded SDP offer content.
- `sender_client_id`: The unique identifier for the sender client.
"""
function send_alexa_offer_to_master(
ChannelARN,
MessagePayload,
SenderClientId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_signaling(
"POST",
"/v1/send-alexa-offer-to-master",
Dict{String,Any}(
"ChannelARN" => ChannelARN,
"MessagePayload" => MessagePayload,
"SenderClientId" => SenderClientId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_alexa_offer_to_master(
ChannelARN,
MessagePayload,
SenderClientId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_signaling(
"POST",
"/v1/send-alexa-offer-to-master",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChannelARN" => ChannelARN,
"MessagePayload" => MessagePayload,
"SenderClientId" => SenderClientId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 2237 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kinesis_video_webrtc_storage
using AWS.Compat
using AWS.UUIDs
"""
join_storage_session(channel_arn)
join_storage_session(channel_arn, params::Dict{String,<:Any})
Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing
device for an input channel. If there’s no existing session for the channel, a new
streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling
channel must be provided. Currently for the SINGLE_MASTER type, a video producing device
is able to ingest both audio and video media into a stream, while viewers can only ingest
audio. Both a video producing device and viewers can join the session first, and wait for
other participants. While participants are having peer to peer conversations through
webRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple
viewers are able to playback real-time media. Customers can also use existing Kinesis Video
Streams features like HLS or DASH playback, Image generation, and more with ingested WebRTC
media. Assume that only one video producing device client can be associated with a session
for the channel. If more than one client joins the session of a specific channel as a video
producing device, the most recent client request takes precedence.
# Arguments
- `channel_arn`: The Amazon Resource Name (ARN) of the signaling channel.
"""
function join_storage_session(channelArn; aws_config::AbstractAWSConfig=global_aws_config())
return kinesis_video_webrtc_storage(
"POST",
"/joinStorageSession",
Dict{String,Any}("channelArn" => channelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function join_storage_session(
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kinesis_video_webrtc_storage(
"POST",
"/joinStorageSession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelArn" => channelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 274571 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: kms
using AWS.Compat
using AWS.UUIDs
"""
cancel_key_deletion(key_id)
cancel_key_deletion(key_id, params::Dict{String,<:Any})
Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
key is Disabled. To enable the KMS key, use EnableKey. For more information about
scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management
Service Developer Guide. The KMS key that you use for this operation must be in a
compatible key state. For details, see Key states of KMS keys in the Key Management Service
Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in
a different Amazon Web Services account. Required permissions: kms:CancelKeyDeletion (key
policy) Related operations: ScheduleKeyDeletion Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the KMS key whose deletion is being canceled. Specify the key ID or
key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get
the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function cancel_key_deletion(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"CancelKeyDeletion",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_key_deletion(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"CancelKeyDeletion",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
connect_custom_key_store(custom_key_store_id)
connect_custom_key_store(custom_key_store_id, params::Dict{String,<:Any})
Connects or reconnects a custom key store to its backing key store. For an CloudHSM key
store, ConnectCustomKeyStore connects the key store to its associated CloudHSM cluster. For
an external key store, ConnectCustomKeyStore connects the key store to the external key
store proxy that communicates with your external key manager. The custom key store must be
connected before you can create KMS keys in the key store or use the KMS keys it contains.
You can disconnect and reconnect a custom key store at any time. The connection process for
a custom key store can take an extended amount of time to complete. This operation starts
the connection process, but it does not wait for it to complete. When it succeeds, this
operation quickly returns an HTTP 200 response and a JSON object with no properties.
However, this response does not indicate that the custom key store is connected. To get the
connection state of the custom key store, use the DescribeCustomKeyStores operation. This
operation is part of the custom key stores feature in KMS, which combines the convenience
and extensive integration of KMS with the isolation and control of a key store that you own
and manage. The ConnectCustomKeyStore operation might fail for various reasons. To find the
reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the
response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. To
fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key
store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use
ConnectCustomKeyStore again. CloudHSM key store During the connection process for an
CloudHSM key store, KMS finds the CloudHSM cluster that is associated with the custom key
store, creates the connection infrastructure, connects to the cluster, logs into the
CloudHSM client as the kmsuser CU, and rotates its password. To connect an CloudHSM key
store, its associated CloudHSM cluster must have at least one active HSM. To get the number
of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the
cluster, use the CreateHsm operation. Also, the kmsuser crypto user (CU) must not be
logged into the cluster. This prevents KMS from using this account to log in. If you are
having trouble connecting or disconnecting a CloudHSM key store, see Troubleshooting an
CloudHSM key store in the Key Management Service Developer Guide. External key store When
you connect an external key store that uses public endpoint connectivity, KMS tests its
ability to communicate with your external key manager by sending a request via the external
key store proxy. When you connect to an external key store that uses VPC endpoint service
connectivity, KMS establishes the networking elements that it needs to communicate with
your external key manager via the external key store proxy. This includes creating an
interface endpoint to the VPC endpoint service and a private hosted zone for traffic
between KMS and the VPC endpoint service. To connect an external key store, KMS must be
able to connect to the external key store proxy, the external key store proxy must be able
to communicate with your external key manager, and the external key manager must be
available for cryptographic operations. If you are having trouble connecting or
disconnecting an external key store, see Troubleshooting an external key store in the Key
Management Service Developer Guide. Cross-account use: No. You cannot perform this
operation on a custom key store in a different Amazon Web Services account. Required
permissions: kms:ConnectCustomKeyStore (IAM policy) Related operations
CreateCustomKeyStore DeleteCustomKeyStore DescribeCustomKeyStores
DisconnectCustomKeyStore UpdateCustomKeyStore Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `custom_key_store_id`: Enter the key store ID of the custom key store that you want to
connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
"""
function connect_custom_key_store(
CustomKeyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ConnectCustomKeyStore",
Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function connect_custom_key_store(
CustomKeyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"ConnectCustomKeyStore",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_alias(alias_name, target_key_id)
create_alias(alias_name, target_key_id, params::Dict{String,<:Any})
Creates a friendly name for a KMS key. Adding, deleting, or updating an alias can allow
or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
Service Developer Guide. You can use an alias to identify a KMS key in the KMS console, in
the DescribeKey operation and in cryptographic operations, such as Encrypt and
GenerateDataKey. You can also change the KMS key that's associated with the alias
(UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't affect
the underlying KMS key. You can associate the alias with any customer managed key in the
same Amazon Web Services Region. Each alias is associated with only one KMS key at a time,
but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an
alias without a KMS key. The alias must be unique in the account and Region, but you can
have aliases with the same name in different Regions. For detailed information about
aliases, see Using aliases in the Key Management Service Developer Guide. This operation
does not return a response. To get the alias that you created, use the ListAliases
operation. The KMS key that you use for this operation must be in a compatible key state.
For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on an alias in a different Amazon
Web Services account. Required permissions kms:CreateAlias on the alias (IAM policy).
kms:CreateAlias on the KMS key (key policy). For details, see Controlling access to
aliases in the Key Management Service Developer Guide. Related operations: DeleteAlias
ListAliases UpdateAlias Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `alias_name`: Specifies the alias name. This value must begin with alias/ followed by a
name, such as alias/ExampleAlias. Do not include confidential or sensitive information in
this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The AliasName value must be string of 1-256 characters. It can contain only alphanumeric
characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot
begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed
keys.
- `target_key_id`: Associates the alias with the specified customer managed key. The KMS
key must be in the same Amazon Web Services Region. A valid key ID is required. If you
supply a null or empty string value, this operation returns an error. For help finding the
key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer
Guide . Specify the key ID or key ARN of the KMS key. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function create_alias(
AliasName, TargetKeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"CreateAlias",
Dict{String,Any}("AliasName" => AliasName, "TargetKeyId" => TargetKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alias(
AliasName,
TargetKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"CreateAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AliasName" => AliasName, "TargetKeyId" => TargetKeyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_key_store(custom_key_store_name)
create_custom_key_store(custom_key_store_name, params::Dict{String,<:Any})
Creates a custom key store backed by a key store that you own and manage. When you use a
KMS key in a custom key store for a cryptographic operation, the cryptographic operation is
actually performed in your key store using your keys. KMS supports CloudHSM key stores
backed by an CloudHSM cluster and external key stores backed by an external key store proxy
and external key manager outside of Amazon Web Services. This operation is part of the
custom key stores feature in KMS, which combines the convenience and extensive integration
of KMS with the isolation and control of a key store that you own and manage. Before you
create the custom key store, the required elements must be in place and operational. We
recommend that you use the test tools that KMS provides to verify the configuration your
external key store proxy. For details about the required elements and verification tests,
see Assemble the prerequisites (for CloudHSM key stores) or Assemble the prerequisites (for
external key stores) in the Key Management Service Developer Guide. To create a custom key
store, use the following parameters. To create an CloudHSM key store, specify the
CustomKeyStoreName, CloudHsmClusterId, KeyStorePassword, and TrustAnchorCertificate. The
CustomKeyStoreType parameter is optional for CloudHSM key stores. If you include it, set it
to the default value, AWS_CLOUDHSM. For help with failures, see Troubleshooting an CloudHSM
key store in the Key Management Service Developer Guide. To create an external key store,
specify the CustomKeyStoreName and a CustomKeyStoreType of EXTERNAL_KEY_STORE. Also,
specify values for XksProxyConnectivity, XksProxyAuthenticationCredential,
XksProxyUriEndpoint, and XksProxyUriPath. If your XksProxyConnectivity value is
VPC_ENDPOINT_SERVICE, specify the XksProxyVpcEndpointServiceName parameter. For help with
failures, see Troubleshooting an external key store in the Key Management Service Developer
Guide. For external key stores: Some external key managers provide a simpler method for
creating an external key store. For details, see your external key manager documentation.
When creating an external key store in the KMS console, you can upload a JSON-based proxy
configuration file with the desired values. You cannot use a proxy configuration with the
CreateCustomKeyStore operation. However, you can use the values in the file to help you
determine the correct values for the CreateCustomKeyStore parameters. When the operation
completes successfully, it returns the ID of the new custom key store. Before you can use
your new custom key store, you need to use the ConnectCustomKeyStore operation to connect a
new CloudHSM key store to its CloudHSM cluster, or to connect a new external key store to
the external key store proxy for your external key manager. Even if you are not going to
use your custom key store immediately, you might want to connect it to verify that all
settings are correct and then disconnect it until you are ready to use it. For help with
failures, see Troubleshooting a custom key store in the Key Management Service Developer
Guide. Cross-account use: No. You cannot perform this operation on a custom key store in a
different Amazon Web Services account. Required permissions: kms:CreateCustomKeyStore (IAM
policy). Related operations: ConnectCustomKeyStore DeleteCustomKeyStore
DescribeCustomKeyStores DisconnectCustomKeyStore UpdateCustomKeyStore Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Arguments
- `custom_key_store_name`: Specifies a friendly name for the custom key store. The name
must be unique in your Amazon Web Services account and Region. This parameter is required
for all custom key stores. Do not include confidential or sensitive information in this
field. This field may be displayed in plaintext in CloudTrail logs and other output.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudHsmClusterId"`: Identifies the CloudHSM cluster for an CloudHSM key store. This
parameter is required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM. Enter
the cluster ID of any active CloudHSM cluster that is not already associated with a custom
key store. To find the cluster ID, use the DescribeClusters operation.
- `"CustomKeyStoreType"`: Specifies the type of custom key store. The default value is
AWS_CLOUDHSM. For a custom key store backed by an CloudHSM cluster, omit the parameter or
enter AWS_CLOUDHSM. For a custom key store backed by an external key manager outside of
Amazon Web Services, enter EXTERNAL_KEY_STORE. You cannot change this property after the
key store is created.
- `"KeyStorePassword"`: Specifies the kmsuser password for an CloudHSM key store. This
parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.
Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM
cluster. KMS logs into the cluster as this user to manage key material on your behalf. The
password must be a string of 7 to 32 characters. Its value is case sensitive. This
parameter tells KMS the kmsuser account password; it does not change the password in the
CloudHSM cluster.
- `"TrustAnchorCertificate"`: Specifies the certificate for an CloudHSM key store. This
parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.
Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the
content of the customerCA.crt file that you created when you initialized the cluster.
- `"XksProxyAuthenticationCredential"`: Specifies an authentication credential for the
external key store proxy (XKS proxy). This parameter is required for all custom key stores
with a CustomKeyStoreType of EXTERNAL_KEY_STORE. The XksProxyAuthenticationCredential has
two required elements: RawSecretAccessKey, a secret key, and AccessKeyId, a unique
identifier for the RawSecretAccessKey. For character requirements, see
XksProxyAuthenticationCredentialType. KMS uses this authentication credential to sign
requests to the external key store proxy on your behalf. This credential is unrelated to
Identity and Access Management (IAM) and Amazon Web Services credentials. This parameter
doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS
the credential that you established on your external key store proxy. If you rotate your
proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new
credential to KMS.
- `"XksProxyConnectivity"`: Indicates how KMS communicates with the external key store
proxy. This parameter is required for custom key stores with a CustomKeyStoreType of
EXTERNAL_KEY_STORE. If the external key store proxy uses a public endpoint, specify
PUBLIC_ENDPOINT. If the external key store proxy uses a Amazon VPC endpoint service for
communication with KMS, specify VPC_ENDPOINT_SERVICE. For help making this choice, see
Choosing a connectivity option in the Key Management Service Developer Guide. An Amazon VPC
endpoint service keeps your communication with KMS in a private address space entirely
within Amazon Web Services, but it requires more configuration, including establishing a
Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a
verified private DNS name. A public endpoint is simpler to set up, but it might be slower
and might not fulfill your security requirements. You might consider testing with a public
endpoint, and then establishing a VPC endpoint service for production tasks. Note that this
choice does not determine the location of the external key store proxy. Even if you choose
a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web
Services such as in your corporate data center.
- `"XksProxyUriEndpoint"`: Specifies the endpoint that KMS uses to send requests to the
external key store proxy (XKS proxy). This parameter is required for custom key stores with
a CustomKeyStoreType of EXTERNAL_KEY_STORE. The protocol must be HTTPS. KMS communicates on
port 443. Do not specify the port in the XksProxyUriEndpoint value. For external key stores
with XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https:// followed by the
private DNS name of the VPC endpoint service. For external key stores with PUBLIC_ENDPOINT
connectivity, this endpoint must be reachable before you create the custom key store. KMS
connects to the external key store proxy while creating the custom key store. For external
key stores with VPC_ENDPOINT_SERVICE connectivity, KMS connects when you call the
ConnectCustomKeyStore operation. The value of this parameter must begin with https://. The
remainder can contain upper and lower case letters (A-Z and a-z), numbers (0-9), dots (.),
and hyphens (-). Additional slashes (/ and ) are not permitted. Uniqueness requirements:
The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon
Web Services account and Region. An external key store with PUBLIC_ENDPOINT connectivity
cannot use the same XksProxyUriEndpoint value as an external key store with
VPC_ENDPOINT_SERVICE connectivity in this Amazon Web Services Region. Each external key
store with VPC_ENDPOINT_SERVICE connectivity must have its own private DNS name. The
XksProxyUriEndpoint value for external key stores with VPC_ENDPOINT_SERVICE connectivity
(private DNS name) must be unique in the Amazon Web Services account and Region.
- `"XksProxyUriPath"`: Specifies the base path to the proxy APIs for this external key
store. To find this value, see the documentation for your external key store proxy. This
parameter is required for all custom key stores with a CustomKeyStoreType of
EXTERNAL_KEY_STORE. The value must start with / and must end with /kms/xks/v1 where v1
represents the version of the KMS external key store proxy API. This path can include an
optional prefix between the required elements such as /prefix/kms/xks/v1. Uniqueness
requirements: The combined XksProxyUriEndpoint and XksProxyUriPath values must be
unique in the Amazon Web Services account and Region.
- `"XksProxyVpcEndpointServiceName"`: Specifies the name of the Amazon VPC endpoint service
for interface endpoints that is used to communicate with your external key store proxy (XKS
proxy). This parameter is required when the value of CustomKeyStoreType is
EXTERNAL_KEY_STORE and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE. The
Amazon VPC endpoint service must fulfill all requirements for use with an external key
store. Uniqueness requirements: External key stores with VPC_ENDPOINT_SERVICE
connectivity can share an Amazon VPC, but each external key store must have its own VPC
endpoint service and private DNS name.
"""
function create_custom_key_store(
CustomKeyStoreName; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"CreateCustomKeyStore",
Dict{String,Any}("CustomKeyStoreName" => CustomKeyStoreName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_key_store(
CustomKeyStoreName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"CreateCustomKeyStore",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CustomKeyStoreName" => CustomKeyStoreName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_grant(grantee_principal, key_id, operations)
create_grant(grantee_principal, key_id, operations, params::Dict{String,<:Any})
Adds a grant to a KMS key. A grant is a policy instrument that allows Amazon Web Services
principals to use KMS keys in cryptographic operations. It also can allow them to view a
KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key,
grants are considered along with key policies and IAM policies. Grants are often used for
temporary permissions because you can create one, use its permissions, and delete it
without changing your key policies or IAM policies. For detailed information about grants,
including grant terminology, see Grants in KMS in the Key Management Service Developer
Guide . For examples of working with grants in several programming languages, see
Programming grants. The CreateGrant operation returns a GrantToken and a GrantId. When
you create, retire, or revoke a grant, there might be a brief delay, usually less than five
minutes, until the grant is available throughout KMS. This state is known as eventual
consistency. Once the grant has achieved eventual consistency, the grantee principal can
use the permissions in the grant without identifying the grant. However, to use the
permissions in the grant immediately, use the GrantToken that CreateGrant returns. For
details, see Using a grant token in the Key Management Service Developer Guide . The
CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier
to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID,
use the ListGrants or ListRetirableGrants operations. The KMS key that you use for this
operation must be in a compatible key state. For details, see Key states of KMS keys in the
Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation
on a KMS key in a different Amazon Web Services account, specify the key ARN in the value
of the KeyId parameter. Required permissions: kms:CreateGrant (key policy) Related
operations: ListGrants ListRetirableGrants RetireGrant RevokeGrant
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `grantee_principal`: The identity that gets the permissions specified in the grant. To
specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services
principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles,
federated users, and assumed role users. For help with the ARN syntax for a principal, see
IAM ARNs in the Identity and Access Management User Guide .
- `key_id`: Identifies the KMS key for the grant. The grant gives principals permission to
use this KMS key. Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
different Amazon Web Services account, you must use the key ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `operations`: A list of operations that the grant permits. This list must include only
operations that are permitted in a grant. Also, the operation must be supported on the KMS
key. For example, you cannot create a grant for a symmetric encryption KMS key that allows
the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey
operation. If you try, KMS returns a ValidationError exception. For details, see Grant
operations in the Key Management Service Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Constraints"`: Specifies a grant constraint. Do not include confidential or sensitive
information in this field. This field may be displayed in plaintext in CloudTrail logs and
other output. KMS supports the EncryptionContextEquals and EncryptionContextSubset grant
constraints, which allow the permissions in the grant only when the encryption context in
the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the
encryption context specified in the constraint. The encryption context grant constraints
are supported only on grant operations that include an EncryptionContext parameter, such as
cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints
can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to
these operations. If a grant with a grant constraint includes the CreateGrant operation,
the constraint requires that any grants created with the CreateGrant permission have an
equally strict or stricter encryption context constraint. You cannot use an encryption
context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS
keys. Operations with these keys don't support an encryption context. Each constraint value
can include up to 8 encryption context pairs. The encryption context value in each
constraint cannot exceed 384 characters. For information about grant constraints, see Using
grant constraints in the Key Management Service Developer Guide. For more information about
encryption context, see Encryption context in the Key Management Service Developer Guide .
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"Name"`: A friendly name for the grant. Use this value to prevent the unintended
creation of duplicate grants when retrying this request. Do not include confidential or
sensitive information in this field. This field may be displayed in plaintext in CloudTrail
logs and other output. When this value is absent, all CreateGrant requests result in a new
grant with a unique GrantId even if all the supplied parameters are identical. This can
result in unintended duplicates when you retry the CreateGrant request. When this value is
present, you can retry a CreateGrant request with identical parameters; if the grant
already exists, the original GrantId is returned without creating a new grant. Note that
the returned grant token is unique with every CreateGrant request, even when a duplicate
GrantId is returned. All grant tokens for the same grant ID can be used interchangeably.
- `"RetiringPrincipal"`: The principal that has permission to use the RetireGrant operation
to retire the grant. To specify the principal, use the Amazon Resource Name (ARN) of an
Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM
users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for
a principal, see IAM ARNs in the Identity and Access Management User Guide . The grant
determines the retiring principal. Other principals might have permission to retire the
grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in
the Key Management Service Developer Guide.
"""
function create_grant(
GranteePrincipal, KeyId, Operations; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"CreateGrant",
Dict{String,Any}(
"GranteePrincipal" => GranteePrincipal,
"KeyId" => KeyId,
"Operations" => Operations,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_grant(
GranteePrincipal,
KeyId,
Operations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"CreateGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GranteePrincipal" => GranteePrincipal,
"KeyId" => KeyId,
"Operations" => Operations,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_key()
create_key(params::Dict{String,<:Any})
Creates a unique customer managed KMS key in your Amazon Web Services account and Region.
You can use a KMS key in cryptographic operations, such as encryption and signing. Some
Amazon Web Services services let you use KMS keys that you create and manage to protect
your service resources. A KMS key is a logical representation of a cryptographic key. In
addition to the key material used in cryptographic operations, a KMS key includes metadata,
such as the key ID, key policy, creation date, description, and key state. For details, see
Managing keys in the Key Management Service Developer Guide Use the parameters of
CreateKey to specify the type of KMS key, the source of its key material, its key policy,
description, tags, and other properties. KMS has replaced the term customer master key
(CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes,
KMS is keeping some variations of this term. To create different types of KMS keys, use
the following guidance: Symmetric encryption KMS key By default, CreateKey creates a
symmetric encryption KMS key with key material that KMS generates. This is the basic and
most widely used type of KMS key, and provides the best performance. To create a symmetric
encryption KMS key, you don't need to specify any parameters. The default value for
KeySpec, SYMMETRIC_DEFAULT, the default value for KeyUsage, ENCRYPT_DECRYPT, and the
default value for Origin, AWS_KMS, create a symmetric encryption KMS key with KMS key
material. If you need a key for basic encryption and decryption or you are creating a KMS
key to protect your resources in an Amazon Web Services service, create a symmetric
encryption KMS key. The key material in a symmetric encryption key never leaves KMS
unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to
4,096 bytes, but they are typically used to generate data keys and data keys pairs. For
details, see GenerateDataKey and GenerateDataKeyPair. Asymmetric KMS keys To create an
asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the
KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to
encrypt and decrypt or sign and verify. You can't change these properties after the KMS key
is created. Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or
an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves
KMS unencrypted. However, you can use the GetPublicKey operation to download the public key
so it can be used outside of KMS. Each KMS key can have only one key usage. KMS keys with
RSA key pairs can be used to encrypt and decrypt data or sign and verify messages (but not
both). KMS keys with NIST-recommended ECC key pairs can be used to sign and verify messages
or derive shared secrets (but not both). KMS keys with ECC_SECG_P256K1 can be used only to
sign and verify messages. KMS keys with SM2 key pairs (China Regions only) can be used to
either encrypt and decrypt data, sign and verify messages, or derive shared secrets (you
must choose one key usage type). For information about asymmetric KMS keys, see Asymmetric
KMS keys in the Key Management Service Developer Guide. HMAC KMS key To create an HMAC
KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the
KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage even though
GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change
these properties after the KMS key is created. HMAC KMS keys are symmetric keys that never
leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify
(VerifyMac) HMAC codes for messages up to 4096 bytes. Multi-Region primary keys Imported
key material To create a multi-Region primary key in the local Amazon Web Services Region,
use the MultiRegion parameter with a value of True. To create a multi-Region replica key,
that is, a KMS key with the same key ID and key material as a primary key, but in a
different Amazon Web Services Region, use the ReplicateKey operation. To change a replica
key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion
operation. You can create multi-Region KMS keys for all supported KMS key types: symmetric
encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing
KMS keys. You can also create multi-Region keys with imported key material. However, you
can't create multi-Region keys in a custom key store. This operation supports multi-Region
keys, an KMS feature that lets you create multiple interoperable KMS keys in different
Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and
other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services
Region and decrypt it in a different Amazon Web Services Region without re-encrypting the
data or making a cross-Region call. For more information about multi-Region keys, see
Multi-Region keys in KMS in the Key Management Service Developer Guide. To import your
own key material into a KMS key, begin by creating a KMS key with no key material. To do
this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use
GetParametersForImport operation to get a public key and import token. Use the wrapping
public key to encrypt your key material. Then, use ImportKeyMaterial with your import token
to import the key material. For step-by-step instructions, see Importing Key Material in
the Key Management Service Developer Guide . You can import key material into KMS keys of
all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric
encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys
with imported key material. However, you can't import key material into a KMS key in a
custom key store. To create a multi-Region primary key with imported key material, use the
Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a
value of True. To create replicas of the multi-Region primary key, use the ReplicateKey
operation. For instructions, see Importing key material into multi-Region keys. For more
information about multi-Region keys, see Multi-Region keys in KMS in the Key Management
Service Developer Guide. Custom key store A custom key store lets you protect your
Amazon Web Services resources using keys in a backing key store that you own and manage.
When you request a cryptographic operation with a KMS key in a custom key store, the
operation is performed in the backing key store using its cryptographic keys. KMS supports
CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an
external key manager outside of Amazon Web Services. When you create a KMS key in an
CloudHSM key store, KMS generates an encryption key in the CloudHSM cluster and associates
it with the KMS key. When you create a KMS key in an external key store, you specify an
existing encryption key in the external key manager. Some external key managers provide a
simpler method for creating a KMS key in an external key store. For details, see your
external key manager documentation. Before you create a KMS key in a custom key store, the
ConnectionState of the key store must be CONNECTED. To connect the custom key store, use
the ConnectCustomKeyStore operation. To find the ConnectionState, use the
DescribeCustomKeyStores operation. To create a KMS key in a custom key store, use the
CustomKeyStoreId. Use the default KeySpec value, SYMMETRIC_DEFAULT, and the default
KeyUsage value, ENCRYPT_DECRYPT to create a symmetric encryption key. No other key type is
supported in a custom key store. To create a KMS key in an CloudHSM key store, use the
Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with
the custom key store must have at least two active HSMs in different Availability Zones in
the Amazon Web Services Region. To create a KMS key in an external key store, use the
Origin parameter with a value of EXTERNAL_KEY_STORE and an XksKeyId parameter that
identifies an existing external key. Some external key managers provide a simpler method
for creating a KMS key in an external key store. For details, see your external key manager
documentation. Cross-account use: No. You cannot use this operation to create a KMS key
in a different Amazon Web Services account. Required permissions: kms:CreateKey (IAM
policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and
information about related permissions, see Allow a user to create KMS keys in the Key
Management Service Developer Guide. Related operations: DescribeKey ListKeys
ScheduleKeyDeletion Eventual consistency: The KMS API follows an eventual consistency
model. For more information, see KMS eventual consistency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassPolicyLockoutSafetyCheck"`: Skips (\"bypasses\") the key policy lockout safety
check. The default value is false. Setting this value to true increases the risk that the
KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more
information, see Default key policy in the Key Management Service Developer Guide. Use
this parameter only when you intend to prevent the principal that is making the request
from making a subsequent PutKeyPolicy request on the KMS key.
- `"CustomKeyStoreId"`: Creates the KMS key in the specified custom key store. The
ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and
ConnectionState use the DescribeCustomKeyStores operation. This parameter is valid only for
symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS
key in a custom key store. When you create a KMS key in an CloudHSM key store, KMS
generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and
associates it with the KMS key. When you create a KMS key in an external key store, you
must use the XksKeyId parameter to specify an external key that serves as key material for
the KMS key.
- `"CustomerMasterKeySpec"`: Instead, use the KeySpec parameter. The KeySpec and
CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend
that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS
supports both parameters.
- `"Description"`: A description of the KMS key. Use a description that helps you decide
whether the KMS key is appropriate for a task. The default value is an empty string (no
description). Do not include confidential or sensitive information in this field. This
field may be displayed in plaintext in CloudTrail logs and other output. To set or change
the description after the key is created, use UpdateKeyDescription.
- `"KeySpec"`: Specifies the type of KMS key to create. The default value,
SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption
and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses
SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type
in the Key Management Service Developer Guide . The KeySpec determines whether the KMS key
contains a symmetric key or an asymmetric key pair. It also determines the algorithms that
the KMS key supports. You can't change the KeySpec after the KMS key is created. To further
restrict the algorithms that can be used with the KMS key, use a condition key in its key
policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm
or kms:Signing Algorithm in the Key Management Service Developer Guide . Amazon Web
Services services that are integrated with KMS use symmetric encryption KMS keys to protect
your data. These services do not support asymmetric KMS keys or HMAC KMS keys. KMS
supports the following key specs for KMS keys: Symmetric encryption key (default)
SYMMETRIC_DEFAULT HMAC keys (symmetric) HMAC_224 HMAC_256 HMAC_384
HMAC_512 Asymmetric RSA key pairs (encryption and decryption -or- signing and
verification) RSA_2048 RSA_3072 RSA_4096 Asymmetric NIST-recommended
elliptic curve key pairs (signing and verification -or- deriving shared secrets)
ECC_NIST_P256 (secp256r1) ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification) ECC_SECG_P256K1
(secp256k1), commonly used for cryptocurrencies. SM2 key pairs (encryption and
decryption -or- signing and verification -or- deriving shared secrets) SM2 (China
Regions only)
- `"KeyUsage"`: Determines the cryptographic operations for which you can use the KMS key.
The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a
symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage
value after the KMS key is created. Select only one valid value. For symmetric encryption
KMS keys, omit the parameter or specify ENCRYPT_DECRYPT. For HMAC KMS keys (symmetric),
specify GENERATE_VERIFY_MAC. For asymmetric KMS keys with RSA key pairs, specify
ENCRYPT_DECRYPT or SIGN_VERIFY. For asymmetric KMS keys with NIST-recommended elliptic
curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT. For asymmetric KMS keys with
ECC_SECG_P256K1 key pairs specify SIGN_VERIFY. For asymmetric KMS keys with SM2 key pairs
(China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
- `"MultiRegion"`: Creates a multi-Region primary key that you can replicate into other
Amazon Web Services Regions. You cannot change this value after you create the KMS key.
For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this
parameter or set it to False. The default value is False. This operation supports
multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in
different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
material, and other metadata, you can use them interchangeably to encrypt data in one
Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without
re-encrypting the data or making a cross-Region call. For more information about
multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer
Guide. This value creates a primary key, not a replica. To create a replica key, use the
ReplicateKey operation. You can create a symmetric or asymmetric multi-Region key, and you
can create a multi-Region key with imported key material. However, you cannot create a
multi-Region key in a custom key store.
- `"Origin"`: The source of the key material for the KMS key. You cannot change the origin
after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key
material. To create a KMS key with no key material (for imported key material), set this
value to EXTERNAL. For more information about importing key material into KMS, see
Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin
value is valid only for symmetric KMS keys. To create a KMS key in an CloudHSM key store
and create its key material in the associated CloudHSM cluster, set this value to
AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key
store. The KeySpec value must be SYMMETRIC_DEFAULT. To create a KMS key in an external key
store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId
parameter to identify the external key store and the XksKeyId parameter to identify the
associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
- `"Policy"`: The key policy to attach to the KMS key. If you provide a key policy, it must
meet the following criteria: The key policy must allow the calling principal to make a
subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key
becomes unmanageable. For more information, see Default key policy in the Key Management
Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to
true.) Each statement in the key policy must contain one or more principals. The
principals in the key policy must exist and be visible to KMS. When you create a new Amazon
Web Services principal, you might need to enforce a delay before including the new
principal in a key policy because the new principal might not be immediately visible to
KMS. For more information, see Changes that I make are not always immediately visible in
the Amazon Web Services Identity and Access Management User Guide. If you do not provide
a key policy, KMS attaches a default key policy to the KMS key. For more information, see
Default key policy in the Key Management Service Developer Guide. The key policy size
quota is 32 kilobytes (32768 bytes). For help writing and formatting a JSON policy
document, see the IAM JSON Policy Reference in the Identity and Access Management User
Guide .
- `"Tags"`: Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key
when it is created. To tag an existing KMS key, use the TagResource operation. Do not
include confidential or sensitive information in this field. This field may be displayed in
plaintext in CloudTrail logs and other output. Tagging or untagging a KMS key can allow
or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
Service Developer Guide. To use this parameter, you must have kms:TagResource permission
in an IAM policy. Each tag consists of a tag key and a tag value. Both the tag key and the
tag value are required, but the tag value can be an empty (null) string. You cannot have
more than one tag on a KMS key with the same tag key. If you specify an existing tag key
with a different tag value, KMS replaces the current tag value with the specified one. When
you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost
allocation report with usage and costs aggregated by tags. Tags can also be used to control
access to a KMS key. For details, see Tagging Keys.
- `"XksKeyId"`: Identifies the external key that serves as key material for the KMS key in
an external key store. Specify the ID that the external key store proxy uses to refer to
the external key. For help, see the documentation for your external key store proxy. This
parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not
valid for KMS keys with any other Origin value. The external key must be an existing
256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external
key manager associated with the external key store specified by the CustomKeyStoreId
parameter. This key must be enabled and configured to perform encryption and decryption.
Each KMS key in an external key store must use a different external key. For details, see
Requirements for a KMS key in an external key store in the Key Management Service Developer
Guide. Each KMS key in an external key store is associated two backing keys. One is key
material that KMS generates. The other is the external key specified by this parameter.
When you use the KMS key in an external key store to encrypt data, the encryption operation
is performed first by KMS using the KMS key material, and then by the external key manager
using the specified external key, a process known as double encryption. For details, see
Double encryption in the Key Management Service Developer Guide.
"""
function create_key(; aws_config::AbstractAWSConfig=global_aws_config())
return kms("CreateKey"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_key(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms("CreateKey", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
decrypt(ciphertext_blob)
decrypt(ciphertext_blob, params::Dict{String,<:Any})
Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext
GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext
that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS
key. When the KMS key is asymmetric, you must specify the KMS key and the encryption
algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS
keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt
operation also decrypts ciphertext that was encrypted outside of KMS by the public key in
an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by
other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side
encryption. These libraries return a ciphertext format that is incompatible with KMS. If
the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is
optional. KMS can get this information from metadata that it adds to the symmetric
ciphertext blob. This feature adds durability to your implementation by ensuring that
authorized users can decrypt ciphertext decades after it was encrypted, even if they've
lost track of the key ID. However, specifying the KMS key is always recommended as a best
practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key
you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt
operation fails. This practice ensures that you use the KMS key that you intend. Whenever
possible, use key policies to give users permission to call the Decrypt operation on a
particular KMS key, instead of using &IAM; policies. Otherwise, you might create an
&IAM; policy that gives the user Decrypt permission on all KMS keys. This user could
decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for
the cross-account KMS key permits it. If you must use an IAM policy for Decrypt
permissions, limit the user to particular KMS keys or particular trusted accounts. For
details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Decrypt also supports Amazon Web Services Nitro Enclaves, which provide an isolated
compute environment in Amazon EC2. To call Decrypt for a Nitro enclave, use the Amazon Web
Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to
provide the attestation document for the enclave. Instead of the plaintext data, the
response includes the plaintext data encrypted with the public key from the attestation
document (CiphertextForRecipient). For information about the interaction between KMS and
Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in
the Key Management Service Developer Guide. The KMS key that you use for this operation
must be in a compatible key state. For details, see Key states of KMS keys in the Key
Management Service Developer Guide. Cross-account use: Yes. If you use the KeyId parameter
to identify a KMS key in a different Amazon Web Services account, specify the key ARN or
the alias ARN of the KMS key. Required permissions: kms:Decrypt (key policy) Related
operations: Encrypt GenerateDataKey GenerateDataKeyPair ReEncrypt
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `ciphertext_blob`: Ciphertext to be decrypted. The blob includes metadata.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"EncryptionAlgorithm"`: Specifies the encryption algorithm that will be used to decrypt
the ciphertext. Specify the same algorithm that was used to encrypt the data. If you
specify a different algorithm, the Decrypt operation fails. This parameter is required only
when the ciphertext was encrypted under an asymmetric KMS key. The default value,
SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric
encryption KMS keys.
- `"EncryptionContext"`: Specifies the encryption context to use when decrypting the data.
An encryption context is valid only for cryptographic operations with a symmetric
encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that
KMS uses do not support an encryption context. An encryption context is a collection of
non-secret key-value pairs that represent additional authenticated data. When you use an
encryption context to encrypt data, you must specify the same (an exact case-sensitive
match) encryption context to decrypt the data. An encryption context is supported only on
operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS
keys, an encryption context is optional, but it is strongly recommended. For more
information, see Encryption context in the Key Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"KeyId"`: Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a key ID
of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS
key, the Decrypt operation throws an IncorrectKeyException. This parameter is required only
when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric
encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric
ciphertext blob. However, it is always recommended as a best practice. This practice
ensures that you use the KMS key that you intend. To specify a KMS key, use its key ID, key
ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To
specify a KMS key in a different Amazon Web Services account, you must use the key ARN or
alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
- `"Recipient"`: A signed attestation document from an Amazon Web Services Nitro enclave
and the encryption algorithm to use with the enclave's public key. The only valid
encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation
documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon
Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. When you use this
parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with
the public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient field in the response. This ciphertext can be decrypted only with
the private key in the enclave. The Plaintext field in the response is null or empty. For
information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see
How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer
Guide.
"""
function decrypt(CiphertextBlob; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"Decrypt",
Dict{String,Any}("CiphertextBlob" => CiphertextBlob);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decrypt(
CiphertextBlob,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"Decrypt",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CiphertextBlob" => CiphertextBlob), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alias(alias_name)
delete_alias(alias_name, params::Dict{String,<:Any})
Deletes the specified alias. Adding, deleting, or updating an alias can allow or deny
permission to the KMS key. For details, see ABAC for KMS in the Key Management Service
Developer Guide. Because an alias is not a property of a KMS key, you can delete and
change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear
in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the
ListAliases operation. Each KMS key can have multiple aliases. To change the alias of a
KMS key, use DeleteAlias to delete the current alias and CreateAlias to create a new alias.
To associate an existing alias with a different KMS key, call UpdateAlias. Cross-account
use: No. You cannot perform this operation on an alias in a different Amazon Web Services
account. Required permissions kms:DeleteAlias on the alias (IAM policy).
kms:DeleteAlias on the KMS key (key policy). For details, see Controlling access to
aliases in the Key Management Service Developer Guide. Related operations: CreateAlias
ListAliases UpdateAlias Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `alias_name`: The alias to be deleted. The alias name must begin with alias/ followed by
the alias name, such as alias/ExampleAlias.
"""
function delete_alias(AliasName; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"DeleteAlias",
Dict{String,Any}("AliasName" => AliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alias(
AliasName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"DeleteAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AliasName" => AliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_key_store(custom_key_store_id)
delete_custom_key_store(custom_key_store_id, params::Dict{String,<:Any})
Deletes a custom key store. This operation does not affect any backing elements of the
custom key store. It does not delete the CloudHSM cluster that is associated with an
CloudHSM key store, or affect any users or keys in the cluster. For an external key store,
it does not affect the external key store proxy, external key manager, or any external
keys. This operation is part of the custom key stores feature in KMS, which combines the
convenience and extensive integration of KMS with the isolation and control of a key store
that you own and manage. The custom key store that you delete cannot contain any KMS keys.
Before deleting the key store, verify that you will never need to use any of the KMS keys
in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete
the KMS keys from the key store. After the required waiting period expires and all KMS keys
are deleted from the custom key store, use DisconnectCustomKeyStore to disconnect the key
store from KMS. Then, you can delete the custom key store. For keys in an CloudHSM key
store, the ScheduleKeyDeletion operation makes a best effort to delete the key material
from the associated cluster. However, you might need to manually delete the orphaned key
material from the cluster and its backups. KMS never creates, manages, or deletes
cryptographic keys in the external key manager associated with an external key store. You
must manage them using your external key manager tools. Instead of deleting the custom key
store, consider using the DisconnectCustomKeyStore operation to disconnect the custom key
store from its backing key store. While the key store is disconnected, you cannot create or
use the KMS keys in the key store. But, you do not need to delete KMS keys and you can
reconnect a disconnected custom key store at any time. If the operation succeeds, it
returns a JSON object with no properties. Cross-account use: No. You cannot perform this
operation on a custom key store in a different Amazon Web Services account. Required
permissions: kms:DeleteCustomKeyStore (IAM policy) Related operations:
ConnectCustomKeyStore CreateCustomKeyStore DescribeCustomKeyStores
DisconnectCustomKeyStore UpdateCustomKeyStore Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `custom_key_store_id`: Enter the ID of the custom key store you want to delete. To find
the ID of a custom key store, use the DescribeCustomKeyStores operation.
"""
function delete_custom_key_store(
CustomKeyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DeleteCustomKeyStore",
Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_key_store(
CustomKeyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"DeleteCustomKeyStore",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_imported_key_material(key_id)
delete_imported_key_material(key_id, params::Dict{String,<:Any})
Deletes key material that was previously imported. This operation makes the specified KMS
key temporarily unusable. To restore the usability of the KMS key, reimport the same key
material. For more information about importing key material into KMS, see Importing Key
Material in the Key Management Service Developer Guide. When the specified KMS key is in
the PendingDeletion state, this operation does not change the KMS key's state. Otherwise,
it changes the KMS key's state to PendingImport. The KMS key that you use for this
operation must be in a compatible key state. For details, see Key states of KMS keys in the
Key Management Service Developer Guide. Cross-account use: No. You cannot perform this
operation on a KMS key in a different Amazon Web Services account. Required permissions:
kms:DeleteImportedKeyMaterial (key policy) Related operations: GetParametersForImport
ImportKeyMaterial Eventual consistency: The KMS API follows an eventual consistency
model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the KMS key from which you are deleting imported key material. The
Origin of the KMS key must be EXTERNAL. Specify the key ID or key ARN of the KMS key. For
example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function delete_imported_key_material(
KeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DeleteImportedKeyMaterial",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_imported_key_material(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DeleteImportedKeyMaterial",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
derive_shared_secret(key_agreement_algorithm, key_id, public_key)
derive_shared_secret(key_agreement_algorithm, key_id, public_key, params::Dict{String,<:Any})
Derives a shared secret using a key agreement algorithm. You must use an asymmetric
NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) KMS key pair with a
KeyUsage value of KEY_AGREEMENT to call DeriveSharedSecret. DeriveSharedSecret uses the
Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive (ECDH) to establish a key
agreement between two peers by deriving a shared secret from their elliptic curve
public-private key pairs. You can use the raw shared secret that DeriveSharedSecret returns
to derive a symmetric key that can encrypt and decrypt data that is sent between the two
peers, or that can generate and verify HMACs. KMS recommends that you follow NIST
recommendations for key derivation when using the raw shared secret to derive a symmetric
key. The following workflow demonstrates how to establish key agreement over an insecure
communication channel using DeriveSharedSecret. Alice calls CreateKey to create an
asymmetric KMS key pair with a KeyUsage value of KEY_AGREEMENT. The asymmetric KMS key must
use a NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key spec. Bob
creates an elliptic curve key pair. Bob can call CreateKey to create an asymmetric KMS key
pair or generate a key pair outside of KMS. Bob's key pair must use the same
NIST-recommended elliptic curve (ECC) or SM2 (China Regions ony) curve as Alice. Alice
and Bob exchange their public keys through an insecure communication channel (like the
internet). Use GetPublicKey to download the public key of your asymmetric KMS key pair.
KMS strongly recommends verifying that the public key you receive came from the expected
party before using it to derive a shared secret. Alice calls DeriveSharedSecret. KMS
uses the private key from the KMS key pair generated in Step 1, Bob's public key, and the
Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive to derive the shared secret.
The private key in your KMS key pair never leaves KMS unencrypted. DeriveSharedSecret
returns the raw shared secret. Bob uses the Elliptic Curve Cryptography Cofactor
Diffie-Hellman Primitive to calculate the same raw secret using his private key and Alice's
public key. To derive a shared secret you must provide a key agreement algorithm, the
private key of the caller's asymmetric NIST-recommended elliptic curve or SM2 (China
Regions only) KMS key pair, and the public key from your peer's NIST-recommended elliptic
curve or SM2 (China Regions only) key pair. The public key can be from another asymmetric
KMS key pair or from a key pair generated outside of KMS, but both key pairs must be on the
same elliptic curve. The KMS key that you use for this operation must be in a compatible
key state. For details, see Key states of KMS keys in the Key Management Service Developer
Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter. Required permissions: kms:DeriveSharedSecret (key policy) Related operations:
CreateKey GetPublicKey DescribeKey Eventual consistency: The KMS API follows
an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_agreement_algorithm`: Specifies the key agreement algorithm used to derive the
shared secret. The only valid value is ECDH.
- `key_id`: Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS
key. KMS uses the private key in the specified key pair to derive the shared secret. The
key usage of the KMS key must be KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the
DescribeKey operation. To specify a KMS key, use its key ID, key ARN, alias name, or alias
ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a
different Amazon Web Services account, you must use the key ARN or alias ARN. For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
- `public_key`: Specifies the public key in your peer's NIST-recommended elliptic curve
(ECC) or SM2 (China Regions only) key pair. The public key must be a DER-encoded X.509
public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280.
GetPublicKey returns the public key of an asymmetric KMS key pair in the required
DER-encoded format. If you use Amazon Web Services CLI version 1, you must provide the
DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services CLI
Base64-encodes the public key a second time, resulting in a ValidationException. You can
specify the public key as binary data in a file using fileb (fileb://<path-to-file>)
or in-line using a Base64 encoded string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"Recipient"`: A signed attestation document from an Amazon Web Services Nitro enclave
and the encryption algorithm to use with the enclave's public key. The only valid
encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation
documents for Amazon Web Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon
Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the
attestation document and then use the Recipient parameter from any Amazon Web Services SDK
to provide the attestation document for the enclave. When you use this parameter, instead
of returning a plaintext copy of the shared secret, KMS encrypts the plaintext shared
secret under the public key in the attestation document, and returns the resulting
ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be
decrypted only with the private key in the enclave. The CiphertextBlob field in the
response contains the encrypted shared secret derived from the KMS key specified by the
KeyId parameter and public key specified by the PublicKey parameter. The SharedSecret field
in the response is null or empty. For information about the interaction between KMS and
Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in
the Key Management Service Developer Guide.
"""
function derive_shared_secret(
KeyAgreementAlgorithm,
KeyId,
PublicKey;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"DeriveSharedSecret",
Dict{String,Any}(
"KeyAgreementAlgorithm" => KeyAgreementAlgorithm,
"KeyId" => KeyId,
"PublicKey" => PublicKey,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function derive_shared_secret(
KeyAgreementAlgorithm,
KeyId,
PublicKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"DeriveSharedSecret",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyAgreementAlgorithm" => KeyAgreementAlgorithm,
"KeyId" => KeyId,
"PublicKey" => PublicKey,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_key_stores()
describe_custom_key_stores(params::Dict{String,<:Any})
Gets information about custom key stores in the account and Region. This operation is part
of the custom key stores feature in KMS, which combines the convenience and extensive
integration of KMS with the isolation and control of a key store that you own and manage.
By default, this operation returns information about all custom key stores in the account
and Region. To get only information about a particular custom key store, use either the
CustomKeyStoreName or CustomKeyStoreId parameter (but not both). To determine whether the
custom key store is connected to its CloudHSM cluster or external key store proxy, use the
ConnectionState element in the response. If an attempt to connect the custom key store
failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the
response indicates the cause of the failure. For help interpreting the ConnectionErrorCode,
see CustomKeyStoresListEntry. Custom key stores have a DISCONNECTED connection state if the
key store has never been connected or you used the DisconnectCustomKeyStore operation to
disconnect it. Otherwise, the connection state is CONNECTED. If your custom key store
connection state is CONNECTED but you are having trouble using it, verify that the backing
store is active and available. For an CloudHSM key store, verify that the associated
CloudHSM cluster is active and contains the minimum number of HSMs required for the
operation, if any. For an external key store, verify that the external key store proxy and
its associated external key manager are reachable and enabled. For help repairing your
CloudHSM key store, see the Troubleshooting CloudHSM key stores. For help repairing your
external key store, see the Troubleshooting external key stores. Both topics are in the Key
Management Service Developer Guide. Cross-account use: No. You cannot perform this
operation on a custom key store in a different Amazon Web Services account. Required
permissions: kms:DescribeCustomKeyStores (IAM policy) Related operations:
ConnectCustomKeyStore CreateCustomKeyStore DeleteCustomKeyStore
DisconnectCustomKeyStore UpdateCustomKeyStore Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomKeyStoreId"`: Gets only information about the specified custom key store. Enter
the key store ID. By default, this operation gets information about all custom key stores
in the account and Region. To limit the output to a particular custom key store, provide
either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
- `"CustomKeyStoreName"`: Gets only information about the specified custom key store. Enter
the friendly name of the custom key store. By default, this operation gets information
about all custom key stores in the account and Region. To limit the output to a particular
custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but
not both.
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function describe_custom_key_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"DescribeCustomKeyStores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_custom_key_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DescribeCustomKeyStores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_key(key_id)
describe_key(key_id, params::Dict{String,<:Any})
Provides detailed information about a KMS key. You can run DescribeKey on a customer
managed key or an Amazon Web Services managed key. This detailed information includes the
key ARN, creation date (and deletion date, if applicable), the key state, and the origin
and expiration date (if any) of the key material. It includes fields, like KeySpec, that
help you distinguish different types of KMS keys. It also displays the key usage
(encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key
supports. For multi-Region keys, DescribeKey displays the primary key and all related
replica keys. For KMS keys in CloudHSM key stores, it includes information about the key
store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in external key
stores, it includes the custom key store ID and the ID of the external key. DescribeKey
does not return the following information: Aliases associated with the KMS key. To get
this information, use ListAliases. Whether automatic key rotation is enabled on the KMS
key. To get this information, use GetKeyRotationStatus. Also, some key states prevent a KMS
key from being automatically rotated. For details, see How Automatic Key Rotation Works in
the Key Management Service Developer Guide. Tags on the KMS key. To get this information,
use ListResourceTags. Key policies and grants on the KMS key. To get this information,
use GetKeyPolicy and ListGrants. In general, DescribeKey is a non-mutating operation. It
returns data about KMS keys, but doesn't change them. However, Amazon Web Services services
use DescribeKey to create Amazon Web Services managed keys from a predefined Amazon Web
Services alias with no key ID. Cross-account use: Yes. To perform this operation with a
KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the
value of the KeyId parameter. Required permissions: kms:DescribeKey (key policy) Related
operations: GetKeyPolicy GetKeyRotationStatus ListAliases ListGrants
ListKeys ListResourceTags ListRetirableGrants Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Describes the specified KMS key. If you specify a predefined Amazon Web
Services alias (an Amazon Web Services alias with no key ID), KMS associates the alias with
an Amazon Web Services managed key and returns its KeyId and Arn in the response. To
specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias
name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services
account, you must use the key ARN or alias ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
"""
function describe_key(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"DescribeKey",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_key(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DescribeKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_key(key_id)
disable_key(key_id, params::Dict{String,<:Any})
Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
key for cryptographic operations. For more information about how key state affects the use
of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide .
The KMS key that you use for this operation must be in a compatible key state. For details,
see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account
use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services
account. Required permissions: kms:DisableKey (key policy) Related operations: EnableKey
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the KMS key to disable. Specify the key ID or key ARN of the KMS
key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function disable_key(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"DisableKey",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_key(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DisableKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_key_rotation(key_id)
disable_key_rotation(key_id, params::Dict{String,<:Any})
Disables automatic rotation of the key material of the specified symmetric encryption KMS
key. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot
enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key
material, or KMS keys in a custom key store. To enable or disable automatic rotation of a
set of related multi-Region keys, set the property on the primary key. You can enable
(EnableKeyRotation) and disable automatic rotation of the key material in customer managed
KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not
configurable. KMS always rotates the key material for every year. Rotation of Amazon Web
Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon
Web Services managed keys from every three years to every year. For details, see
EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key
state. For details, see Key states of KMS keys in the Key Management Service Developer
Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a
different Amazon Web Services account. Required permissions: kms:DisableKeyRotation (key
policy) Related operations: EnableKeyRotation GetKeyRotationStatus
ListKeyRotations RotateKeyOnDemand Eventual consistency: The KMS API follows an
eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies a symmetric encryption KMS key. You cannot enable or disable
automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key
material, or KMS keys in a custom key store. Specify the key ID or key ARN of the KMS key.
For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function disable_key_rotation(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"DisableKeyRotation",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_key_rotation(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DisableKeyRotation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_custom_key_store(custom_key_store_id)
disconnect_custom_key_store(custom_key_store_id, params::Dict{String,<:Any})
Disconnects the custom key store from its backing key store. This operation disconnects an
CloudHSM key store from its associated CloudHSM cluster or disconnects an external key
store from the external key store proxy that communicates with your external key manager.
This operation is part of the custom key stores feature in KMS, which combines the
convenience and extensive integration of KMS with the isolation and control of a key store
that you own and manage. While a custom key store is disconnected, you can manage the
custom key store and its KMS keys, but you cannot create or use its KMS keys. You can
reconnect the custom key store at any time. While a custom key store is disconnected, all
attempts to create KMS keys in the custom key store or to use existing KMS keys in
cryptographic operations will fail. This action can prevent users from storing and
accessing sensitive data. When you disconnect a custom key store, its ConnectionState
changes to Disconnected. To find the connection state of a custom key store, use the
DescribeCustomKeyStores operation. To reconnect a custom key store, use the
ConnectCustomKeyStore operation. If the operation succeeds, it returns a JSON object with
no properties. Cross-account use: No. You cannot perform this operation on a custom key
store in a different Amazon Web Services account. Required permissions:
kms:DisconnectCustomKeyStore (IAM policy) Related operations: ConnectCustomKeyStore
CreateCustomKeyStore DeleteCustomKeyStore DescribeCustomKeyStores
UpdateCustomKeyStore Eventual consistency: The KMS API follows an eventual consistency
model. For more information, see KMS eventual consistency.
# Arguments
- `custom_key_store_id`: Enter the ID of the custom key store you want to disconnect. To
find the ID of a custom key store, use the DescribeCustomKeyStores operation.
"""
function disconnect_custom_key_store(
CustomKeyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"DisconnectCustomKeyStore",
Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_custom_key_store(
CustomKeyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"DisconnectCustomKeyStore",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_key(key_id)
enable_key(key_id, params::Dict{String,<:Any})
Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
cryptographic operations. The KMS key that you use for this operation must be in a
compatible key state. For details, see Key states of KMS keys in the Key Management Service
Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in
a different Amazon Web Services account. Required permissions: kms:EnableKey (key policy)
Related operations: DisableKey Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the KMS key to enable. Specify the key ID or key ARN of the KMS key.
For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function enable_key(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"EnableKey",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_key(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"EnableKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_key_rotation(key_id)
enable_key_rotation(key_id, params::Dict{String,<:Any})
Enables automatic rotation of the key material of the specified symmetric encryption KMS
key. By default, when you enable automatic rotation of a customer managed KMS key, KMS
rotates the key material of the KMS key one year (approximately 365 days) from the enable
date and every year thereafter. You can use the optional RotationPeriodInDays parameter to
specify a custom rotation period when you enable key rotation, or you can use
RotationPeriodInDays to modify the rotation period of a key that you previously enabled
automatic key rotation on. You can monitor rotation of the key material for your KMS keys
in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer
managed KMS key, use the DisableKeyRotation operation. You can use the GetKeyRotationStatus
operation to identify any in progress rotations. You can use the ListKeyRotations operation
to view the details of completed rotations. Automatic key rotation is supported only on
symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys,
HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To
enable or disable automatic rotation of a set of related multi-Region keys, set the
property on the primary key. You cannot enable or disable automatic rotation of Amazon Web
Services managed KMS keys. KMS always rotates the key material of Amazon Web Services
managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the
Amazon Web Services service that owns the key. In May 2022, KMS changed the rotation
schedule for Amazon Web Services managed keys from every three years (approximately 1,095
days) to every year (approximately 365 days). New Amazon Web Services managed keys are
automatically rotated one year after they are created, and approximately every year
thereafter. Existing Amazon Web Services managed keys are automatically rotated one year
after their most recent rotation, and every year thereafter. The KMS key that you use for
this operation must be in a compatible key state. For details, see Key states of KMS keys
in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform
this operation on a KMS key in a different Amazon Web Services account. Required
permissions: kms:EnableKeyRotation (key policy) Related operations: DisableKeyRotation
GetKeyRotationStatus ListKeyRotations RotateKeyOnDemand You can perform
on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys,
regardless of whether or not automatic key rotation is enabled. Eventual consistency:
The KMS API follows an eventual consistency model. For more information, see KMS eventual
consistency.
# Arguments
- `key_id`: Identifies a symmetric encryption KMS key. You cannot enable automatic rotation
of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in
a custom key store. To enable or disable automatic rotation of a set of related
multi-Region keys, set the property on the primary key. Specify the key ID or key ARN of
the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RotationPeriodInDays"`: Use this parameter to specify a custom period of time between
each rotation date. If no value is specified, the default value is 365 days. The rotation
period defines the number of days after you enable automatic key rotation that KMS will
rotate your key material, and the number of days between each automatic rotation
thereafter. You can use the kms:RotationPeriodInDays condition key to further constrain
the values that principals can specify in the RotationPeriodInDays parameter.
"""
function enable_key_rotation(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"EnableKeyRotation",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_key_rotation(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"EnableKeyRotation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
encrypt(key_id, plaintext)
encrypt(key_id, plaintext, params::Dict{String,<:Any})
Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or
asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT. You can use this operation to
encrypt small amounts of arbitrary data, such as a personal identifier or database
password, or other sensitive information. You don't need to use the Encrypt operation to
encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a
plaintext data key and an encrypted copy of that data key. If you use a symmetric
encryption KMS key, you can use an encryption context to add additional security to your
encryption operation. If you specify an EncryptionContext when encrypting data, you must
specify the same encryption context (a case-sensitive exact match) when decrypting the
data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more
information, see Encryption Context in the Key Management Service Developer Guide. If you
specify an asymmetric KMS key, you must also specify the encryption algorithm. The
algorithm must be compatible with the KMS key spec. When you use an asymmetric KMS key to
encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you
choose. You will be required to provide the same KMS key and encryption algorithm when you
decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the
data, the decrypt operation fails. You are not required to supply the key ID and encryption
algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this
information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with
asymmetric keys. The standard format for asymmetric key ciphertext does not include
configurable fields. The maximum size of the data that you can encrypt varies with the
type of KMS key and the encryption algorithm that you choose. Symmetric encryption KMS
keys SYMMETRIC_DEFAULT: 4096 bytes RSA_2048 RSAES_OAEP_SHA_1: 214 bytes
RSAES_OAEP_SHA_256: 190 bytes RSA_3072 RSAES_OAEP_SHA_1: 342 bytes
RSAES_OAEP_SHA_256: 318 bytes RSA_4096 RSAES_OAEP_SHA_1: 470 bytes
RSAES_OAEP_SHA_256: 446 bytes SM2PKE: 1024 bytes (China Regions only) The KMS key
that you use for this operation must be in a compatible key state. For details, see Key
states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes.
To perform this operation with a KMS key in a different Amazon Web Services account,
specify the key ARN or alias ARN in the value of the KeyId parameter. Required
permissions: kms:Encrypt (key policy) Related operations: Decrypt GenerateDataKey
GenerateDataKeyPair Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the KMS key to use in the encryption operation. The KMS key must
have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey
operation. To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When
using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon
Web Services account, you must use the key ARN or alias ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
- `plaintext`: Data to be encrypted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"EncryptionAlgorithm"`: Specifies the encryption algorithm that KMS will use to encrypt
the plaintext message. The algorithm must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value,
SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are
using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. The SM2PKE algorithm is only
available in China Regions.
- `"EncryptionContext"`: Specifies the encryption context that will be used to encrypt the
data. An encryption context is valid only for cryptographic operations with a symmetric
encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that
KMS uses do not support an encryption context. Do not include confidential or sensitive
information in this field. This field may be displayed in plaintext in CloudTrail logs and
other output. An encryption context is a collection of non-secret key-value pairs that
represent additional authenticated data. When you use an encryption context to encrypt
data, you must specify the same (an exact case-sensitive match) encryption context to
decrypt the data. An encryption context is supported only on operations with symmetric
encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption
context is optional, but it is strongly recommended. For more information, see Encryption
context in the Key Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
"""
function encrypt(KeyId, Plaintext; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"Encrypt",
Dict{String,Any}("KeyId" => KeyId, "Plaintext" => Plaintext);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function encrypt(
KeyId,
Plaintext,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"Encrypt",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("KeyId" => KeyId, "Plaintext" => Plaintext), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_data_key(key_id)
generate_data_key(key_id, params::Dict{String,<:Any})
Returns a unique symmetric data key for use outside of KMS. This operation returns a
plaintext copy of the data key and a copy that is encrypted under a symmetric encryption
KMS key that you specify. The bytes in the plaintext key are random; they are not related
to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of
KMS and store the encrypted data key with the encrypted data. To generate a data key,
specify the symmetric encryption KMS key that will be used to encrypt the data key. You
cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use
the DescribeKey operation. You must also specify the length of the data key. Use either the
KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use
the KeySpec parameter. To generate a 128-bit SM4 data key (China Regions only), specify a
KeySpec value of AES_128 or a NumberOfBytes value of 16. The symmetric encryption key used
in China Regions to encrypt your data key is an SM4 encryption key. To get only an
encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an
asymmetric data key pair, use the GenerateDataKeyPair or
GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random
byte string, use GenerateRandom. You can use an optional encryption context to add
additional security to the encryption operation. If you specify an EncryptionContext, you
must specify the same encryption context (a case-sensitive exact match) when decrypting the
encrypted data key. Otherwise, the request to decrypt fails with an
InvalidCiphertextException. For more information, see Encryption Context in the Key
Management Service Developer Guide. GenerateDataKey also supports Amazon Web Services
Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call
GenerateDataKey for an Amazon Web Services Nitro enclave, use the Amazon Web Services Nitro
Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the
attestation document for the enclave. GenerateDataKey returns a copy of the data key
encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the
data key, the response includes a copy of the data key encrypted under the public key from
the attestation document (CiphertextForRecipient). For information about the interaction
between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro
Enclaves uses KMS in the Key Management Service Developer Guide.. The KMS key that you use
for this operation must be in a compatible key state. For details, see Key states of KMS
keys in the Key Management Service Developer Guide. How to use your data key We recommend
that you use the following pattern to encrypt data locally in your application. You can
write your own code or use a client-side encryption library, such as the Amazon Web
Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side
encryption to do these tasks for you. To encrypt data outside of KMS: Use the
GenerateDataKey operation to get a data key. Use the plaintext data key (in the Plaintext
field of the response) to encrypt your data outside of KMS. Then erase the plaintext data
key from memory. Store the encrypted data key (in the CiphertextBlob field of the
response) with the encrypted data. To decrypt data outside of KMS: Use the Decrypt
operation to decrypt the encrypted data key. The operation returns a plaintext copy of the
data key. Use the plaintext data key to decrypt data outside of KMS, then erase the
plaintext data key from memory. Cross-account use: Yes. To perform this operation with a
KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the
value of the KeyId parameter. Required permissions: kms:GenerateDataKey (key policy)
Related operations: Decrypt Encrypt GenerateDataKeyPair
GenerateDataKeyPairWithoutPlaintext GenerateDataKeyWithoutPlaintext Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Arguments
- `key_id`: Specifies the symmetric encryption KMS key that encrypts the data key. You
cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type
and origin of your KMS key, use the DescribeKey operation. To specify a KMS key, use its
key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
\"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use
the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for
a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use
ListAliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"EncryptionContext"`: Specifies the encryption context that will be used when encrypting
the data key. Do not include confidential or sensitive information in this field. This
field may be displayed in plaintext in CloudTrail logs and other output. An encryption
context is a collection of non-secret key-value pairs that represent additional
authenticated data. When you use an encryption context to encrypt data, you must specify
the same (an exact case-sensitive match) encryption context to decrypt the data. An
encryption context is supported only on operations with symmetric encryption KMS keys. On
operations with symmetric encryption KMS keys, an encryption context is optional, but it is
strongly recommended. For more information, see Encryption context in the Key Management
Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"KeySpec"`: Specifies the length of the data key. Use AES_128 to generate a 128-bit
symmetric key, or AES_256 to generate a 256-bit symmetric key. You must specify either the
KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.
- `"NumberOfBytes"`: Specifies the length of the data key in bytes. For example, use the
value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and
256-bit (32-byte) data keys, use the KeySpec parameter. You must specify either the KeySpec
or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.
- `"Recipient"`: A signed attestation document from an Amazon Web Services Nitro enclave
and the encryption algorithm to use with the enclave's public key. The only valid
encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation
documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon
Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. When you use this
parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key
under the public key in the attestation document, and returns the resulting ciphertext in
the CiphertextForRecipient field in the response. This ciphertext can be decrypted only
with the private key in the enclave. The CiphertextBlob field in the response contains a
copy of the data key encrypted under the KMS key specified by the KeyId parameter. The
Plaintext field in the response is null or empty. For information about the interaction
between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro
Enclaves uses KMS in the Key Management Service Developer Guide.
"""
function generate_data_key(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"GenerateDataKey",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_data_key(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateDataKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_data_key_pair(key_id, key_pair_spec)
generate_data_key_pair(key_id, key_pair_spec, params::Dict{String,<:Any})
Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a
plaintext public key, a plaintext private key, and a copy of the private key that is
encrypted under the symmetric encryption KMS key you specify. You can use the data key pair
to perform asymmetric cryptography and implement digital signatures outside of KMS. The
bytes in the keys are random; they are not related to the caller or to the KMS key that is
used to encrypt the private key. You can use the public key that GenerateDataKeyPair
returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted
private key with the data. When you are ready to decrypt data or sign a message, you can
use the Decrypt operation to decrypt the encrypted private key. To generate a data key
pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data
key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get
the type and origin of your KMS key, use the DescribeKey operation. Use the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can
also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing,
and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS
cannot enforce any restrictions on the use of data key pairs outside of KMS. If you are
using the data key pair to encrypt data, or for any operation where you don't immediately
need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.
GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private
key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a
message. Later, when you need to decrypt the data or sign a message, use the Decrypt
operation to decrypt the encrypted private key in the data key pair. GenerateDataKeyPair
returns a unique data key pair for each request. The bytes in the keys are random; they are
not related to the caller or the KMS key that is used to encrypt the private key. The
public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The
private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.
GenerateDataKeyPair also supports Amazon Web Services Nitro Enclaves, which provide an
isolated compute environment in Amazon EC2. To call GenerateDataKeyPair for an Amazon Web
Services Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web
Services SDK. Use the Recipient parameter to provide the attestation document for the
enclave. GenerateDataKeyPair returns the public data key and a copy of the private data key
encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the
private data key (PrivateKeyPlaintext), the response includes a copy of the private data
key encrypted under the public key from the attestation document (CiphertextForRecipient).
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves,
see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer
Guide.. You can use an optional encryption context to add additional security to the
encryption operation. If you specify an EncryptionContext, you must specify the same
encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more
information, see Encryption Context in the Key Management Service Developer Guide. The KMS
key that you use for this operation must be in a compatible key state. For details, see Key
states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes.
To perform this operation with a KMS key in a different Amazon Web Services account,
specify the key ARN or alias ARN in the value of the KeyId parameter. Required
permissions: kms:GenerateDataKeyPair (key policy) Related operations: Decrypt
Encrypt GenerateDataKey GenerateDataKeyPairWithoutPlaintext
GenerateDataKeyWithoutPlaintext Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Specifies the symmetric encryption KMS key that encrypts the private key in the
data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store.
To get the type and origin of your KMS key, use the DescribeKey operation. To specify a KMS
key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it
with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must
use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for
a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use
ListAliases.
- `key_pair_spec`: Determines the type of data key pair that is generated. The KMS rule
that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign
and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign
and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key
spec is only available in China Regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"EncryptionContext"`: Specifies the encryption context that will be used when encrypting
the private key in the data key pair. Do not include confidential or sensitive information
in this field. This field may be displayed in plaintext in CloudTrail logs and other
output. An encryption context is a collection of non-secret key-value pairs that represent
additional authenticated data. When you use an encryption context to encrypt data, you must
specify the same (an exact case-sensitive match) encryption context to decrypt the data. An
encryption context is supported only on operations with symmetric encryption KMS keys. On
operations with symmetric encryption KMS keys, an encryption context is optional, but it is
strongly recommended. For more information, see Encryption context in the Key Management
Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"Recipient"`: A signed attestation document from an Amazon Web Services Nitro enclave
and the encryption algorithm to use with the enclave's public key. The only valid
encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation
documents for Amazon Web Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon
Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the
attestation document and then use the Recipient parameter from any Amazon Web Services SDK
to provide the attestation document for the enclave. When you use this parameter, instead
of returning a plaintext copy of the private data key, KMS encrypts the plaintext private
data key under the public key in the attestation document, and returns the resulting
ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be
decrypted only with the private key in the enclave. The CiphertextBlob field in the
response contains a copy of the private data key encrypted under the KMS key specified by
the KeyId parameter. The PrivateKeyPlaintext field in the response is null or empty. For
information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see
How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer
Guide.
"""
function generate_data_key_pair(
KeyId, KeyPairSpec; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateDataKeyPair",
Dict{String,Any}("KeyId" => KeyId, "KeyPairSpec" => KeyPairSpec);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_data_key_pair(
KeyId,
KeyPairSpec,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"GenerateDataKeyPair",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("KeyId" => KeyId, "KeyPairSpec" => KeyPairSpec),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_data_key_pair_without_plaintext(key_id, key_pair_spec)
generate_data_key_pair_without_plaintext(key_id, key_pair_spec, params::Dict{String,<:Any})
Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a
plaintext public key and a copy of the private key that is encrypted under the symmetric
encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation does not return
a plaintext private key. The bytes in the keys are random; they are not related to the
caller or to the KMS key that is used to encrypt the private key. You can use the public
key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature
outside of KMS. Then, store the encrypted private key with the data. When you are ready to
decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted
private key. To generate a data key pair, you must specify a symmetric encryption KMS key
to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a
KMS key in a custom key store. To get the type and origin of your KMS key, use the
DescribeKey operation. Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve
(ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS
recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either
encryption or signing, but not both. However, KMS cannot enforce any restrictions on the
use of data key pairs outside of KMS. GenerateDataKeyPairWithoutPlaintext returns a unique
data key pair for each request. The bytes in the key are not related to the caller or KMS
key that is used to encrypt the private key. The public key is a DER-encoded X.509
SubjectPublicKeyInfo, as specified in RFC 5280. You can use an optional encryption context
to add additional security to the encryption operation. If you specify an
EncryptionContext, you must specify the same encryption context (a case-sensitive exact
match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with
an InvalidCiphertextException. For more information, see Encryption Context in the Key
Management Service Developer Guide. The KMS key that you use for this operation must be in
a compatible key state. For details, see Key states of KMS keys in the Key Management
Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key
in a different Amazon Web Services account, specify the key ARN or alias ARN in the value
of the KeyId parameter. Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key
policy) Related operations: Decrypt Encrypt GenerateDataKey
GenerateDataKeyPair GenerateDataKeyWithoutPlaintext Eventual consistency: The KMS
API follows an eventual consistency model. For more information, see KMS eventual
consistency.
# Arguments
- `key_id`: Specifies the symmetric encryption KMS key that encrypts the private key in the
data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store.
To get the type and origin of your KMS key, use the DescribeKey operation. To specify a
KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name,
prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account,
you must use the key ARN or alias ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
- `key_pair_spec`: Determines the type of data key pair that is generated. The KMS rule
that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign
and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign
and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key
spec is only available in China Regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"EncryptionContext"`: Specifies the encryption context that will be used when encrypting
the private key in the data key pair. Do not include confidential or sensitive information
in this field. This field may be displayed in plaintext in CloudTrail logs and other
output. An encryption context is a collection of non-secret key-value pairs that represent
additional authenticated data. When you use an encryption context to encrypt data, you must
specify the same (an exact case-sensitive match) encryption context to decrypt the data. An
encryption context is supported only on operations with symmetric encryption KMS keys. On
operations with symmetric encryption KMS keys, an encryption context is optional, but it is
strongly recommended. For more information, see Encryption context in the Key Management
Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
"""
function generate_data_key_pair_without_plaintext(
KeyId, KeyPairSpec; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateDataKeyPairWithoutPlaintext",
Dict{String,Any}("KeyId" => KeyId, "KeyPairSpec" => KeyPairSpec);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_data_key_pair_without_plaintext(
KeyId,
KeyPairSpec,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"GenerateDataKeyPairWithoutPlaintext",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("KeyId" => KeyId, "KeyPairSpec" => KeyPairSpec),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_data_key_without_plaintext(key_id)
generate_data_key_without_plaintext(key_id, params::Dict{String,<:Any})
Returns a unique symmetric data key for use outside of KMS. This operation returns a data
key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in
the key are random; they are not related to the caller or to the KMS key.
GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that
it does not return a plaintext copy of the data key. This operation is useful for systems
that need to encrypt data at some point, but not immediately. When you need to encrypt the
data, you call the Decrypt operation on the encrypted copy of the key. It's also useful in
distributed systems with different levels of trust. For example, you might store encrypted
data in containers. One component of your system creates new containers and stores an
encrypted data key with each container. Then, a different component puts the data into the
containers. That component first decrypts the data key, uses the plaintext data key to
encrypt data, puts the encrypted data into the container, and then destroys the plaintext
data key. In this system, the component that creates the containers never sees the
plaintext data key. To request an asymmetric data key pair, use the GenerateDataKeyPair or
GenerateDataKeyPairWithoutPlaintext operations. To generate a data key, you must specify
the symmetric encryption KMS key that is used to encrypt the data key. You cannot use an
asymmetric KMS key or a key in a custom key store to generate a data key. To get the type
of your KMS key, use the DescribeKey operation. You must also specify the length of the
data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit
and 256-bit data keys, use the KeySpec parameter. To generate an SM4 data key (China
Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 16. The
symmetric encryption key used in China Regions to encrypt your data key is an SM4
encryption key. If the operation succeeds, you will find the encrypted copy of the data key
in the CiphertextBlob field. You can use an optional encryption context to add additional
security to the encryption operation. If you specify an EncryptionContext, you must specify
the same encryption context (a case-sensitive exact match) when decrypting the encrypted
data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For
more information, see Encryption Context in the Key Management Service Developer Guide. The
KMS key that you use for this operation must be in a compatible key state. For details, see
Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use:
Yes. To perform this operation with a KMS key in a different Amazon Web Services account,
specify the key ARN or alias ARN in the value of the KeyId parameter. Required
permissions: kms:GenerateDataKeyWithoutPlaintext (key policy) Related operations:
Decrypt Encrypt GenerateDataKey GenerateDataKeyPair
GenerateDataKeyPairWithoutPlaintext Eventual consistency: The KMS API follows an
eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Specifies the symmetric encryption KMS key that encrypts the data key. You
cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type
and origin of your KMS key, use the DescribeKey operation. To specify a KMS key, use its
key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
\"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use
the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for
a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use
ListAliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"EncryptionContext"`: Specifies the encryption context that will be used when encrypting
the data key. Do not include confidential or sensitive information in this field. This
field may be displayed in plaintext in CloudTrail logs and other output. An encryption
context is a collection of non-secret key-value pairs that represent additional
authenticated data. When you use an encryption context to encrypt data, you must specify
the same (an exact case-sensitive match) encryption context to decrypt the data. An
encryption context is supported only on operations with symmetric encryption KMS keys. On
operations with symmetric encryption KMS keys, an encryption context is optional, but it is
strongly recommended. For more information, see Encryption context in the Key Management
Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"KeySpec"`: The length of the data key. Use AES_128 to generate a 128-bit symmetric key,
or AES_256 to generate a 256-bit symmetric key.
- `"NumberOfBytes"`: The length of the data key in bytes. For example, use the value 64 to
generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and
256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
"""
function generate_data_key_without_plaintext(
KeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateDataKeyWithoutPlaintext",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_data_key_without_plaintext(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateDataKeyWithoutPlaintext",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_mac(key_id, mac_algorithm, message)
generate_mac(key_id, mac_algorithm, message, params::Dict{String,<:Any})
Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS
key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that
KMS uses conform to industry standards defined in RFC 2104. You can use value that
GenerateMac returns in the VerifyMac operation to demonstrate that the original message has
not changed. Also, because a secret key is used to create the hash, you can verify that the
party that generated the hash has the required secret key. You can also use the raw result
to implement HMAC-based algorithms such as key derivation functions. This operation is part
of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management
Service Developer Guide . Best practices recommend that you limit the time during which
any signing mechanism, including an HMAC, is effective. This deters an attack where the
actor uses a signed message to establish validity repeatedly or long after the message is
superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the
token or message to help you detect when its time to refresh the HMAC. The KMS key that
you use for this operation must be in a compatible key state. For details, see Key states
of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To
perform this operation with a KMS key in a different Amazon Web Services account, specify
the key ARN or alias ARN in the value of the KeyId parameter. Required permissions:
kms:GenerateMac (key policy) Related operations: VerifyMac Eventual consistency: The KMS
API follows an eventual consistency model. For more information, see KMS eventual
consistency.
# Arguments
- `key_id`: The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC
for the message and the key as described in RFC 2104. To identify an HMAC KMS key, use the
DescribeKey operation and see the KeySpec field in the response.
- `mac_algorithm`: The MAC algorithm used in the operation. The algorithm must be
compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
DescribeKey response.
- `message`: The message to be hashed. Specify a message of up to 4,096 bytes.
GenerateMac and VerifyMac do not provide special handling for message digests. If you
generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash
digest.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
"""
function generate_mac(
KeyId, MacAlgorithm, Message; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateMac",
Dict{String,Any}(
"KeyId" => KeyId, "MacAlgorithm" => MacAlgorithm, "Message" => Message
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_mac(
KeyId,
MacAlgorithm,
Message,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"GenerateMac",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyId" => KeyId, "MacAlgorithm" => MacAlgorithm, "Message" => Message
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_random()
generate_random(params::Dict{String,<:Any})
Returns a random byte string that is cryptographically secure. You must use the
NumberOfBytes parameter to specify the length of the random byte string. There is no
default value for string length. By default, the random byte string is generated in KMS. To
generate the byte string in the CloudHSM cluster associated with an CloudHSM key store, use
the CustomKeyStoreId parameter. GenerateRandom also supports Amazon Web Services Nitro
Enclaves, which provide an isolated compute environment in Amazon EC2. To call
GenerateRandom for a Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any
Amazon Web Services SDK. Use the Recipient parameter to provide the attestation document
for the enclave. Instead of plaintext bytes, the response includes the plaintext bytes
encrypted under the public key from the attestation document (CiphertextForRecipient).For
information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see
How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer
Guide. For more information about entropy and random number generation, see Key Management
Service Cryptographic Details. Cross-account use: Not applicable. GenerateRandom does not
use any account-specific resources, such as KMS keys. Required permissions:
kms:GenerateRandom (IAM policy) Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomKeyStoreId"`: Generates the random byte string in the CloudHSM cluster that is
associated with the specified CloudHSM key store. To find the ID of a custom key store, use
the DescribeCustomKeyStores operation. External key store IDs are not valid for this
parameter. If you specify the ID of an external key store, GenerateRandom throws an
UnsupportedOperationException.
- `"NumberOfBytes"`: The length of the random byte string. This parameter is required.
- `"Recipient"`: A signed attestation document from an Amazon Web Services Nitro enclave
and the encryption algorithm to use with the enclave's public key. The only valid
encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation
documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon
Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. When you use this
parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the
public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient field in the response. This ciphertext can be decrypted only with
the private key in the enclave. The Plaintext field in the response is null or empty. For
information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see
How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer
Guide.
"""
function generate_random(; aws_config::AbstractAWSConfig=global_aws_config())
return kms("GenerateRandom"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function generate_random(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GenerateRandom", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_key_policy(key_id)
get_key_policy(key_id, params::Dict{String,<:Any})
Gets a key policy attached to the specified KMS key. Cross-account use: No. You cannot
perform this operation on a KMS key in a different Amazon Web Services account. Required
permissions: kms:GetKeyPolicy (key policy) Related operations: PutKeyPolicy Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Arguments
- `key_id`: Gets the key policy for the specified KMS key. Specify the key ID or key ARN of
the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyName"`: Specifies the name of the key policy. If no policy name is specified, the
default value is default. The only valid name is default. To get the names of key policies,
use ListKeyPolicies.
"""
function get_key_policy(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"GetKeyPolicy",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_key_policy(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GetKeyPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_key_rotation_status(key_id)
get_key_rotation_status(key_id, params::Dict{String,<:Any})
Provides detailed information about the rotation status for a KMS key, including whether
automatic rotation of the key material is enabled for the specified KMS key, the rotation
period, and the next scheduled rotation date. Automatic key rotation is supported only on
symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys,
HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To
enable or disable automatic rotation of a set of related multi-Region keys, set the
property on the primary key.. You can enable (EnableKeyRotation) and disable automatic
rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key
material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always
rotates the key material in Amazon Web Services managed KMS keys every year. The key
rotation status for Amazon Web Services managed KMS keys is always true. You can perform
on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys,
regardless of whether or not automatic key rotation is enabled. You can use
GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation
was initiated. You can use ListKeyRotations to view the details of completed rotations. In
May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every
three years to every year. For details, see EnableKeyRotation. The KMS key that you use
for this operation must be in a compatible key state. For details, see Key states of KMS
keys in the Key Management Service Developer Guide. Disabled: The key rotation status
does not change when you disable a KMS key. However, while the KMS key is disabled, KMS
does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the
key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it
immediately, and every year thereafter. If it's been less than a year since the key
material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation
schedule. Pending deletion: While a KMS key is pending deletion, its key rotation status
is false and KMS does not rotate the key material. If you cancel the deletion, the original
key rotation status returns to true. Cross-account use: Yes. To perform this operation
on a KMS key in a different Amazon Web Services account, specify the key ARN in the value
of the KeyId parameter. Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations: DisableKeyRotation EnableKeyRotation ListKeyRotations
RotateKeyOnDemand Eventual consistency: The KMS API follows an eventual consistency
model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Gets the rotation status for the specified KMS key. Specify the key ID or key
ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you
must use the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get
the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function get_key_rotation_status(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"GetKeyRotationStatus",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_key_rotation_status(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GetKeyRotationStatus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parameters_for_import(key_id, wrapping_algorithm, wrapping_key_spec)
get_parameters_for_import(key_id, wrapping_algorithm, wrapping_key_spec, params::Dict{String,<:Any})
Returns the public key and an import token you need to import or reimport key material for
a KMS key. By default, KMS keys are created with key material that KMS generates. This
operation supports Importing key material, an advanced feature that lets you generate and
import the cryptographic key material for a KMS key. For more information about importing
key material into KMS, see Importing key material in the Key Management Service Developer
Guide. Before calling GetParametersForImport, use the CreateKey operation with an Origin
value of EXTERNAL to create a KMS key with no key material. You can import key material for
a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric
signing KMS key. You can also import key material into a multi-Region key of any supported
type. However, you can't import key material into a KMS key in a custom key store. You can
also use GetParametersForImport to get a public key and import token to reimport the
original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material. The
public key (or \"wrapping key\") of an RSA key pair that KMS generates. You will use this
public key to encrypt (\"wrap\") your key material while it's in transit to KMS. A
import token that ensures that KMS can decrypt your key material and associate it with the
correct KMS key. The public key and its import token are permanently linked and must be
used together. Each public key and import token set is valid for 24 hours. The expiration
date and time appear in the ParametersValidTo field in the GetParametersForImport response.
You cannot use an expired public key or import token in an ImportKeyMaterial request. If
your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information: The key ID of the KMS key for
which you are importing the key material. The key spec of the public key (\"wrapping
key\") that you will use to encrypt your key material during import. The wrapping
algorithm that you will use with the public key to encrypt your key material. You can use
the same or a different public key spec and wrapping algorithm each time you import or
reimport the same key material. The KMS key that you use for this operation must be in a
compatible key state. For details, see Key states of KMS keys in the Key Management Service
Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in
a different Amazon Web Services account. Required permissions: kms:GetParametersForImport
(key policy) Related operations: ImportKeyMaterial DeleteImportedKeyMaterial
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `key_id`: The identifier of the KMS key that will be associated with the imported key
material. The Origin of the KMS key must be EXTERNAL. All KMS key types are supported,
including multi-Region keys. However, you cannot import key material into a KMS key in a
custom key store. Specify the key ID or key ARN of the KMS key. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `wrapping_algorithm`: The algorithm you will use with the RSA public key (PublicKey) in
the response to protect your key material during import. For more information, see Select a
wrapping algorithm in the Key Management Service Developer Guide. For RSA_AES wrapping
algorithms, you encrypt your key material with an AES key that you generate, then encrypt
your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt
your key material directly with the RSA public key from KMS. The wrapping algorithms that
you can use depend on the type of key material that you are importing. To import an RSA
private key, you must use an RSA_AES wrapping algorithm. RSA_AES_KEY_WRAP_SHA_256 —
Supported for wrapping RSA and ECC key material. RSA_AES_KEY_WRAP_SHA_1 — Supported
for wrapping RSA and ECC key material. RSAES_OAEP_SHA_256 — Supported for all types of
key material, except RSA key material (private key). You cannot use the RSAES_OAEP_SHA_256
wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material
(private key). You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048
wrapping key spec to wrap ECC_NIST_P521 key material. RSAES_PKCS1_V1_5 (Deprecated) —
As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
- `wrapping_key_spec`: The type of RSA public key to return in the response. You will use
this wrapping key with the specified wrapping algorithm to protect your key material during
import. Use the longest RSA wrapping key that is practical. You cannot use an RSA_2048
public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping
algorithm or choose a longer RSA public key.
"""
function get_parameters_for_import(
KeyId,
WrappingAlgorithm,
WrappingKeySpec;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"GetParametersForImport",
Dict{String,Any}(
"KeyId" => KeyId,
"WrappingAlgorithm" => WrappingAlgorithm,
"WrappingKeySpec" => WrappingKeySpec,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameters_for_import(
KeyId,
WrappingAlgorithm,
WrappingKeySpec,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"GetParametersForImport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyId" => KeyId,
"WrappingAlgorithm" => WrappingAlgorithm,
"WrappingKeySpec" => WrappingKeySpec,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_public_key(key_id)
get_public_key(key_id, params::Dict{String,<:Any})
Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS
key, which never leaves KMS unencrypted, callers with kms:GetPublicKey permission can
download the public key of an asymmetric KMS key. You can share the public key to allow
others to encrypt messages and verify signatures outside of KMS. For information about
asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
You do not need to download the public key. Instead, you can use the public key within KMS
by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an
asymmetric KMS key. When you use the public key within KMS, you benefit from the
authentication, authorization, and logging that are part of every KMS operation. You also
reduce of risk of encrypting data that cannot be decrypted. These features are not
effective outside of KMS. To help you use the public key safely outside of KMS,
GetPublicKey returns important information about the public key in the response, including:
KeySpec: The type of key material in the public key, such as RSA_4096 or ECC_NIST_P521.
KeyUsage: Whether the key is used for encryption, signing, or deriving a shared secret.
EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the
signing algorithms for the key. Although KMS cannot enforce these restrictions on
external operations, it is crucial that you use this information to prevent the public key
from being used improperly. For example, you can prevent a public signing key from being
used encrypt data, or prevent a public key from being used with an encryption algorithm
that is not supported by KMS. You can also avoid errors, such as using the wrong signing
algorithm in a verification operation. To verify a signature outside of KMS with an SM2
public key (China Regions only), you must specify the distinguishing ID. By default, KMS
uses 1234567812345678 as the distinguishing ID. For more information, see Offline
verification with SM2 key pairs. The KMS key that you use for this operation must be in a
compatible key state. For details, see Key states of KMS keys in the Key Management Service
Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a
different Amazon Web Services account, specify the key ARN or alias ARN in the value of the
KeyId parameter. Required permissions: kms:GetPublicKey (key policy) Related operations:
CreateKey Eventual consistency: The KMS API follows an eventual consistency model. For
more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the asymmetric KMS key that includes the public key. To specify a
KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name,
prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account,
you must use the key ARN or alias ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
"""
function get_public_key(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"GetPublicKey",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_public_key(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"GetPublicKey",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_key_material(encrypted_key_material, import_token, key_id)
import_key_material(encrypted_key_material, import_token, key_id, params::Dict{String,<:Any})
Imports or reimports key material into an existing KMS key that was created without key
material. ImportKeyMaterial also sets the expiration model and expiration date of the
imported key material. By default, KMS keys are created with key material that KMS
generates. This operation supports Importing key material, an advanced feature that lets
you generate and import the cryptographic key material for a KMS key. For more information
about importing key material into KMS, see Importing key material in the Key Management
Service Developer Guide. After you successfully import key material into a KMS key, you can
reimport the same key material into that KMS key, but you cannot import different key
material. You might reimport key material to replace key material that expired or key
material that you deleted. You might also reimport key material to change the expiration
model or expiration date of the key material. Each time you import key material into KMS,
you can determine whether (ExpirationModel) and when (ValidTo) the key material expires. To
change the expiration of your key material, you must import it again, either by calling
ImportKeyMaterial or using the import features of the KMS console. Before calling
ImportKeyMaterial: Create or identify a KMS key with no key material. The KMS key must
have an Origin value of EXTERNAL, which indicates that the KMS key is designed for imported
key material. To create an new KMS key for imported key material, call the CreateKey
operation with an Origin value of EXTERNAL. You can create a symmetric encryption KMS key,
HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also
import key material into a multi-Region key of any supported type. However, you can't
import key material into a KMS key in a custom key store. Use the DescribeKey operation
to verify that the KeyState of the KMS key is PendingImport, which indicates that the KMS
key has no key material. If you are reimporting the same key material into an existing KMS
key, you might need to call the DeleteImportedKeyMaterial to delete its existing key
material. Call the GetParametersForImport operation to get a public key and import token
set for importing key material. Use the public key in the GetParametersForImport
response to encrypt your key material. Then, in an ImportKeyMaterial request, you submit
your encrypted key material and import token. When calling this operation, you must specify
the following values: The key ID or key ARN of the KMS key to associate with the imported
key material. Its Origin must be EXTERNAL and its KeyState must be PendingImport. You
cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a
different Amazon Web Services account. To get the Origin and KeyState of a KMS key, call
DescribeKey. The encrypted key material. The import token that GetParametersForImport
returned. You must use a public key and token from the same GetParametersForImport
response. Whether the key material expires (ExpirationModel) and, if so, when (ValidTo).
For help with this choice, see Setting an expiration time in the Key Management Service
Developer Guide. If you set an expiration date, KMS deletes the key material from the KMS
key on the specified date, making the KMS key unusable. To use the KMS key in cryptographic
operations again, you must reimport the same key material. However, you can delete and
reimport the key material at any time, including before the key material expires. Each time
you reimport, you can eliminate or reset the expiration time. When this operation is
successful, the key state of the KMS key changes from PendingImport to Enabled, and you can
use the KMS key in cryptographic operations. If this operation fails, use the exception to
help determine the problem. If the error is related to the key material, the import token,
or wrapping key, use GetParametersForImport to get a new public key and import token for
the KMS key and repeat the import procedure. For help, see How To Import Key Material in
the Key Management Service Developer Guide. The KMS key that you use for this operation
must be in a compatible key state. For details, see Key states of KMS keys in the Key
Management Service Developer Guide. Cross-account use: No. You cannot perform this
operation on a KMS key in a different Amazon Web Services account. Required permissions:
kms:ImportKeyMaterial (key policy) Related operations: DeleteImportedKeyMaterial
GetParametersForImport Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `encrypted_key_material`: The encrypted key material to import. The key material must be
encrypted under the public wrapping key that GetParametersForImport returned, using the
wrapping algorithm that you specified in the same GetParametersForImport request.
- `import_token`: The import token that you received in the response to a previous
GetParametersForImport request. It must be from the same response that contained the public
key that you used to encrypt the key material.
- `key_id`: The identifier of the KMS key that will be associated with the imported key
material. This must be the same KMS key specified in the KeyID parameter of the
corresponding GetParametersForImport request. The Origin of the KMS key must be EXTERNAL
and its KeyState must be PendingImport. The KMS key can be a symmetric encryption KMS key,
HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a
multi-Region key of any supported type. You cannot perform this operation on a KMS key in a
custom key store, or on a KMS key in a different Amazon Web Services account. Specify the
key ID or key ARN of the KMS key. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpirationModel"`: Specifies whether the key material expires. The default is
KEY_MATERIAL_EXPIRES. For help with this choice, see Setting an expiration time in the Key
Management Service Developer Guide. When the value of ExpirationModel is
KEY_MATERIAL_EXPIRES, you must specify a value for the ValidTo parameter. When value is
KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter. You cannot change the
ExpirationModel or ValidTo values for the current import after the request completes. To
change either value, you must reimport the key material.
- `"ValidTo"`: The date and time when the imported key material expires. This parameter is
required when the value of the ExpirationModel parameter is KEY_MATERIAL_EXPIRES. Otherwise
it is not valid. The value of this parameter must be a future date and time. The maximum
value is 365 days from the request date. When the key material expires, KMS deletes the key
material from the KMS key. Without its key material, the KMS key is unusable. To use the
KMS key in cryptographic operations, you must reimport the same key material. You cannot
change the ExpirationModel or ValidTo values for the current import after the request
completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport
the key material.
"""
function import_key_material(
EncryptedKeyMaterial,
ImportToken,
KeyId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"ImportKeyMaterial",
Dict{String,Any}(
"EncryptedKeyMaterial" => EncryptedKeyMaterial,
"ImportToken" => ImportToken,
"KeyId" => KeyId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_key_material(
EncryptedKeyMaterial,
ImportToken,
KeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"ImportKeyMaterial",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EncryptedKeyMaterial" => EncryptedKeyMaterial,
"ImportToken" => ImportToken,
"KeyId" => KeyId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_aliases()
list_aliases(params::Dict{String,<:Any})
Gets a list of aliases in the caller's Amazon Web Services account and region. For more
information about aliases, see CreateAlias. By default, the ListAliases operation returns
all aliases in the account and region. To get only the aliases associated with a particular
KMS key, use the KeyId parameter. The ListAliases response can include aliases that you
created and associated with your customer managed keys, and aliases that Amazon Web
Services created and associated with Amazon Web Services managed keys in your account. You
can recognize Amazon Web Services aliases because their names have the format
aws/<service-name>, such as aws/dynamodb. The response might also include aliases
that have no TargetKeyId field. These are predefined aliases that Amazon Web Services has
created but has not yet associated with a KMS key. Aliases that Amazon Web Services creates
in your account, including predefined aliases, do not count against your KMS aliases quota.
Cross-account use: No. ListAliases does not return aliases in other Amazon Web Services
accounts. Required permissions: kms:ListAliases (IAM policy) For details, see Controlling
access to aliases in the Key Management Service Developer Guide. Related operations:
CreateAlias DeleteAlias UpdateAlias Eventual consistency: The KMS API follows
an eventual consistency model. For more information, see KMS eventual consistency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeyId"`: Lists only aliases that are associated with the specified KMS key. Enter a KMS
key in your Amazon Web Services account. This parameter is optional. If you omit it,
ListAliases returns all aliases in the account and Region. Specify the key ID or key ARN of
the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and 100,
inclusive. If you do not include a value, it defaults to 50.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function list_aliases(; aws_config::AbstractAWSConfig=global_aws_config())
return kms("ListAliases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_aliases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ListAliases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_grants(key_id)
list_grants(key_id, params::Dict{String,<:Any})
Gets a list of all grants for the specified KMS key. You must specify the KMS key in all
requests. You can filter the grant list by grant ID or grantee principal. For detailed
information about grants, including grant terminology, see Grants in KMS in the Key
Management Service Developer Guide . For examples of working with grants in several
programming languages, see Programming grants. The GranteePrincipal field in the
ListGrants response usually contains the user or role designated as the grantee principal
in the grant. However, when the grantee principal in the grant is an Amazon Web Services
service, the GranteePrincipal field contains the service principal, which might represent
several different grantee principals. Cross-account use: Yes. To perform this operation
on a KMS key in a different Amazon Web Services account, specify the key ARN in the value
of the KeyId parameter. Required permissions: kms:ListGrants (key policy) Related
operations: CreateGrant ListRetirableGrants RetireGrant RevokeGrant
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `key_id`: Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon
Web Services account, you must use the key ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantId"`: Returns only the grant with the specified grant ID. The grant ID uniquely
identifies the grant.
- `"GranteePrincipal"`: Returns only grants where the specified principal is the grantee
principal for the grant.
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and 100,
inclusive. If you do not include a value, it defaults to 50.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function list_grants(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"ListGrants",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_grants(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ListGrants",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_key_policies(key_id)
list_key_policies(key_id, params::Dict{String,<:Any})
Gets the names of the key policies that are attached to a KMS key. This operation is
designed to get policy names that you can use in a GetKeyPolicy operation. However, the
only valid policy name is default. Cross-account use: No. You cannot perform this
operation on a KMS key in a different Amazon Web Services account. Required permissions:
kms:ListKeyPolicies (key policy) Related operations: GetKeyPolicy PutKeyPolicy
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `key_id`: Gets the names of key policies for the specified KMS key. Specify the key ID or
key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get
the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and
1000, inclusive. If you do not include a value, it defaults to 100. Only one policy can be
attached to a key.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function list_key_policies(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"ListKeyPolicies",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_key_policies(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ListKeyPolicies",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_key_rotations(key_id)
list_key_rotations(key_id, params::Dict{String,<:Any})
Returns information about all completed key material rotations for the specified KMS key.
You must specify the KMS key in all requests. You can refine the key rotations list by
limiting the number of rotations returned. For detailed information about automatic and
on-demand key rotations, see Rotating KMS keys in the Key Management Service Developer
Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a
different Amazon Web Services account. Required permissions: kms:ListKeyRotations (key
policy) Related operations: EnableKeyRotation DisableKeyRotation
GetKeyRotationStatus RotateKeyOnDemand Eventual consistency: The KMS API follows an
eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Gets the key rotations for the specified KMS key. Specify the key ID or key ARN
of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and
1000, inclusive. If you do not include a value, it defaults to 100.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function list_key_rotations(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"ListKeyRotations",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_key_rotations(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ListKeyRotations",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_keys()
list_keys(params::Dict{String,<:Any})
Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon
Web Services account. Required permissions: kms:ListKeys (IAM policy) Related operations:
CreateKey DescribeKey ListAliases ListResourceTags Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and
1000, inclusive. If you do not include a value, it defaults to 100.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function list_keys(; aws_config::AbstractAWSConfig=global_aws_config())
return kms("ListKeys"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_keys(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms("ListKeys", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_resource_tags(key_id)
list_resource_tags(key_id, params::Dict{String,<:Any})
Returns all tags on the specified KMS key. For general information about tags, including
the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services
General Reference. For information about using tags in KMS, see Tagging keys.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon
Web Services account. Required permissions: kms:ListResourceTags (key policy) Related
operations: CreateKey ReplicateKey TagResource UntagResource Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Arguments
- `key_id`: Gets tags on the specified KMS key. Specify the key ID or key ARN of the KMS
key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and 50,
inclusive. If you do not include a value, it defaults to 50.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received. Do not attempt to construct this value. Use only the value of NextMarker from the
truncated response you just received.
"""
function list_resource_tags(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"ListResourceTags",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_tags(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ListResourceTags",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_retirable_grants(retiring_principal)
list_retirable_grants(retiring_principal, params::Dict{String,<:Any})
Returns information about all grants in the Amazon Web Services account and Region that
have the specified retiring principal. You can specify any principal in your Amazon Web
Services account. The grants that are returned include grants for KMS keys in your Amazon
Web Services account and other Amazon Web Services accounts. You might use this operation
to determine which grants you may retire. To retire a grant, use the RetireGrant operation.
For detailed information about grants, including grant terminology, see Grants in KMS in
the Key Management Service Developer Guide . For examples of working with grants in
several programming languages, see Programming grants. Cross-account use: You must
specify a principal in your Amazon Web Services account. This operation returns a list of
grants where the retiring principal specified in the ListRetirableGrants request is the
same retiring principal on the grant. This can include grants on KMS keys owned by other
Amazon Web Services accounts, but you do not need kms:ListRetirableGrants permission (or
any other additional permission) in any Amazon Web Services account other than your own.
Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services
account. KMS authorizes ListRetirableGrants requests by evaluating the caller account's
kms:ListRetirableGrants permissions. The authorized resource in ListRetirableGrants calls
is the retiring principal specified in the request. KMS does not evaluate the caller's
permissions to verify their access to any KMS keys or grants that might be returned by the
ListRetirableGrants call. Related operations: CreateGrant ListGrants
RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `retiring_principal`: The retiring principal for which to list grants. Enter a principal
in your Amazon Web Services account. To specify the retiring principal, use the Amazon
Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon
Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For
help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access
Management User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Use this parameter to specify the maximum number of items to return. When this
value is present, KMS does not return more than the specified number of items, but it might
return fewer. This value is optional. If you include a value, it must be between 1 and 100,
inclusive. If you do not include a value, it defaults to 50.
- `"Marker"`: Use this parameter in a subsequent request after you receive a response with
truncated results. Set it to the value of NextMarker from the truncated response you just
received.
"""
function list_retirable_grants(
RetiringPrincipal; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ListRetirableGrants",
Dict{String,Any}("RetiringPrincipal" => RetiringPrincipal);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_retirable_grants(
RetiringPrincipal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"ListRetirableGrants",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RetiringPrincipal" => RetiringPrincipal), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_key_policy(key_id, policy)
put_key_policy(key_id, policy, params::Dict{String,<:Any})
Attaches a key policy to the specified KMS key. For more information about key policies,
see Key Policies in the Key Management Service Developer Guide. For help writing and
formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and
Access Management User Guide . For examples of adding a key policy in multiple programming
languages, see Setting a key policy in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon
Web Services account. Required permissions: kms:PutKeyPolicy (key policy) Related
operations: GetKeyPolicy Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Sets the key policy on the specified KMS key. Specify the key ID or key ARN of
the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `policy`: The key policy to attach to the KMS key. The key policy must meet the following
criteria: The key policy must allow the calling principal to make a subsequent
PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes
unmanageable. For more information, see Default key policy in the Key Management Service
Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the
key policy must exist and be visible to KMS. When you create a new Amazon Web Services
principal, you might need to enforce a delay before including the new principal in a key
policy because the new principal might not be immediately visible to KMS. For more
information, see Changes that I make are not always immediately visible in the Amazon Web
Services Identity and Access Management User Guide. A key policy document can include
only the following characters: Printable ASCII characters from the space character
(u0020) through the end of the ASCII character range. Printable characters in the Basic
Latin and Latin-1 Supplement character set (through u00FF). The tab (u0009), line feed
(u000A), and carriage return (u000D) special characters For information about key
policies, see Key policies in KMS in the Key Management Service Developer Guide.For help
writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the
Identity and Access Management User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassPolicyLockoutSafetyCheck"`: Skips (\"bypasses\") the key policy lockout safety
check. The default value is false. Setting this value to true increases the risk that the
KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more
information, see Default key policy in the Key Management Service Developer Guide. Use
this parameter only when you intend to prevent the principal that is making the request
from making a subsequent PutKeyPolicy request on the KMS key.
- `"PolicyName"`: The name of the key policy. If no policy name is specified, the default
value is default. The only valid value is default.
"""
function put_key_policy(KeyId, Policy; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"PutKeyPolicy",
Dict{String,Any}("KeyId" => KeyId, "Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_key_policy(
KeyId,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"PutKeyPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("KeyId" => KeyId, "Policy" => Policy), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
re_encrypt(ciphertext_blob, destination_key_id)
re_encrypt(ciphertext_blob, destination_key_id, params::Dict{String,<:Any})
Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation
to change the KMS key under which data is encrypted, such as when you manually rotate a KMS
key or change the KMS key that protects a ciphertext. You can also use it to reencrypt
ciphertext under the same KMS key, such as to change the encryption context of a
ciphertext. The ReEncrypt operation can decrypt ciphertext that was encrypted by using a
KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt
ciphertext that was encrypted by using the public key of an asymmetric KMS key outside of
KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon
Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a
ciphertext format that is incompatible with KMS. When you use the ReEncrypt operation, you
need to provide information for the decrypt operation and the subsequent encrypt operation.
If your ciphertext was encrypted under an asymmetric KMS key, you must use the
SourceKeyId parameter to identify the KMS key that encrypted the ciphertext. You must also
supply the encryption algorithm that was used. This information is required to decrypt the
data. If your ciphertext was encrypted under a symmetric encryption KMS key, the
SourceKeyId parameter is optional. KMS can get this information from metadata that it adds
to the symmetric ciphertext blob. This feature adds durability to your implementation by
ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even
if they've lost track of the key ID. However, specifying the source KMS key is always
recommended as a best practice. When you use the SourceKeyId parameter to specify a KMS
key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a
different KMS key, the ReEncrypt operation fails. This practice ensures that you use the
KMS key that you intend. To reencrypt the data, you must use the DestinationKeyId
parameter to specify the KMS key that re-encrypts the data after it is decrypted. If the
destination KMS key is an asymmetric KMS key, you must also provide the encryption
algorithm. The algorithm that you choose must be compatible with the KMS key. When you use
an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and
encryption algorithm that you choose. You will be required to provide the same KMS key and
encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match
the values used to encrypt the data, the decrypt operation fails. You are not required to
supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS
keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata
in ciphertext generated with asymmetric keys. The standard format for asymmetric key
ciphertext does not include configurable fields. The KMS key that you use for this
operation must be in a compatible key state. For details, see Key states of KMS keys in the
Key Management Service Developer Guide. Cross-account use: Yes. The source KMS key and
destination KMS key can be in different Amazon Web Services accounts. Either or both KMS
keys can be in a different account than the caller. To specify a KMS key in a different
account, you must use its key ARN or alias ARN. Required permissions: kms:ReEncryptFrom
permission on the source KMS key (key policy) kms:ReEncryptTo permission on the
destination KMS key (key policy) To permit reencryption from or to a KMS key, include the
\"kms:ReEncrypt*\" permission in your key policy. This permission is automatically included
in the key policy when you use the console to create a KMS key. But you must include it
manually when you create a KMS key programmatically or when you use the PutKeyPolicy
operation to set a key policy. Related operations: Decrypt Encrypt
GenerateDataKey GenerateDataKeyPair Eventual consistency: The KMS API follows an
eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `ciphertext_blob`: Ciphertext of the data to reencrypt.
- `destination_key_id`: A unique identifier for the KMS key that is used to reencrypt the
data. Specify a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value
of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an
alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web
Services account, you must use the key ARN or alias ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationEncryptionAlgorithm"`: Specifies the encryption algorithm that KMS will use
to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT,
represents the encryption algorithm used for symmetric encryption KMS keys. This parameter
is required only when the destination KMS key is an asymmetric KMS key.
- `"DestinationEncryptionContext"`: Specifies that encryption context to use when the
reencrypting the data. Do not include confidential or sensitive information in this field.
This field may be displayed in plaintext in CloudTrail logs and other output. A
destination encryption context is valid only when the destination KMS key is a symmetric
encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include
fields for metadata. An encryption context is a collection of non-secret key-value pairs
that represent additional authenticated data. When you use an encryption context to encrypt
data, you must specify the same (an exact case-sensitive match) encryption context to
decrypt the data. An encryption context is supported only on operations with symmetric
encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption
context is optional, but it is strongly recommended. For more information, see Encryption
context in the Key Management Service Developer Guide.
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"SourceEncryptionAlgorithm"`: Specifies the encryption algorithm that KMS will use to
decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT,
represents the algorithm used for symmetric encryption KMS keys. Specify the same algorithm
that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt
attempt fails. This parameter is required only when the ciphertext was encrypted under an
asymmetric KMS key.
- `"SourceEncryptionContext"`: Specifies the encryption context to use to decrypt the
ciphertext. Enter the same encryption context that was used to encrypt the ciphertext. An
encryption context is a collection of non-secret key-value pairs that represent additional
authenticated data. When you use an encryption context to encrypt data, you must specify
the same (an exact case-sensitive match) encryption context to decrypt the data. An
encryption context is supported only on operations with symmetric encryption KMS keys. On
operations with symmetric encryption KMS keys, an encryption context is optional, but it is
strongly recommended. For more information, see Encryption context in the Key Management
Service Developer Guide.
- `"SourceKeyId"`: Specifies the KMS key that KMS will use to decrypt the ciphertext before
it is re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.
If you identify a different KMS key, the ReEncrypt operation throws an
IncorrectKeyException. This parameter is required only when the ciphertext was encrypted
under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the
KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always
recommended as a best practice. This practice ensures that you use the KMS key that you
intend. To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using
an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web
Services account, you must use the key ARN or alias ARN. For example: Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
"""
function re_encrypt(
CiphertextBlob, DestinationKeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ReEncrypt",
Dict{String,Any}(
"CiphertextBlob" => CiphertextBlob, "DestinationKeyId" => DestinationKeyId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function re_encrypt(
CiphertextBlob,
DestinationKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"ReEncrypt",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CiphertextBlob" => CiphertextBlob,
"DestinationKeyId" => DestinationKeyId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replicate_key(key_id, replica_region)
replicate_key(key_id, replica_region, params::Dict{String,<:Any})
Replicates a multi-Region key into the specified Region. This operation creates a
multi-Region replica key based on a multi-Region primary key in a different Region of the
same Amazon Web Services partition. You can create multiple replicas of a primary key, but
each must be in a different Region. To create a multi-Region primary key, use the CreateKey
operation. This operation supports multi-Region keys, an KMS feature that lets you create
multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS
keys have the same key ID, key material, and other metadata, you can use them
interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a
different Amazon Web Services Region without re-encrypting the data or making a
cross-Region call. For more information about multi-Region keys, see Multi-Region keys in
KMS in the Key Management Service Developer Guide. A replica key is a fully-functional KMS
key that can be used independently of its primary and peer replica keys. A primary key and
its replica keys share properties that make them interoperable. They have the same key ID
and key material. They also have the same key spec, key usage, key material origin, and
automatic key rotation status. KMS automatically synchronizes these shared properties among
related multi-Region keys. All other properties of a replica key can differ, including its
key policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys
apply to each primary key and replica key. When this operation completes, the new replica
key has a transient key state of Creating. This key state changes to Enabled (or
PendingImport) after a few seconds when the process of creating the new replica key is
complete. While the key state is Creating, you can manage key, but you cannot yet use it in
cryptographic operations. If you are creating and using the replica key programmatically,
retry on KMSInvalidStateException or call DescribeKey to check its KeyState value before
using it. For details about the Creating key state, see Key states of KMS keys in the Key
Management Service Developer Guide. You cannot create more than one replica of a primary
key in any Region. If the Region already includes a replica of the key you're trying to
replicate, ReplicateKey returns an AlreadyExistsException error. If the key state of the
existing replica is PendingDeletion, you can cancel the scheduled key deletion
(CancelKeyDeletion) or wait for the key to be deleted. The new replica key you create will
have the same shared properties as the original replica key. The CloudTrail log of a
ReplicateKey operation records a ReplicateKey operation in the primary key's Region and a
CreateKey operation in the replica key's Region. If you replicate a multi-Region primary
key with imported key material, the replica key is created with no key material. You must
import the same key material that you imported into the primary key. For details, see
Importing key material into multi-Region keys in the Key Management Service Developer
Guide. To convert a replica key to a primary key, use the UpdatePrimaryRegion operation.
ReplicateKey uses different default values for the KeyPolicy and Tags parameters than those
used in the KMS console. For details, see the parameter descriptions. Cross-account use:
No. You cannot use this operation to create a replica key in a different Amazon Web
Services account. Required permissions: kms:ReplicateKey on the primary key (in the
primary key's Region). Include this permission in the primary key's key policy.
kms:CreateKey in an IAM policy in the replica Region. To use the Tags parameter,
kms:TagResource in an IAM policy in the replica Region. Related operations CreateKey
UpdatePrimaryRegion Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the multi-Region primary key that is being replicated. To determine
whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the
value of the MultiRegionKeyType property. Specify the key ID or key ARN of a multi-Region
primary key. For example: Key ID: mrk-1234abcd12ab34cd56ef1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `replica_region`: The Region ID of the Amazon Web Services Region for this replica key.
Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services
Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services
General Reference. HMAC KMS keys are not supported in all Amazon Web Services Regions. If
you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys
are not supported, the ReplicateKey operation returns an UnsupportedOperationException. For
a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key
Management Service Developer Guide. The replica must be in a different Amazon Web Services
Region than its primary key and other replicas of that primary key, but in the same Amazon
Web Services partition. KMS must be available in the replica Region. If the Region is not
enabled by default, the Amazon Web Services account must be enabled in the Region. For
information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference. For information about enabling and disabling
Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General
Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassPolicyLockoutSafetyCheck"`: Skips (\"bypasses\") the key policy lockout safety
check. The default value is false. Setting this value to true increases the risk that the
KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more
information, see Default key policy in the Key Management Service Developer Guide. Use
this parameter only when you intend to prevent the principal that is making the request
from making a subsequent PutKeyPolicy request on the KMS key.
- `"Description"`: A description of the KMS key. The default value is an empty string (no
description). Do not include confidential or sensitive information in this field. This
field may be displayed in plaintext in CloudTrail logs and other output. The description
is not a shared property of multi-Region keys. You can specify the same description or a
different description for each key in a set of related multi-Region keys. KMS does not
synchronize this property.
- `"Policy"`: The key policy to attach to the KMS key. This parameter is optional. If you
do not provide a key policy, KMS attaches the default key policy to the KMS key. The key
policy is not a shared property of multi-Region keys. You can specify the same key policy
or a different key policy for each key in a set of related multi-Region keys. KMS does not
synchronize this property. If you provide a key policy, it must meet the following
criteria: The key policy must allow the calling principal to make a subsequent
PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes
unmanageable. For more information, see Default key policy in the Key Management Service
Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the
key policy must exist and be visible to KMS. When you create a new Amazon Web Services
principal, you might need to enforce a delay before including the new principal in a key
policy because the new principal might not be immediately visible to KMS. For more
information, see Changes that I make are not always immediately visible in the Amazon Web
Services Identity and Access Management User Guide. A key policy document can include
only the following characters: Printable ASCII characters from the space character
(u0020) through the end of the ASCII character range. Printable characters in the Basic
Latin and Latin-1 Supplement character set (through u00FF). The tab (u0009), line feed
(u000A), and carriage return (u000D) special characters For information about key
policies, see Key policies in KMS in the Key Management Service Developer Guide. For help
writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the
Identity and Access Management User Guide .
- `"Tags"`: Assigns one or more tags to the replica key. Use this parameter to tag the KMS
key when it is created. To tag an existing KMS key, use the TagResource operation. Do not
include confidential or sensitive information in this field. This field may be displayed in
plaintext in CloudTrail logs and other output. Tagging or untagging a KMS key can allow
or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
Service Developer Guide. To use this parameter, you must have kms:TagResource permission
in an IAM policy. Tags are not a shared property of multi-Region keys. You can specify the
same tags or different tags for each key in a set of related multi-Region keys. KMS does
not synchronize this property. Each tag consists of a tag key and a tag value. Both the tag
key and the tag value are required, but the tag value can be an empty (null) string. You
cannot have more than one tag on a KMS key with the same tag key. If you specify an
existing tag key with a different tag value, KMS replaces the current tag value with the
specified one. When you add tags to an Amazon Web Services resource, Amazon Web Services
generates a cost allocation report with usage and costs aggregated by tags. Tags can also
be used to control access to a KMS key. For details, see Tagging Keys.
"""
function replicate_key(
KeyId, ReplicaRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ReplicateKey",
Dict{String,Any}("KeyId" => KeyId, "ReplicaRegion" => ReplicaRegion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replicate_key(
KeyId,
ReplicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"ReplicateKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("KeyId" => KeyId, "ReplicaRegion" => ReplicaRegion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retire_grant()
retire_grant(params::Dict{String,<:Any})
Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
identify the grant to retire, use a grant token, or both the grant ID and a key identifier
(key ID or key ARN) of the KMS key. The CreateGrant operation returns both values. This
operation can be called by the retiring principal for a grant, by the grantee principal if
the grant allows the RetireGrant operation, and by the Amazon Web Services account in which
the grant is created. It can also be called by principals to whom permission for retiring a
grant is delegated. For details, see Retiring and revoking grants in the Key Management
Service Developer Guide. For detailed information about grants, including grant
terminology, see Grants in KMS in the Key Management Service Developer Guide . For
examples of working with grants in several programming languages, see Programming grants.
Cross-account use: Yes. You can retire a grant on a KMS key in a different Amazon Web
Services account. Required permissions: Permission to retire a grant is determined
primarily by the grant. For details, see Retiring and revoking grants in the Key Management
Service Developer Guide. Related operations: CreateGrant ListGrants
ListRetirableGrants RevokeGrant Eventual consistency: The KMS API follows an
eventual consistency model. For more information, see KMS eventual consistency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantId"`: Identifies the grant to retire. To get the grant ID, use CreateGrant,
ListGrants, or ListRetirableGrants. Grant ID Example -
0123456789012345678901234567890123456789012345678901234567890123
- `"GrantToken"`: Identifies the grant to be retired. You can use a grant token to identify
a new grant even before it has achieved eventual consistency. Only the CreateGrant
operation returns a grant token. For details, see Grant token and Eventual consistency in
the Key Management Service Developer Guide.
- `"KeyId"`: The key ARN KMS key associated with the grant. To find the key ARN, use the
ListKeys operation. For example:
arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
"""
function retire_grant(; aws_config::AbstractAWSConfig=global_aws_config())
return kms("RetireGrant"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function retire_grant(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"RetireGrant", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
revoke_grant(grant_id, key_id)
revoke_grant(grant_id, key_id, params::Dict{String,<:Any})
Deletes the specified grant. You revoke a grant to terminate the permissions that the grant
allows. For more information, see Retiring and revoking grants in the Key Management
Service Developer Guide . When you create, retire, or revoke a grant, there might be a
brief delay, usually less than five minutes, until the grant is available throughout KMS.
This state is known as eventual consistency. For details, see Eventual consistency in the
Key Management Service Developer Guide . For detailed information about grants, including
grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For
examples of working with grants in several programming languages, see Programming grants.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web
Services account, specify the key ARN in the value of the KeyId parameter. Required
permissions: kms:RevokeGrant (key policy). Related operations: CreateGrant
ListGrants ListRetirableGrants RetireGrant Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `grant_id`: Identifies the grant to revoke. To get the grant ID, use CreateGrant,
ListGrants, or ListRetirableGrants.
- `key_id`: A unique identifier for the KMS key associated with the grant. To get the key
ID and key ARN for a KMS key, use ListKeys or DescribeKey. Specify the key ID or key ARN of
the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use
the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
"""
function revoke_grant(GrantId, KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"RevokeGrant",
Dict{String,Any}("GrantId" => GrantId, "KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_grant(
GrantId,
KeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"RevokeGrant",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GrantId" => GrantId, "KeyId" => KeyId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rotate_key_on_demand(key_id)
rotate_key_on_demand(key_id, params::Dict{String,<:Any})
Immediately initiates rotation of the key material of the specified symmetric encryption
KMS key. You can perform on-demand rotation of the key material in customer managed KMS
keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations
do not change existing automatic rotation schedules. For example, consider a KMS key that
has automatic key rotation enabled with a rotation period of 730 days. If the key is
scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation
on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and
every 730 days thereafter. You can perform on-demand key rotation a maximum of 10 times
per KMS key. You can use the KMS console to view the number of remaining on-demand
rotations available for a KMS key. You can use GetKeyRotationStatus to identify any in
progress on-demand rotations. You can use ListKeyRotations to identify the date that
completed on-demand rotations were performed. You can monitor rotation of the key material
for your KMS keys in CloudTrail and Amazon CloudWatch. On-demand key rotation is supported
only on symmetric encryption KMS keys. You cannot perform on-demand rotation of asymmetric
KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key
store. To perform on-demand rotation of a set of related multi-Region keys, invoke the
on-demand rotation on the primary key. You cannot initiate on-demand rotation of Amazon Web
Services managed KMS keys. KMS always rotates the key material of Amazon Web Services
managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the
Amazon Web Services service that owns the key. The KMS key that you use for this operation
must be in a compatible key state. For details, see Key states of KMS keys in the Key
Management Service Developer Guide. Cross-account use: No. You cannot perform this
operation on a KMS key in a different Amazon Web Services account. Required permissions:
kms:RotateKeyOnDemand (key policy) Related operations: EnableKeyRotation
DisableKeyRotation GetKeyRotationStatus ListKeyRotations Eventual consistency:
The KMS API follows an eventual consistency model. For more information, see KMS eventual
consistency.
# Arguments
- `key_id`: Identifies a symmetric encryption KMS key. You cannot perform on-demand
rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS
keys in a custom key store. To perform on-demand rotation of a set of related multi-Region
keys, invoke the on-demand rotation on the primary key. Specify the key ID or key ARN of
the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function rotate_key_on_demand(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"RotateKeyOnDemand",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_key_on_demand(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"RotateKeyOnDemand",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
schedule_key_deletion(key_id)
schedule_key_deletion(key_id, params::Dict{String,<:Any})
Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days,
but you can specify a waiting period of 7-30 days. When this operation is successful, the
key state of the KMS key changes to PendingDeletion and the key can't be used in any
cryptographic operations. It remains in this state for the duration of the waiting period.
Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the
KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all
KMS data associated with it, including all aliases that refer to it. Deleting a KMS key is
a destructive and potentially dangerous operation. When a KMS key is deleted, all data that
was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region
replica key, or an asymmetric or HMAC KMS key with imported key material.) To prevent the
use of a KMS key without deleting it, use DisableKey. You can schedule the deletion of a
multi-Region primary key and its replica keys at any time. However, KMS will not delete a
multi-Region primary key with existing replica keys. If you schedule the deletion of a
primary key with replicas, its key state changes to PendingReplicaDeletion and it cannot be
replicated or used in cryptographic operations. This status can continue indefinitely. When
the last of its replicas keys is deleted (not just scheduled), the key state of the primary
key changes to PendingDeletion and its waiting period (PendingWindowInDays) begins. For
details, see Deleting multi-Region keys in the Key Management Service Developer Guide. When
KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the
associated key material from the associated CloudHSM cluster. However, you might need to
manually delete the orphaned key material from the cluster and its backups. Deleting a KMS
key from an external key store has no effect on the associated external key. However, for
both types of custom key stores, deleting a KMS key is destructive and irreversible. You
cannot decrypt ciphertext encrypted under the KMS key by using only its associated external
key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by
creating a new KMS key with the same key material. For more information about scheduling a
KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details,
see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account
use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services
account. Required permissions: kms:ScheduleKeyDeletion (key policy) Related operations
CancelKeyDeletion DisableKey Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: The unique identifier of the KMS key to delete. Specify the key ID or key ARN
of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PendingWindowInDays"`: The waiting period, specified in number of days. After the
waiting period ends, KMS deletes the KMS key. If the KMS key is a multi-Region primary key
with replica keys, the waiting period begins when the last of its replica keys is deleted.
Otherwise, the waiting period begins immediately. This value is optional. If you include a
value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults
to 30. You can use the kms:ScheduleKeyDeletionPendingWindowInDays condition key to
further constrain the values that principals can specify in the PendingWindowInDays
parameter.
"""
function schedule_key_deletion(KeyId; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"ScheduleKeyDeletion",
Dict{String,Any}("KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function schedule_key_deletion(
KeyId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"ScheduleKeyDeletion",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyId" => KeyId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
sign(key_id, message, signing_algorithm)
sign(key_id, message, signing_algorithm, params::Dict{String,<:Any})
Creates a digital signature for a message or message digest by using the private key in an
asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the
public key in the same asymmetric KMS key outside of KMS. For information about asymmetric
KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. Digital
signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC
pair that is represented by an asymmetric KMS key. The key owner (or an authorized user)
uses their private key to sign a message. Anyone with the public key can verify that the
message was signed with that particular private key and that the message hasn't changed
since it was signed. To use the Sign operation, provide the following information: Use
the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY.
To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have
kms:Sign permission on the KMS key. Use the Message parameter to specify the message or
message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger
message, generate a hash digest of the message, and then provide the hash digest in the
Message parameter. To indicate whether the message is a full message or a digest, use the
MessageType parameter. Choose a signing algorithm that is compatible with the KMS key.
When signing a message, be sure to record the KMS key and the signing algorithm. This
information is required to verify the signature. Best practices recommend that you limit
the time during which any signature is effective. This deters an attack where the actor
uses a signed message to establish validity repeatedly or long after the message is
superseded. Signatures do not include a timestamp, but you can include a timestamp in the
signed message to help you detect when its time to refresh the signature. To verify the
signature that this operation generates, use the Verify operation. Or use the GetPublicKey
operation to download the public key and then use the public key to verify the signature
outside of KMS. The KMS key that you use for this operation must be in a compatible key
state. For details, see Key states of KMS keys in the Key Management Service Developer
Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter. Required permissions: kms:Sign (key policy) Related operations: Verify
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric
KMS key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find
the KeyUsage of a KMS key, use the DescribeKey operation. To specify a KMS key, use its key
ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
To specify a KMS key in a different Amazon Web Services account, you must use the key ARN
or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
- `message`: Specifies the message or message digest to sign. Messages can be 0-4096 bytes.
To sign a larger message, provide a message digest. If you provide a message digest, use
the DIGEST value of MessageType to prevent the digest from being hashed again while signing.
- `signing_algorithm`: Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric
KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include
RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"MessageType"`: Tells KMS whether the value of the Message parameter should be hashed as
part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message
digests, which are already hashed. When the value of MessageType is RAW, KMS uses the
standard signing algorithm, which begins with a hash function. When the value is DIGEST,
KMS skips the hashing step in the signing algorithm. Use the DIGEST value only when the
value of the Message parameter is a message digest. If you use the DIGEST value with an
unhashed message, the security of the signing operation can be compromised. When the value
of MessageTypeis DIGEST, the length of the Message value must match the length of hashed
messages for the specified signing algorithm. You can submit a message digest and omit the
MessageType or specify RAW so the digest is hashed again while signing. However, this can
cause verification failures when verifying with a system that assumes a single hash. The
hashing algorithm in that Sign uses is based on the SigningAlgorithm value. Signing
algorithms that end in SHA_256 use the SHA_256 hashing algorithm. Signing algorithms that
end in SHA_384 use the SHA_384 hashing algorithm. Signing algorithms that end in SHA_512
use the SHA_512 hashing algorithm. SM2DSA uses the SM3 hashing algorithm. For details,
see Offline verification with SM2 key pairs.
"""
function sign(
KeyId, Message, SigningAlgorithm; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"Sign",
Dict{String,Any}(
"KeyId" => KeyId, "Message" => Message, "SigningAlgorithm" => SigningAlgorithm
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function sign(
KeyId,
Message,
SigningAlgorithm,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"Sign",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyId" => KeyId,
"Message" => Message,
"SigningAlgorithm" => SigningAlgorithm,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(key_id, tags)
tag_resource(key_id, tags, params::Dict{String,<:Any})
Adds or edits tags on a customer managed key. Tagging or untagging a KMS key can allow or
deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service
Developer Guide. Each tag consists of a tag key and a tag value, both of which are
case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify
a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag
value. You can use this operation to tag a customer managed key, but you cannot tag an
Amazon Web Services managed key, an Amazon Web Services owned key, a custom key store, or
an alias. You can also add tags to a KMS key while creating it (CreateKey) or replicating
it (ReplicateKey). For information about using tags in KMS, see Tagging keys. For general
information about tags, including the format and syntax, see Tagging Amazon Web Services
resources in the Amazon Web Services General Reference. The KMS key that you use for this
operation must be in a compatible key state. For details, see Key states of KMS keys in the
Key Management Service Developer Guide. Cross-account use: No. You cannot perform this
operation on a KMS key in a different Amazon Web Services account. Required permissions:
kms:TagResource (key policy) Related operations CreateKey ListResourceTags
ReplicateKey UntagResource Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies a customer managed key in the account and Region. Specify the key ID
or key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To
get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `tags`: One or more tags. Each tag consists of a tag key and a tag value. The tag value
can be an empty (null) string. Do not include confidential or sensitive information in
this field. This field may be displayed in plaintext in CloudTrail logs and other output.
You cannot have more than one tag on a KMS key with the same tag key. If you specify an
existing tag key with a different tag value, KMS replaces the current tag value with the
specified one.
"""
function tag_resource(KeyId, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"TagResource",
Dict{String,Any}("KeyId" => KeyId, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
KeyId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"TagResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyId" => KeyId, "Tags" => Tags), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(key_id, tag_keys)
untag_resource(key_id, tag_keys, params::Dict{String,<:Any})
Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS
key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For
details, see ABAC for KMS in the Key Management Service Developer Guide. When it succeeds,
the UntagResource operation doesn't return any output. Also, if the specified tag key isn't
found on the KMS key, it doesn't throw an exception or return a response. To confirm that
the operation worked, use the ListResourceTags operation. For information about using tags
in KMS, see Tagging keys. For general information about tags, including the format and
syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General
Reference. The KMS key that you use for this operation must be in a compatible key state.
For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon
Web Services account. Required permissions: kms:UntagResource (key policy) Related
operations CreateKey ListResourceTags ReplicateKey TagResource Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Arguments
- `key_id`: Identifies the KMS key from which you are removing tags. Specify the key ID or
key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get
the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `tag_keys`: One or more tag keys. Specify only the tag keys, not the tag values.
"""
function untag_resource(KeyId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return kms(
"UntagResource",
Dict{String,Any}("KeyId" => KeyId, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
KeyId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("KeyId" => KeyId, "TagKeys" => TagKeys), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_alias(alias_name, target_key_id)
update_alias(alias_name, target_key_id, params::Dict{String,<:Any})
Associates an existing KMS alias with a different KMS key. Each alias is associated with
only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
KMS key must be in the same Amazon Web Services account and Region. Adding, deleting, or
updating an alias can allow or deny permission to the KMS key. For details, see ABAC for
KMS in the Key Management Service Developer Guide. The current and new KMS key must be the
same type (both symmetric or both asymmetric or both HMAC), and they must have the same key
usage. This restriction prevents errors in code that uses aliases. If you must assign an
alias to a different type of KMS key, use DeleteAlias to delete the old alias and
CreateAlias to create a new alias. You cannot use UpdateAlias to change an alias name. To
change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a
new alias. Because an alias is not a property of a KMS key, you can create, update, and
delete the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear
in the response from the DescribeKey operation. To get the aliases of all KMS keys in the
account, use the ListAliases operation. The KMS key that you use for this operation must
be in a compatible key state. For details, see Key states of KMS keys in the Key Management
Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS
key in a different Amazon Web Services account. Required permissions kms:UpdateAlias
on the alias (IAM policy). kms:UpdateAlias on the current KMS key (key policy).
kms:UpdateAlias on the new KMS key (key policy). For details, see Controlling access to
aliases in the Key Management Service Developer Guide. Related operations: CreateAlias
DeleteAlias ListAliases Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `alias_name`: Identifies the alias that is changing its KMS key. This value must begin
with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use
UpdateAlias to change the alias name. Do not include confidential or sensitive information
in this field. This field may be displayed in plaintext in CloudTrail logs and other
output.
- `target_key_id`: Identifies the customer managed key to associate with the alias. You
don't have permission to associate an alias with an Amazon Web Services managed key. The
KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the
new target KMS key must be the same type as the current target KMS key (both symmetric or
both asymmetric or both HMAC) and they must have the same key usage. Specify the key ID or
key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get
the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To verify that the alias
is mapped to the correct KMS key, use ListAliases.
"""
function update_alias(
AliasName, TargetKeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"UpdateAlias",
Dict{String,Any}("AliasName" => AliasName, "TargetKeyId" => TargetKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_alias(
AliasName,
TargetKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"UpdateAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AliasName" => AliasName, "TargetKeyId" => TargetKeyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_key_store(custom_key_store_id)
update_custom_key_store(custom_key_store_id, params::Dict{String,<:Any})
Changes the properties of a custom key store. You can use this operation to change the
properties of an CloudHSM key store or an external key store. Use the required
CustomKeyStoreId parameter to identify the custom key store. Use the remaining optional
parameters to change its properties. This operation does not return any property values. To
verify the updated property values, use the DescribeCustomKeyStores operation. This
operation is part of the custom key stores feature in KMS, which combines the convenience
and extensive integration of KMS with the isolation and control of a key store that you own
and manage. When updating the properties of an external key store, verify that the updated
settings connect your key store, via the external key store proxy, to the same external key
manager as the previous settings, or to a backup or snapshot of the external key manager
with the same cryptographic keys. If the updated connection settings fail, you can fix them
and retry, although an extended delay might disrupt Amazon Web Services services. However,
if KMS permanently loses its access to cryptographic keys, ciphertext encrypted under those
keys is unrecoverable. For external key stores: Some external key managers provide a
simpler method for updating an external key store. For details, see your external key
manager documentation. When updating an external key store in the KMS console, you can
upload a JSON-based proxy configuration file with the desired values. You cannot upload the
proxy configuration file to the UpdateCustomKeyStore operation. However, you can use the
file to help you determine the correct values for the UpdateCustomKeyStore parameters. For
an CloudHSM key store, you can use this operation to change the custom key store friendly
name (NewCustomKeyStoreName), to tell KMS about a change to the kmsuser crypto user
password (KeyStorePassword), or to associate the custom key store with a different, but
related, CloudHSM cluster (CloudHsmClusterId). To update any property of an CloudHSM key
store, the ConnectionState of the CloudHSM key store must be DISCONNECTED. For an external
key store, you can use this operation to change the custom key store friendly name
(NewCustomKeyStoreName), or to tell KMS about a change to the external key store proxy
authentication credentials (XksProxyAuthenticationCredential), connection method
(XksProxyConnectivity), external proxy endpoint (XksProxyUriEndpoint) and path
(XksProxyUriPath). For external key stores with an XksProxyConnectivity of
VPC_ENDPOINT_SERVICE, you can also update the Amazon VPC endpoint service name
(XksProxyVpcEndpointServiceName). To update most properties of an external key store, the
ConnectionState of the external key store must be DISCONNECTED. However, you can update the
CustomKeyStoreName, XksProxyAuthenticationCredential, and XksProxyUriPath of an external
key store when it is in the CONNECTED or DISCONNECTED state. If your update requires a
DISCONNECTED state, before using UpdateCustomKeyStore, use the DisconnectCustomKeyStore
operation to disconnect the custom key store. After the UpdateCustomKeyStore operation
completes, use the ConnectCustomKeyStore to reconnect the custom key store. To find the
ConnectionState of the custom key store, use the DescribeCustomKeyStores operation.
Before updating the custom key store, verify that the new values allow KMS to connect the
custom key store to its backing key store. For example, before you change the
XksProxyUriPath value, verify that the external key store proxy is reachable at the new
path. If the operation succeeds, it returns a JSON object with no properties.
Cross-account use: No. You cannot perform this operation on a custom key store in a
different Amazon Web Services account. Required permissions: kms:UpdateCustomKeyStore (IAM
policy) Related operations: ConnectCustomKeyStore CreateCustomKeyStore
DeleteCustomKeyStore DescribeCustomKeyStores DisconnectCustomKeyStore Eventual
consistency: The KMS API follows an eventual consistency model. For more information, see
KMS eventual consistency.
# Arguments
- `custom_key_store_id`: Identifies the custom key store that you want to update. Enter the
ID of the custom key store. To find the ID of a custom key store, use the
DescribeCustomKeyStores operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudHsmClusterId"`: Associates the custom key store with a related CloudHSM cluster.
This parameter is valid only for custom key stores with a CustomKeyStoreType of
AWS_CLOUDHSM. Enter the cluster ID of the cluster that you used to create the custom key
store or a cluster that shares a backup history and has the same cluster certificate as the
original cluster. You cannot use this parameter to associate a custom key store with an
unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a
cluster associated with a custom key store. To view the cluster certificate of a cluster,
use the DescribeClusters operation. To change this value, the CloudHSM key store must be
disconnected.
- `"KeyStorePassword"`: Enter the current password of the kmsuser crypto user (CU) in the
CloudHSM cluster that is associated with the custom key store. This parameter is valid only
for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM. This parameter tells KMS
the current password of the kmsuser crypto user (CU). It does not set or change the
password of any users in the CloudHSM cluster. To change this value, the CloudHSM key store
must be disconnected.
- `"NewCustomKeyStoreName"`: Changes the friendly name of the custom key store to the value
that you specify. The custom key store name must be unique in the Amazon Web Services
account. Do not include confidential or sensitive information in this field. This field
may be displayed in plaintext in CloudTrail logs and other output. To change this value,
an CloudHSM key store must be disconnected. An external key store can be connected or
disconnected.
- `"XksProxyAuthenticationCredential"`: Changes the credentials that KMS uses to sign
requests to the external key store proxy (XKS proxy). This parameter is valid only for
custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE. You must specify both
the AccessKeyId and SecretAccessKey value in the authentication credential, even if you are
only updating one value. This parameter doesn't establish or change your authentication
credentials on the proxy. It just tells KMS the credential that you established with your
external key store proxy. For example, if you rotate the credential on your external key
store proxy, you can use this parameter to update the credential in KMS. You can change
this value when the external key store is connected or disconnected.
- `"XksProxyConnectivity"`: Changes the connectivity setting for the external key store. To
indicate that the external key store proxy uses a Amazon VPC endpoint service to
communicate with KMS, specify VPC_ENDPOINT_SERVICE. Otherwise, specify PUBLIC_ENDPOINT. If
you change the XksProxyConnectivity to VPC_ENDPOINT_SERVICE, you must also change the
XksProxyUriEndpoint and add an XksProxyVpcEndpointServiceName value. If you change the
XksProxyConnectivity to PUBLIC_ENDPOINT, you must also change the XksProxyUriEndpoint and
specify a null or empty string for the XksProxyVpcEndpointServiceName value. To change this
value, the external key store must be disconnected.
- `"XksProxyUriEndpoint"`: Changes the URI endpoint that KMS uses to connect to your
external key store proxy (XKS proxy). This parameter is valid only for custom key stores
with a CustomKeyStoreType of EXTERNAL_KEY_STORE. For external key stores with an
XksProxyConnectivity value of PUBLIC_ENDPOINT, the protocol must be HTTPS. For external key
stores with an XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https://
followed by the private DNS name associated with the VPC endpoint service. Each external
key store must use a different private DNS name. The combined XksProxyUriEndpoint and
XksProxyUriPath values must be unique in the Amazon Web Services account and Region. To
change this value, the external key store must be disconnected.
- `"XksProxyUriPath"`: Changes the base path to the proxy APIs for this external key store.
To find this value, see the documentation for your external key manager and external key
store proxy (XKS proxy). This parameter is valid only for custom key stores with a
CustomKeyStoreType of EXTERNAL_KEY_STORE. The value must start with / and must end with
/kms/xks/v1, where v1 represents the version of the KMS external key store proxy API. You
can include an optional prefix between the required elements such as /example/kms/xks/v1.
The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon
Web Services account and Region. You can change this value when the external key store is
connected or disconnected.
- `"XksProxyVpcEndpointServiceName"`: Changes the name that KMS uses to identify the Amazon
VPC endpoint service for your external key store proxy (XKS proxy). This parameter is valid
when the CustomKeyStoreType is EXTERNAL_KEY_STORE and the XksProxyConnectivity is
VPC_ENDPOINT_SERVICE. To change this value, the external key store must be disconnected.
"""
function update_custom_key_store(
CustomKeyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"UpdateCustomKeyStore",
Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_key_store(
CustomKeyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"UpdateCustomKeyStore",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CustomKeyStoreId" => CustomKeyStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_key_description(description, key_id)
update_key_description(description, key_id, params::Dict{String,<:Any})
Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.
The KMS key that you use for this operation must be in a compatible key state. For
details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon
Web Services account. Required permissions: kms:UpdateKeyDescription (key policy)
Related operations CreateKey DescribeKey Eventual consistency: The KMS API
follows an eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `description`: New description for the KMS key. Do not include confidential or sensitive
information in this field. This field may be displayed in plaintext in CloudTrail logs and
other output.
- `key_id`: Updates the description of the specified KMS key. Specify the key ID or key ARN
of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
"""
function update_key_description(
Description, KeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"UpdateKeyDescription",
Dict{String,Any}("Description" => Description, "KeyId" => KeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_key_description(
Description,
KeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"UpdateKeyDescription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Description" => Description, "KeyId" => KeyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_primary_region(key_id, primary_region)
update_primary_region(key_id, primary_region, params::Dict{String,<:Any})
Changes the primary key of a multi-Region key. This operation changes the replica key in
the specified Region to a primary key and changes the former primary key to a replica key.
For example, suppose you have a primary key in us-east-1 and a replica key in eu-west-2. If
you run UpdatePrimaryRegion with a PrimaryRegion value of eu-west-2, the primary key is now
the key in eu-west-2, and the key in us-east-1 becomes a replica key. For details, see
Updating the primary Region in the Key Management Service Developer Guide. This operation
supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS
keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID,
key material, and other metadata, you can use them interchangeably to encrypt data in one
Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without
re-encrypting the data or making a cross-Region call. For more information about
multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer
Guide. The primary key of a multi-Region key is the source for properties that are always
shared by primary and replica keys, including the key material, key ID, key spec, key
usage, key material origin, and automatic key rotation. It's the only key that can be
replicated. You cannot delete the primary key until all replica keys are deleted. The key
ID and primary Region that you specify uniquely identify the replica key that will become
the primary key. The primary Region must already have a replica key. This operation does
not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey
operation on the primary key or any replica key. To create a replica key, use the
ReplicateKey operation. You can run this operation while using the affected multi-Region
keys in cryptographic operations. This operation should not delay, interrupt, or cause
failures in cryptographic operations. Even after this operation completes, the process of
updating the primary Region might still be in progress for a few more seconds. Operations
such as DescribeKey might display both the old and new primary keys as replicas. The old
and new primary keys have a transient key state of Updating. The original key state is
restored when the update is complete. While the key state is Updating, you can use the keys
in cryptographic operations, but you cannot replicate the new primary key or perform
certain management operations, such as enabling or disabling these keys. For details about
the Updating key state, see Key states of KMS keys in the Key Management Service Developer
Guide. This operation does not return any output. To verify that primary key is changed,
use the DescribeKey operation. Cross-account use: No. You cannot use this operation in a
different Amazon Web Services account. Required permissions: kms:UpdatePrimaryRegion
on the current primary key (in the primary key's Region). Include this permission primary
key's key policy. kms:UpdatePrimaryRegion on the current replica key (in the replica
key's Region). Include this permission in the replica key's key policy. Related
operations CreateKey ReplicateKey Eventual consistency: The KMS API follows an
eventual consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the current primary key. When the operation completes, this KMS key
will be a replica key. Specify the key ID or key ARN of a multi-Region primary key. For
example: Key ID: mrk-1234abcd12ab34cd56ef1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab To get the
key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- `primary_region`: The Amazon Web Services Region of the new primary key. Enter the Region
ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this
Region. When the operation completes, the multi-Region key in this Region will be the
primary key.
"""
function update_primary_region(
KeyId, PrimaryRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"UpdatePrimaryRegion",
Dict{String,Any}("KeyId" => KeyId, "PrimaryRegion" => PrimaryRegion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_primary_region(
KeyId,
PrimaryRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"UpdatePrimaryRegion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("KeyId" => KeyId, "PrimaryRegion" => PrimaryRegion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify(key_id, message, signature, signing_algorithm)
verify(key_id, message, signature, signing_algorithm, params::Dict{String,<:Any})
Verifies a digital signature that was generated by the Sign operation. Verification
confirms that an authorized user signed the message with the specified KMS key and signing
algorithm, and the message hasn't changed since it was signed. If the signature is
verified, the value of the SignatureValid field in the response is True. If the signature
verification fails, the Verify operation fails with an KMSInvalidSignatureException
exception. A digital signature is generated by using the private key in an asymmetric KMS
key. The signature is verified by using the public key in the same asymmetric KMS key. For
information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management
Service Developer Guide. To use the Verify operation, specify the same asymmetric KMS key,
message, and signing algorithm that were used to produce the signature. The message type
does not need to be the same as the one used for signing, but it must indicate whether the
value of the Message parameter should be hashed as part of the verification process. You
can also verify the digital signature by using the public key of the KMS key outside of
KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key
and then use the public key to verify the signature outside of KMS. The advantage of using
the Verify operation is that it is performed within KMS. As a result, it's easy to call,
the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you
can use key policy and IAM policy to determine who is authorized to use the KMS key to
verify signatures. To verify a signature outside of KMS with an SM2 public key (China
Regions only), you must specify the distinguishing ID. By default, KMS uses
1234567812345678 as the distinguishing ID. For more information, see Offline verification
with SM2 key pairs. The KMS key that you use for this operation must be in a compatible key
state. For details, see Key states of KMS keys in the Key Management Service Developer
Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter. Required permissions: kms:Verify (key policy) Related operations: Sign
Eventual consistency: The KMS API follows an eventual consistency model. For more
information, see KMS eventual consistency.
# Arguments
- `key_id`: Identifies the asymmetric KMS key that will be used to verify the signature.
This must be the same KMS key that was used to generate the signature. If you specify a
different KMS key, the signature verification fails. To specify a KMS key, use its key ID,
key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To
specify a KMS key in a different Amazon Web Services account, you must use the key ARN or
alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias
name and alias ARN, use ListAliases.
- `message`: Specifies the message that was signed. You can submit a raw message of up to
4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType
parameter with a value of DIGEST. If the message specified here is different from the
message that was signed, the signature verification fails. A message and its hash digest
are considered to be the same message.
- `signature`: The signature that the Sign operation generated.
- `signing_algorithm`: The signing algorithm that was used to sign the message. If you
submit a different algorithm, the signature verification fails.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
- `"MessageType"`: Tells KMS whether the value of the Message parameter should be hashed as
part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message
digests, which are already hashed. When the value of MessageType is RAW, KMS uses the
standard signing algorithm, which begins with a hash function. When the value is DIGEST,
KMS skips the hashing step in the signing algorithm. Use the DIGEST value only when the
value of the Message parameter is a message digest. If you use the DIGEST value with an
unhashed message, the security of the verification operation can be compromised. When the
value of MessageTypeis DIGEST, the length of the Message value must match the length of
hashed messages for the specified signing algorithm. You can submit a message digest and
omit the MessageType or specify RAW so the digest is hashed again while signing. However,
if the signed message is hashed once while signing, but twice while verifying, verification
fails, even when the message hasn't changed. The hashing algorithm in that Verify uses is
based on the SigningAlgorithm value. Signing algorithms that end in SHA_256 use the
SHA_256 hashing algorithm. Signing algorithms that end in SHA_384 use the SHA_384 hashing
algorithm. Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key
pairs.
"""
function verify(
KeyId,
Message,
Signature,
SigningAlgorithm;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"Verify",
Dict{String,Any}(
"KeyId" => KeyId,
"Message" => Message,
"Signature" => Signature,
"SigningAlgorithm" => SigningAlgorithm,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify(
KeyId,
Message,
Signature,
SigningAlgorithm,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"Verify",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyId" => KeyId,
"Message" => Message,
"Signature" => Signature,
"SigningAlgorithm" => SigningAlgorithm,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_mac(key_id, mac, mac_algorithm, message)
verify_mac(key_id, mac, mac_algorithm, message, params::Dict{String,<:Any})
Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC
KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the
message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC
to the HMAC that you specify. If the HMACs are identical, the verification succeeds;
otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC
was calculated, and the specified key was used to generate and verify the HMAC. HMAC KMS
keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC
2104. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys
in KMS in the Key Management Service Developer Guide. The KMS key that you use for this
operation must be in a compatible key state. For details, see Key states of KMS keys in the
Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation
with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN
in the value of the KeyId parameter. Required permissions: kms:VerifyMac (key policy)
Related operations: GenerateMac Eventual consistency: The KMS API follows an eventual
consistency model. For more information, see KMS eventual consistency.
# Arguments
- `key_id`: The KMS key that will be used in the verification. Enter a key ID of the KMS
key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac
operation fails.
- `mac`: The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation
when you specified the same message, HMAC KMS key, and MAC algorithm as the values
specified in this request.
- `mac_algorithm`: The MAC algorithm that will be used in the verification. Enter the same
MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the
HMAC KMS key identified by the KeyId parameter.
- `message`: The message that will be used in the verification. Enter the same message that
was used to generate the HMAC. GenerateMac and VerifyMac do not provide special handling
for message digests. If you generated an HMAC for a hash digest of a message, you must
verify the HMAC for the same hash digest.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks if your request will succeed. DryRun is an optional parameter. To
learn more about how to use this parameter, see Testing your KMS API calls in the Key
Management Service Developer Guide.
- `"GrantTokens"`: A list of grant tokens. Use a grant token when your permission to call
this operation comes from a new grant that has not yet achieved eventual consistency. For
more information, see Grant token and Using a grant token in the Key Management Service
Developer Guide.
"""
function verify_mac(
KeyId, Mac, MacAlgorithm, Message; aws_config::AbstractAWSConfig=global_aws_config()
)
return kms(
"VerifyMac",
Dict{String,Any}(
"KeyId" => KeyId,
"Mac" => Mac,
"MacAlgorithm" => MacAlgorithm,
"Message" => Message,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_mac(
KeyId,
Mac,
MacAlgorithm,
Message,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return kms(
"VerifyMac",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyId" => KeyId,
"Mac" => Mac,
"MacAlgorithm" => MacAlgorithm,
"Message" => Message,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 85195 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lakeformation
using AWS.Compat
using AWS.UUIDs
"""
add_lftags_to_resource(lftags, resource)
add_lftags_to_resource(lftags, resource, params::Dict{String,<:Any})
Attaches one or more LF-tags to an existing resource.
# Arguments
- `lftags`: The LF-tags to attach to the resource.
- `resource`: The database, table, or column resource to which to attach an LF-tag.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function add_lftags_to_resource(
LFTags, Resource; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/AddLFTagsToResource",
Dict{String,Any}("LFTags" => LFTags, "Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_lftags_to_resource(
LFTags,
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/AddLFTagsToResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LFTags" => LFTags, "Resource" => Resource), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_decorated_role_with_saml(principal_arn, role_arn, samlassertion)
assume_decorated_role_with_saml(principal_arn, role_arn, samlassertion, params::Dict{String,<:Any})
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML
assertion included in the request. This decoration allows Lake Formation to enforce access
policies against the SAML users and groups. This API operation requires SAML federation
setup in the caller’s account as it can only be called with valid SAML assertions. Lake
Formation does not scope down the permission of the assumed role. All permissions attached
to the role via the SAML federation setup will be included in the role session. This
decorated role is expected to access data in Amazon S3 by getting temporary access from
Lake Formation which is authorized via the virtual API GetDataAccess. Therefore, all SAML
roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include
lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a
role would look as follows:
# Arguments
- `principal_arn`: The Amazon Resource Name (ARN) of the SAML provider in IAM that
describes the IdP.
- `role_arn`: The role that represents an IAM principal whose scope down policy allows it
to call credential vending APIs such as GetTemporaryTableCredentials. The caller must also
have iam:PassRole permission on this role.
- `samlassertion`: A SAML assertion consisting of an assertion statement for the user who
needs temporary credentials. This must match the SAML assertion that was issued to IAM.
This must be Base64 encoded.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationSeconds"`: The time period, between 900 and 43,200 seconds, for the timeout of
the temporary credentials.
"""
function assume_decorated_role_with_saml(
PrincipalArn, RoleArn, SAMLAssertion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/AssumeDecoratedRoleWithSAML",
Dict{String,Any}(
"PrincipalArn" => PrincipalArn,
"RoleArn" => RoleArn,
"SAMLAssertion" => SAMLAssertion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_decorated_role_with_saml(
PrincipalArn,
RoleArn,
SAMLAssertion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/AssumeDecoratedRoleWithSAML",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PrincipalArn" => PrincipalArn,
"RoleArn" => RoleArn,
"SAMLAssertion" => SAMLAssertion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_grant_permissions(entries)
batch_grant_permissions(entries, params::Dict{String,<:Any})
Batch operation to grant permissions to the principal.
# Arguments
- `entries`: A list of up to 20 entries for resource permissions to be granted by batch
operation to the principal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function batch_grant_permissions(Entries; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/BatchGrantPermissions",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_grant_permissions(
Entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/BatchGrantPermissions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_revoke_permissions(entries)
batch_revoke_permissions(entries, params::Dict{String,<:Any})
Batch operation to revoke permissions from the principal.
# Arguments
- `entries`: A list of up to 20 entries for resource permissions to be revoked by batch
operation to the principal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function batch_revoke_permissions(
Entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/BatchRevokePermissions",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_revoke_permissions(
Entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/BatchRevokePermissions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_transaction(transaction_id)
cancel_transaction(transaction_id, params::Dict{String,<:Any})
Attempts to cancel the specified transaction. Returns an exception if the transaction was
previously committed.
# Arguments
- `transaction_id`: The transaction to cancel.
"""
function cancel_transaction(
TransactionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/CancelTransaction",
Dict{String,Any}("TransactionId" => TransactionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_transaction(
TransactionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/CancelTransaction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransactionId" => TransactionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
commit_transaction(transaction_id)
commit_transaction(transaction_id, params::Dict{String,<:Any})
Attempts to commit the specified transaction. Returns an exception if the transaction was
previously aborted. This API action is idempotent if called multiple times for the same
transaction.
# Arguments
- `transaction_id`: The transaction to commit.
"""
function commit_transaction(
TransactionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/CommitTransaction",
Dict{String,Any}("TransactionId" => TransactionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function commit_transaction(
TransactionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/CommitTransaction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransactionId" => TransactionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_cells_filter(table_data)
create_data_cells_filter(table_data, params::Dict{String,<:Any})
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
# Arguments
- `table_data`: A DataCellsFilter structure containing information about the data cells
filter.
"""
function create_data_cells_filter(
TableData; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/CreateDataCellsFilter",
Dict{String,Any}("TableData" => TableData);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_cells_filter(
TableData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/CreateDataCellsFilter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableData" => TableData), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lake_formation_identity_center_configuration()
create_lake_formation_identity_center_configuration(params::Dict{String,<:Any})
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center
users and groups to access Data Catalog resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, view definitions, and other control information to manage your Lake Formation
environment.
- `"ExternalFiltering"`: A list of the account IDs of Amazon Web Services accounts of
third-party applications that are allowed to access data managed by Lake Formation.
- `"InstanceArn"`: The ARN of the IAM Identity Center instance for which the operation will
be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon
Web Services Service Namespaces in the Amazon Web Services General Reference.
- `"ShareRecipients"`: A list of Amazon Web Services account IDs and/or Amazon Web Services
organization/organizational unit ARNs that are allowed to access data managed by Lake
Formation. If the ShareRecipients list includes valid values, a resource share is created
with the principals you want to have access to the resources. If the ShareRecipients value
is null or the list is empty, no resource share is created.
"""
function create_lake_formation_identity_center_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/CreateLakeFormationIdentityCenterConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lake_formation_identity_center_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/CreateLakeFormationIdentityCenterConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lake_formation_opt_in(principal, resource)
create_lake_formation_opt_in(principal, resource, params::Dict{String,<:Any})
Enforce Lake Formation permissions for the given databases, tables, and principals.
# Arguments
- `principal`:
- `resource`:
"""
function create_lake_formation_opt_in(
Principal, Resource; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/CreateLakeFormationOptIn",
Dict{String,Any}("Principal" => Principal, "Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lake_formation_opt_in(
Principal,
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/CreateLakeFormationOptIn",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Principal" => Principal, "Resource" => Resource),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lftag(tag_key, tag_values)
create_lftag(tag_key, tag_values, params::Dict{String,<:Any})
Creates an LF-tag with the specified name and values.
# Arguments
- `tag_key`: The key-name for the LF-tag.
- `tag_values`: A list of possible values an attribute can take.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function create_lftag(TagKey, TagValues; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/CreateLFTag",
Dict{String,Any}("TagKey" => TagKey, "TagValues" => TagValues);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lftag(
TagKey,
TagValues,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/CreateLFTag",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TagKey" => TagKey, "TagValues" => TagValues),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_cells_filter()
delete_data_cells_filter(params::Dict{String,<:Any})
Deletes a data cell filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatabaseName"`: A database in the Glue Data Catalog.
- `"Name"`: The name given by the user to the data filter cell.
- `"TableCatalogId"`: The ID of the catalog to which the table belongs.
- `"TableName"`: A table in the database.
"""
function delete_data_cells_filter(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/DeleteDataCellsFilter";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_cells_filter(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DeleteDataCellsFilter",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lake_formation_identity_center_configuration()
delete_lake_formation_identity_center_configuration(params::Dict{String,<:Any})
Deletes an IAM Identity Center connection with Lake Formation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, view definition, and other control information to manage your Lake Formation
environment.
"""
function delete_lake_formation_identity_center_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DeleteLakeFormationIdentityCenterConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lake_formation_identity_center_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DeleteLakeFormationIdentityCenterConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lake_formation_opt_in(principal, resource)
delete_lake_formation_opt_in(principal, resource, params::Dict{String,<:Any})
Remove the Lake Formation permissions enforcement of the given databases, tables, and
principals.
# Arguments
- `principal`:
- `resource`:
"""
function delete_lake_formation_opt_in(
Principal, Resource; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DeleteLakeFormationOptIn",
Dict{String,Any}("Principal" => Principal, "Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lake_formation_opt_in(
Principal,
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/DeleteLakeFormationOptIn",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Principal" => Principal, "Resource" => Resource),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lftag(tag_key)
delete_lftag(tag_key, params::Dict{String,<:Any})
Deletes the specified LF-tag given a key name. If the input parameter tag key was not
found, then the operation will throw an exception. When you delete an LF-tag, the
LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still
assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be
applied to the resource.
# Arguments
- `tag_key`: The key-name for the LF-tag to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function delete_lftag(TagKey; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/DeleteLFTag",
Dict{String,Any}("TagKey" => TagKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lftag(
TagKey, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DeleteLFTag",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TagKey" => TagKey), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_objects_on_cancel(database_name, objects, table_name, transaction_id)
delete_objects_on_cancel(database_name, objects, table_name, transaction_id, params::Dict{String,<:Any})
For a specific governed table, provides a list of Amazon S3 objects that will be written
during the current transaction and that can be automatically deleted if the transaction is
canceled. Without this call, no Amazon S3 objects are automatically deleted when a
transaction cancels. The Glue ETL library function write_dynamic_frame.from_catalog()
includes an option to automatically call DeleteObjectsOnCancel before writes. For more
information, see Rolling Back Amazon S3 Writes.
# Arguments
- `database_name`: The database that contains the governed table.
- `objects`: A list of VirtualObject structures, which indicates the Amazon S3 objects to
be deleted if the transaction cancels.
- `table_name`: The name of the governed table.
- `transaction_id`: ID of the transaction that the writes occur in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The Glue data catalog that contains the governed table. Defaults to the
current account ID.
"""
function delete_objects_on_cancel(
DatabaseName,
Objects,
TableName,
TransactionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/DeleteObjectsOnCancel",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"Objects" => Objects,
"TableName" => TableName,
"TransactionId" => TransactionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_objects_on_cancel(
DatabaseName,
Objects,
TableName,
TransactionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/DeleteObjectsOnCancel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"Objects" => Objects,
"TableName" => TableName,
"TransactionId" => TransactionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_resource(resource_arn)
deregister_resource(resource_arn, params::Dict{String,<:Any})
Deregisters the resource as managed by the Data Catalog. When you deregister a path, Lake
Formation removes the path from the inline policy attached to your service-linked role.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to
deregister.
"""
function deregister_resource(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/DeregisterResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/DeregisterResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_lake_formation_identity_center_configuration()
describe_lake_formation_identity_center_configuration(params::Dict{String,<:Any})
Retrieves the instance ARN and application ARN for the connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function describe_lake_formation_identity_center_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DescribeLakeFormationIdentityCenterConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_lake_formation_identity_center_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DescribeLakeFormationIdentityCenterConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource(resource_arn)
describe_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the current data access role for the given resource registered in Lake Formation.
# Arguments
- `resource_arn`: The resource ARN.
"""
function describe_resource(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/DescribeResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/DescribeResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transaction(transaction_id)
describe_transaction(transaction_id, params::Dict{String,<:Any})
Returns the details of a single transaction.
# Arguments
- `transaction_id`: The transaction for which to return status.
"""
function describe_transaction(
TransactionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/DescribeTransaction",
Dict{String,Any}("TransactionId" => TransactionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transaction(
TransactionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/DescribeTransaction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransactionId" => TransactionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
extend_transaction()
extend_transaction(params::Dict{String,<:Any})
Indicates to the service that the specified transaction is still active and should not be
treated as idle and aborted. Write transactions that remain idle for a long period are
automatically aborted unless explicitly extended.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TransactionId"`: The transaction to extend.
"""
function extend_transaction(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST", "/ExtendTransaction"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function extend_transaction(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ExtendTransaction",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_cells_filter(database_name, name, table_catalog_id, table_name)
get_data_cells_filter(database_name, name, table_catalog_id, table_name, params::Dict{String,<:Any})
Returns a data cells filter.
# Arguments
- `database_name`: A database in the Glue Data Catalog.
- `name`: The name given by the user to the data filter cell.
- `table_catalog_id`: The ID of the catalog to which the table belongs.
- `table_name`: A table in the database.
"""
function get_data_cells_filter(
DatabaseName,
Name,
TableCatalogId,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetDataCellsFilter",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"Name" => Name,
"TableCatalogId" => TableCatalogId,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_cells_filter(
DatabaseName,
Name,
TableCatalogId,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetDataCellsFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"Name" => Name,
"TableCatalogId" => TableCatalogId,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_lake_principal()
get_data_lake_principal(params::Dict{String,<:Any})
Returns the identity of the invoking principal.
"""
function get_data_lake_principal(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetDataLakePrincipal";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_lake_principal(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetDataLakePrincipal",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_lake_settings()
get_data_lake_settings(params::Dict{String,<:Any})
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function get_data_lake_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetDataLakeSettings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_lake_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetDataLakeSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_effective_permissions_for_path(resource_arn)
get_effective_permissions_for_path(resource_arn, params::Dict{String,<:Any})
Returns the Lake Formation permissions for a specified table or database resource located
at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables
if the catalog is encrypted.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want to get
permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve this list.
"""
function get_effective_permissions_for_path(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetEffectivePermissionsForPath",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_effective_permissions_for_path(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetEffectivePermissionsForPath",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lftag(tag_key)
get_lftag(tag_key, params::Dict{String,<:Any})
Returns an LF-tag definition.
# Arguments
- `tag_key`: The key-name for the LF-tag.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function get_lftag(TagKey; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetLFTag",
Dict{String,Any}("TagKey" => TagKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lftag(
TagKey, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetLFTag",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TagKey" => TagKey), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_query_state(query_id)
get_query_state(query_id, params::Dict{String,<:Any})
Returns the state of a query previously submitted. Clients are expected to poll
GetQueryState to monitor the current state of the planning before retrieving the work
units. A query state is only visible to the principal that made the initial call to
StartQueryPlanning.
# Arguments
- `query_id`: The ID of the plan query operation.
"""
function get_query_state(QueryId; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetQueryState",
Dict{String,Any}("QueryId" => QueryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_query_state(
QueryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetQueryState",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("QueryId" => QueryId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_query_statistics(query_id)
get_query_statistics(query_id, params::Dict{String,<:Any})
Retrieves statistics on the planning and execution of a query.
# Arguments
- `query_id`: The ID of the plan query operation.
"""
function get_query_statistics(QueryId; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetQueryStatistics",
Dict{String,Any}("QueryId" => QueryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_query_statistics(
QueryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetQueryStatistics",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("QueryId" => QueryId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_lftags(resource)
get_resource_lftags(resource, params::Dict{String,<:Any})
Returns the LF-tags applied to a resource.
# Arguments
- `resource`: The database, table, or column resource for which you want to return LF-tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"ShowAssignedLFTags"`: Indicates whether to show the assigned LF-tags.
"""
function get_resource_lftags(Resource; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetResourceLFTags",
Dict{String,Any}("Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_lftags(
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetResourceLFTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Resource" => Resource), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table_objects(database_name, table_name)
get_table_objects(database_name, table_name, params::Dict{String,<:Any})
Returns the set of Amazon S3 objects that make up the specified governed table. A
transaction ID or timestamp can be specified for time-travel queries.
# Arguments
- `database_name`: The database containing the governed table.
- `table_name`: The governed table for which to retrieve objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The catalog containing the governed table. Defaults to the caller’s
account.
- `"MaxResults"`: Specifies how many values to return in a page.
- `"NextToken"`: A continuation token if this is not the first call to retrieve these
objects.
- `"PartitionPredicate"`: A predicate to filter the objects returned based on the partition
keys defined in the governed table. The comparison operators supported are: =, >,
<, >=, <= The logical operators supported are: AND The data types supported
are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd
HH:mm:ss\"), string and decimal.
- `"QueryAsOfTime"`: The time as of when to read the governed table contents. If not set,
the most recent transaction commit time is used. Cannot be specified along with
TransactionId.
- `"TransactionId"`: The transaction ID at which to read the governed table contents. If
this transaction has aborted, an error is returned. If not set, defaults to the most recent
committed transaction. Cannot be specified along with QueryAsOfTime.
"""
function get_table_objects(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetTableObjects",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table_objects(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetTableObjects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_temporary_glue_partition_credentials(partition, table_arn)
get_temporary_glue_partition_credentials(partition, table_arn, params::Dict{String,<:Any})
This API is identical to GetTemporaryTableCredentials except that this is used when the
target Data Catalog resource is of type Partition. Lake Formation restricts the permission
of the vended credentials with the same scope down policy which restricts access to a
single Amazon S3 prefix.
# Arguments
- `partition`: A list of partition values identifying a single partition.
- `table_arn`: The ARN of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditContext"`: A structure representing context to access a resource (column names,
query ID, etc).
- `"DurationSeconds"`: The time period, between 900 and 21,600 seconds, for the timeout of
the temporary credentials.
- `"Permissions"`: Filters the request based on the user having been granted a list of
specified permissions on the requested resource(s).
- `"SupportedPermissionTypes"`: A list of supported permission types for the partition.
Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.
"""
function get_temporary_glue_partition_credentials(
Partition, TableArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetTemporaryGluePartitionCredentials",
Dict{String,Any}("Partition" => Partition, "TableArn" => TableArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_temporary_glue_partition_credentials(
Partition,
TableArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetTemporaryGluePartitionCredentials",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Partition" => Partition, "TableArn" => TableArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_temporary_glue_table_credentials(table_arn)
get_temporary_glue_table_credentials(table_arn, params::Dict{String,<:Any})
Allows a caller in a secure environment to assume a role with permission to access Amazon
S3. In order to vend such credentials, Lake Formation assumes the role associated with a
registered location, for example an Amazon S3 bucket, with a scope down policy which
restricts the access to a single prefix.
# Arguments
- `table_arn`: The ARN identifying a table in the Data Catalog for the temporary
credentials request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditContext"`: A structure representing context to access a resource (column names,
query ID, etc).
- `"DurationSeconds"`: The time period, between 900 and 21,600 seconds, for the timeout of
the temporary credentials.
- `"Permissions"`: Filters the request based on the user having been granted a list of
specified permissions on the requested resource(s).
- `"QuerySessionContext"`: A structure used as a protocol between query engines and Lake
Formation or Glue. Contains both a Lake Formation generated authorization identifier and
information from the request's authorization context.
- `"S3Path"`: The Amazon S3 path for the table.
- `"SupportedPermissionTypes"`: A list of supported permission types for the table. Valid
values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.
"""
function get_temporary_glue_table_credentials(
TableArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetTemporaryGlueTableCredentials",
Dict{String,Any}("TableArn" => TableArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_temporary_glue_table_credentials(
TableArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetTemporaryGlueTableCredentials",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableArn" => TableArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_work_unit_results(query_id, work_unit_id, work_unit_token)
get_work_unit_results(query_id, work_unit_id, work_unit_token, params::Dict{String,<:Any})
Returns the work units resulting from the query. Work units can be executed in any order
and in parallel.
# Arguments
- `query_id`: The ID of the plan query operation for which to get results.
- `work_unit_id`: The work unit ID for which to get results. Value generated by enumerating
WorkUnitIdMin to WorkUnitIdMax (inclusive) from the WorkUnitRange in the output of
GetWorkUnits.
- `work_unit_token`: A work token used to query the execution service. Token output from
GetWorkUnits.
"""
function get_work_unit_results(
QueryId, WorkUnitId, WorkUnitToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetWorkUnitResults",
Dict{String,Any}(
"QueryId" => QueryId,
"WorkUnitId" => WorkUnitId,
"WorkUnitToken" => WorkUnitToken,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_work_unit_results(
QueryId,
WorkUnitId,
WorkUnitToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GetWorkUnitResults",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QueryId" => QueryId,
"WorkUnitId" => WorkUnitId,
"WorkUnitToken" => WorkUnitToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_work_units(query_id)
get_work_units(query_id, params::Dict{String,<:Any})
Retrieves the work units generated by the StartQueryPlanning operation.
# Arguments
- `query_id`: The ID of the plan query operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A continuation token, if this is a continuation call.
- `"PageSize"`: The size of each page to get in the Amazon Web Services service call. This
does not affect the number of items returned in the command's output. Setting a smaller
page size results in more calls to the Amazon Web Services service, retrieving fewer items
in each call. This can help prevent the Amazon Web Services service calls from timing out.
"""
function get_work_units(QueryId; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/GetWorkUnits",
Dict{String,Any}("QueryId" => QueryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_work_units(
QueryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GetWorkUnits",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("QueryId" => QueryId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
grant_permissions(permissions, principal, resource)
grant_permissions(permissions, principal, resource, params::Dict{String,<:Any})
Grants permissions to the principal to access metadata in the Data Catalog and data
organized in underlying data storage such as Amazon S3. For information about permissions,
see Security and Access Control to Metadata and Data.
# Arguments
- `permissions`: The permissions granted to the principal on the resource. Lake Formation
defines privileges to grant and revoke access to metadata in the Data Catalog and data
organized in underlying data storage such as Amazon S3. Lake Formation requires that each
principal be authorized to perform a specific task on Lake Formation resources.
- `principal`: The principal to be granted the permissions on the resource. Supported
principals are IAM users or IAM roles, and they are defined by their principal type and
their ARN. Note that if you define a resource with a particular ARN, then later delete, and
recreate a resource with that same ARN, the resource maintains the permissions already
granted.
- `resource`: The resource to which permissions are to be granted. Resources in Lake
Formation are the Data Catalog, databases, and tables.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"PermissionsWithGrantOption"`: Indicates a list of the granted permissions that the
principal may pass to other users. These permissions may only be a subset of the
permissions granted in the Privileges.
"""
function grant_permissions(
Permissions, Principal, Resource; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/GrantPermissions",
Dict{String,Any}(
"Permissions" => Permissions, "Principal" => Principal, "Resource" => Resource
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function grant_permissions(
Permissions,
Principal,
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/GrantPermissions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Permissions" => Permissions,
"Principal" => Principal,
"Resource" => Resource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_cells_filter()
list_data_cells_filter(params::Dict{String,<:Any})
Lists all the data cell filters on a table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of the response.
- `"NextToken"`: A continuation token, if this is a continuation call.
- `"Table"`: A table in the Glue Data Catalog.
"""
function list_data_cells_filter(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/ListDataCellsFilter";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_cells_filter(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListDataCellsFilter",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lake_formation_opt_ins()
list_lake_formation_opt_ins(params::Dict{String,<:Any})
Retrieve the current list of resources and principals that are opt in to enforce Lake
Formation permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve this list.
- `"Principal"`:
- `"Resource"`: A structure for the resource.
"""
function list_lake_formation_opt_ins(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/ListLakeFormationOptIns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lake_formation_opt_ins(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListLakeFormationOptIns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lftags()
list_lftags(params::Dict{String,<:Any})
Lists LF-tags that the requester has permission to view.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve this list.
- `"ResourceShareType"`: If resource share type is ALL, returns both in-account LF-tags and
shared LF-tags that the requester has permission to view. If resource share type is
FOREIGN, returns all share LF-tags that the requester can view. If no resource share type
is passed, lists LF-tags in the given catalog ID that the requester has permission to view.
"""
function list_lftags(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST", "/ListLFTags"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_lftags(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListLFTags",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permissions()
list_permissions(params::Dict{String,<:Any})
Returns a list of the principal permissions on the resource, filtered by the permissions of
the caller. For example, if you are granted an ALTER permission, you are able to see only
the principal permissions for ALTER. This operation returns only those permissions that
have been explicitly granted. For information about permissions, see Security and Access
Control to Metadata and Data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"IncludeRelated"`: Indicates that related permissions should be included in the results.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve this list.
- `"Principal"`: Specifies a principal to filter the permissions returned.
- `"Resource"`: A resource where you will get a list of the principal permissions. This
operation does not support getting privileges on a table with columns. Instead, call this
operation on the table, and the operation returns the table and the table w columns.
- `"ResourceType"`: Specifies a resource type to filter the permissions returned.
"""
function list_permissions(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST", "/ListPermissions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_permissions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListPermissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resources()
list_resources(params::Dict{String,<:Any})
Lists the resources registered to be managed by the Data Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterConditionList"`: Any applicable row-level and/or column-level filtering
conditions for the resources.
- `"MaxResults"`: The maximum number of resource results.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve these
resources.
"""
function list_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST", "/ListResources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListResources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_table_storage_optimizers(database_name, table_name)
list_table_storage_optimizers(database_name, table_name, params::Dict{String,<:Any})
Returns the configuration of all storage optimizers associated with a specified table.
# Arguments
- `database_name`: Name of the database where the table is present.
- `table_name`: Name of the table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The Catalog ID of the table.
- `"MaxResults"`: The number of storage optimizers to return on each call.
- `"NextToken"`: A continuation token, if this is a continuation call.
- `"StorageOptimizerType"`: The specific type of storage optimizers to list. The supported
value is compaction.
"""
function list_table_storage_optimizers(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListTableStorageOptimizers",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_table_storage_optimizers(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/ListTableStorageOptimizers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_transactions()
list_transactions(params::Dict{String,<:Any})
Returns metadata about transactions and their status. To prevent the response from growing
indefinitely, only uncommitted transactions and those available for time-travel queries are
returned. This operation can help you identify uncommitted transactions or to get
information about transactions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The catalog for which to list transactions. Defaults to the account ID of
the caller.
- `"MaxResults"`: The maximum number of transactions to return in a single call.
- `"NextToken"`: A continuation token if this is not the first call to retrieve
transactions.
- `"StatusFilter"`: A filter indicating the status of transactions to return. Options are
ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL.
"""
function list_transactions(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST", "/ListTransactions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_transactions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/ListTransactions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_data_lake_settings(data_lake_settings)
put_data_lake_settings(data_lake_settings, params::Dict{String,<:Any})
Sets the list of data lake administrators who have admin privileges on all resources
managed by Lake Formation. For more information on admin privileges, see Granting Lake
Formation Permissions. This API replaces the current list of data lake admins with the new
list being passed. To add an admin, fetch the current list and add the new admin to that
list and pass that list in this API.
# Arguments
- `data_lake_settings`: A structure representing a list of Lake Formation principals
designated as data lake administrators.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function put_data_lake_settings(
DataLakeSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/PutDataLakeSettings",
Dict{String,Any}("DataLakeSettings" => DataLakeSettings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_data_lake_settings(
DataLakeSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/PutDataLakeSettings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DataLakeSettings" => DataLakeSettings), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_resource(resource_arn)
register_resource(resource_arn, params::Dict{String,<:Any})
Registers the resource as managed by the Data Catalog. To add or update data, Lake
Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know
has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess
service-linked role. When you register the first Amazon S3 path, the service-linked role
and a new inline policy are created on your behalf. Lake Formation adds the first path to
the inline policy and attaches it to the service-linked role. When you register subsequent
paths, Lake Formation adds the path to the existing policy. The following request registers
a new location and gives Lake Formation permission to use the service-linked role to access
that location. ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true If
UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
arn:aws:iam::12345:role/my-data-access-role
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to register.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HybridAccessEnabled"`: Specifies whether the data access of tables pointing to the
location can be managed by both Lake Formation permissions as well as Amazon S3 bucket
policies.
- `"RoleArn"`: The identifier for the role that registers the resource.
- `"UseServiceLinkedRole"`: Designates an Identity and Access Management (IAM)
service-linked role by registering this role with the Data Catalog. A service-linked role
is a unique type of IAM role that is linked directly to Lake Formation. For more
information, see Using Service-Linked Roles for Lake Formation.
- `"WithFederation"`: Whether or not the resource is a federated resource.
"""
function register_resource(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/RegisterResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/RegisterResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_lftags_from_resource(lftags, resource)
remove_lftags_from_resource(lftags, resource, params::Dict{String,<:Any})
Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are
allowed. To tag columns, use the column inclusion list in tableWithColumns to specify
column input.
# Arguments
- `lftags`: The LF-tags to be removed from the resource.
- `resource`: The database, table, or column resource where you want to remove an LF-tag.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
"""
function remove_lftags_from_resource(
LFTags, Resource; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/RemoveLFTagsFromResource",
Dict{String,Any}("LFTags" => LFTags, "Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_lftags_from_resource(
LFTags,
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/RemoveLFTagsFromResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LFTags" => LFTags, "Resource" => Resource), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_permissions(permissions, principal, resource)
revoke_permissions(permissions, principal, resource, params::Dict{String,<:Any})
Revokes permissions to the principal to access metadata in the Data Catalog and data
organized in underlying data storage such as Amazon S3.
# Arguments
- `permissions`: The permissions revoked to the principal on the resource. For information
about permissions, see Security and Access Control to Metadata and Data.
- `principal`: The principal to be revoked permissions on the resource.
- `resource`: The resource to which permissions are to be revoked.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"PermissionsWithGrantOption"`: Indicates a list of permissions for which to revoke the
grant option allowing the principal to pass permissions to other principals.
"""
function revoke_permissions(
Permissions, Principal, Resource; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/RevokePermissions",
Dict{String,Any}(
"Permissions" => Permissions, "Principal" => Principal, "Resource" => Resource
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_permissions(
Permissions,
Principal,
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/RevokePermissions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Permissions" => Permissions,
"Principal" => Principal,
"Resource" => Resource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_databases_by_lftags(expression)
search_databases_by_lftags(expression, params::Dict{String,<:Any})
This operation allows a search on DATABASE resources by TagCondition. This operation is
used by admins who want to grant user permissions on certain TagConditions. Before making a
grant, the admin can use SearchDatabasesByTags to find all resources where the given
TagConditions are valid to verify whether the returned resources can be shared.
# Arguments
- `expression`: A list of conditions (LFTag structures) to search for in database resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve this list.
"""
function search_databases_by_lftags(
Expression; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/SearchDatabasesByLFTags",
Dict{String,Any}("Expression" => Expression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_databases_by_lftags(
Expression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/SearchDatabasesByLFTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Expression" => Expression), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_tables_by_lftags(expression)
search_tables_by_lftags(expression, params::Dict{String,<:Any})
This operation allows a search on TABLE resources by LFTags. This will be used by admins
who want to grant user permissions on certain LF-tags. Before making a grant, the admin can
use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
# Arguments
- `expression`: A list of conditions (LFTag structures) to search for in table resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve this list.
"""
function search_tables_by_lftags(
Expression; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/SearchTablesByLFTags",
Dict{String,Any}("Expression" => Expression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_tables_by_lftags(
Expression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/SearchTablesByLFTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Expression" => Expression), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_query_planning(query_planning_context, query_string)
start_query_planning(query_planning_context, query_string, params::Dict{String,<:Any})
Submits a request to process a query statement. This operation generates work units that
can be retrieved with the GetWorkUnits operation as soon as the query state is
WORKUNITS_AVAILABLE or FINISHED.
# Arguments
- `query_planning_context`: A structure containing information about the query plan.
- `query_string`: A PartiQL query statement used as an input to the planner service.
"""
function start_query_planning(
QueryPlanningContext, QueryString; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/StartQueryPlanning",
Dict{String,Any}(
"QueryPlanningContext" => QueryPlanningContext, "QueryString" => QueryString
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_query_planning(
QueryPlanningContext,
QueryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/StartQueryPlanning",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QueryPlanningContext" => QueryPlanningContext,
"QueryString" => QueryString,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_transaction()
start_transaction(params::Dict{String,<:Any})
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects
that you can use to identify a transaction.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TransactionType"`: Indicates whether this transaction should be read only or read and
write. Writes made using a read-only transaction ID will be rejected. Read-only
transactions do not need to be committed.
"""
function start_transaction(; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST", "/StartTransaction"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function start_transaction(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/StartTransaction",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_cells_filter(table_data)
update_data_cells_filter(table_data, params::Dict{String,<:Any})
Updates a data cell filter.
# Arguments
- `table_data`: A DataCellsFilter structure containing information about the data cells
filter.
"""
function update_data_cells_filter(
TableData; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/UpdateDataCellsFilter",
Dict{String,Any}("TableData" => TableData);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_cells_filter(
TableData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/UpdateDataCellsFilter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableData" => TableData), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_lake_formation_identity_center_configuration()
update_lake_formation_identity_center_configuration(params::Dict{String,<:Any})
Updates the IAM Identity Center connection parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationStatus"`: Allows to enable or disable the IAM Identity Center connection.
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, view definitions, and other control information to manage your Lake Formation
environment.
- `"ExternalFiltering"`: A list of the account IDs of Amazon Web Services accounts of
third-party applications that are allowed to access data managed by Lake Formation.
- `"ShareRecipients"`: A list of Amazon Web Services account IDs or Amazon Web Services
organization/organizational unit ARNs that are allowed to access to access data managed by
Lake Formation. If the ShareRecipients list includes valid values, then the resource share
is updated with the principals you want to have access to the resources. If the
ShareRecipients value is null, both the list of share recipients and the resource share
remain unchanged. If the ShareRecipients value is an empty list, then the existing share
recipients list will be cleared, and the resource share will be deleted.
"""
function update_lake_formation_identity_center_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/UpdateLakeFormationIdentityCenterConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lake_formation_identity_center_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/UpdateLakeFormationIdentityCenterConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_lftag(tag_key)
update_lftag(tag_key, params::Dict{String,<:Any})
Updates the list of possible values for the specified LF-tag key. If the LF-tag does not
exist, the operation throws an EntityNotFoundException. The values in the delete key values
will be deleted from list of possible values. If any value in the delete key values is
attached to a resource, then API errors out with a 400 Exception - \"Update not allowed\".
Untag the attribute before deleting the LF-tag key's value.
# Arguments
- `tag_key`: The key-name for the LF-tag for which to add or delete values.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The identifier for the Data Catalog. By default, the account ID. The Data
Catalog is the persistent metadata store. It contains database definitions, table
definitions, and other control information to manage your Lake Formation environment.
- `"TagValuesToAdd"`: A list of LF-tag values to add from the LF-tag.
- `"TagValuesToDelete"`: A list of LF-tag values to delete from the LF-tag.
"""
function update_lftag(TagKey; aws_config::AbstractAWSConfig=global_aws_config())
return lakeformation(
"POST",
"/UpdateLFTag",
Dict{String,Any}("TagKey" => TagKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lftag(
TagKey, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/UpdateLFTag",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TagKey" => TagKey), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource(resource_arn, role_arn)
update_resource(resource_arn, role_arn, params::Dict{String,<:Any})
Updates the data access role used for vending access to the given (registered) resource in
Lake Formation.
# Arguments
- `resource_arn`: The resource ARN.
- `role_arn`: The new role to use for the given resource registered in Lake Formation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HybridAccessEnabled"`: Specifies whether the data access of tables pointing to the
location can be managed by both Lake Formation permissions as well as Amazon S3 bucket
policies.
- `"WithFederation"`: Whether or not the resource is a federated resource.
"""
function update_resource(
ResourceArn, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lakeformation(
"POST",
"/UpdateResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource(
ResourceArn,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/UpdateResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table_objects(database_name, table_name, write_operations)
update_table_objects(database_name, table_name, write_operations, params::Dict{String,<:Any})
Updates the manifest of Amazon S3 objects that make up the specified governed table.
# Arguments
- `database_name`: The database containing the governed table to update.
- `table_name`: The governed table to update.
- `write_operations`: A list of WriteOperation objects that define an object to add to or
delete from the manifest for a governed table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The catalog containing the governed table to update. Defaults to the
caller’s account ID.
- `"TransactionId"`: The transaction at which to do the write.
"""
function update_table_objects(
DatabaseName,
TableName,
WriteOperations;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/UpdateTableObjects",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"WriteOperations" => WriteOperations,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table_objects(
DatabaseName,
TableName,
WriteOperations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/UpdateTableObjects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"WriteOperations" => WriteOperations,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table_storage_optimizer(database_name, storage_optimizer_config, table_name)
update_table_storage_optimizer(database_name, storage_optimizer_config, table_name, params::Dict{String,<:Any})
Updates the configuration of the storage optimizers for a table.
# Arguments
- `database_name`: Name of the database where the table is present.
- `storage_optimizer_config`: Name of the table for which to enable the storage optimizer.
- `table_name`: Name of the table for which to enable the storage optimizer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The Catalog ID of the table.
"""
function update_table_storage_optimizer(
DatabaseName,
StorageOptimizerConfig,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/UpdateTableStorageOptimizer",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"StorageOptimizerConfig" => StorageOptimizerConfig,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table_storage_optimizer(
DatabaseName,
StorageOptimizerConfig,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lakeformation(
"POST",
"/UpdateTableStorageOptimizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"StorageOptimizerConfig" => StorageOptimizerConfig,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 137504 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lambda
using AWS.Compat
using AWS.UUIDs
"""
add_layer_version_permission(action, layer_name, principal, statement_id, version_number)
add_layer_version_permission(action, layer_name, principal, statement_id, version_number, params::Dict{String,<:Any})
Adds permissions to the resource-based policy of a version of an Lambda layer. Use this
action to grant layer usage permission to other accounts. You can grant permission to a
single account, all accounts in an organization, or all Amazon Web Services accounts. To
revoke permission, call RemoveLayerVersionPermission with the statement ID that you
specified when you added it.
# Arguments
- `action`: The API action that grants access to the layer. For example,
lambda:GetLayerVersion.
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
- `principal`: An account ID, or * to grant layer usage permission to all accounts in an
organization, or all Amazon Web Services accounts (if organizationId is not specified). For
the last case, make sure that you really do want all Amazon Web Services accounts to have
usage permission to this layer.
- `statement_id`: An identifier that distinguishes the policy from others on the same layer
version.
- `version_number`: The version number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OrganizationId"`: With the principal set to *, grant permission to all accounts in the
specified organization.
- `"RevisionId"`: Only update the policy if the revision ID matches the ID specified. Use
this option to avoid modifying a policy that has changed since you last read it.
"""
function add_layer_version_permission(
Action,
LayerName,
Principal,
StatementId,
VersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)/policy",
Dict{String,Any}(
"Action" => Action, "Principal" => Principal, "StatementId" => StatementId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_layer_version_permission(
Action,
LayerName,
Principal,
StatementId,
VersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Action" => Action,
"Principal" => Principal,
"StatementId" => StatementId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_permission(action, function_name, principal, statement_id)
add_permission(action, function_name, principal, statement_id, params::Dict{String,<:Any})
Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services
organization permission to use a function. You can apply the policy at the function level,
or specify a qualifier to restrict access to a single version or alias. If you use a
qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or
alias to invoke the function. Note: Lambda does not support adding policies to version
LATEST. To grant permission to another account, specify the account ID as the Principal. To
grant permission to an organization defined in Organizations, specify the organization ID
as the PrincipalOrgID. For Amazon Web Services, the principal is a domain-style identifier
that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web
Services, you can also specify the ARN of the associated resource as the SourceArn. If you
grant permission to a service principal without specifying the source, other accounts could
potentially configure resources in their account to invoke your Lambda function. This
operation adds a statement to a resource-based permissions policy for the function. For
more information about function policies, see Using resource-based policies for Lambda.
# Arguments
- `action`: The action that the principal can use on the function. For example,
lambda:InvokeFunction or lambda:GetFunction.
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name – my-function (name-only), my-function:v1 (with alias). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
- `principal`: The Amazon Web Service or Amazon Web Services account that invokes the
function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke
the function through that service.
- `statement_id`: A statement identifier that differentiates the statement from others in
the same policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventSourceToken"`: For Alexa Smart Home functions, a token that the invoker must
supply.
- `"FunctionUrlAuthType"`: The type of authentication that your function URL uses. Set to
AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want
to bypass IAM authentication to create a public endpoint. For more information, see
Security and auth model for Lambda function URLs.
- `"PrincipalOrgID"`: The identifier for your organization in Organizations. Use this to
grant permissions to all the Amazon Web Services accounts under this organization.
- `"Qualifier"`: Specify a version or alias to add permissions to a published version of
the function.
- `"RevisionId"`: Update the policy only if the revision ID matches the ID that's
specified. Use this option to avoid modifying a policy that has changed since you last read
it.
- `"SourceAccount"`: For Amazon Web Service, the ID of the Amazon Web Services account that
owns the resource. Use this together with SourceArn to ensure that the specified account
owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and
recreated by another account.
- `"SourceArn"`: For Amazon Web Services, the ARN of the Amazon Web Services resource that
invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. Note that
Lambda configures the comparison using the StringLike operator.
"""
function add_permission(
Action,
FunctionName,
Principal,
StatementId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/policy",
Dict{String,Any}(
"Action" => Action, "Principal" => Principal, "StatementId" => StatementId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_permission(
Action,
FunctionName,
Principal,
StatementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Action" => Action,
"Principal" => Principal,
"StatementId" => StatementId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_alias(function_name, function_version, name)
create_alias(function_name, function_version, name, params::Dict{String,<:Any})
Creates an alias for a Lambda function version. Use aliases to provide clients with a
function identifier that you can update to invoke a different version. You can also map an
alias to split invocation requests between two versions. Use the RoutingConfig parameter to
specify a second version and the percentage of invocation requests that it receives.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
- `function_version`: The function version that the alias invokes.
- `name`: The name of the alias.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the alias.
- `"RoutingConfig"`: The routing configuration of the alias.
"""
function create_alias(
FunctionName, FunctionVersion, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/aliases",
Dict{String,Any}("FunctionVersion" => FunctionVersion, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alias(
FunctionName,
FunctionVersion,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/aliases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FunctionVersion" => FunctionVersion, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_code_signing_config(allowed_publishers)
create_code_signing_config(allowed_publishers, params::Dict{String,<:Any})
Creates a code signing configuration. A code signing configuration defines a list of
allowed signing profiles and defines the code-signing validation policy (action to be taken
if deployment validation checks fail).
# Arguments
- `allowed_publishers`: Signing profiles for this code signing configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CodeSigningPolicies"`: The code signing policies define the actions to take if the
validation checks fail.
- `"Description"`: Descriptive name for this code signing configuration.
"""
function create_code_signing_config(
AllowedPublishers; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2020-04-22/code-signing-configs/",
Dict{String,Any}("AllowedPublishers" => AllowedPublishers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_code_signing_config(
AllowedPublishers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2020-04-22/code-signing-configs/",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AllowedPublishers" => AllowedPublishers), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_source_mapping(function_name)
create_event_source_mapping(function_name, params::Dict{String,<:Any})
Creates a mapping between an event source and an Lambda function. Lambda reads items from
the event source and invokes the function. For details about how to configure different
event sources, see the following topics. Amazon DynamoDB Streams Amazon Kinesis
Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon
DocumentDB The following error handling options are available only for stream sources
(DynamoDB and Kinesis): BisectBatchOnFunctionError – If the function returns an error,
split the batch in two and retry. DestinationConfig – Send discarded records to an
Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds – Discard records
older than the specified age. The default value is infinite (-1). When set to infinite
(-1), failed records are retried until the record expires MaximumRetryAttempts –
Discard records after the specified number of retries. The default value is infinite (-1).
When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor – Process multiple batches from each shard concurrently. For
information about which configuration parameters apply to each event source, see the
following topics. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS
Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon DocumentDB
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– MyFunction. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN –
123456789012:function:MyFunction. The length constraint applies only to the full ARN. If
you specify only the function name, it's limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AmazonManagedKafkaEventSourceConfig"`: Specific configuration settings for an Amazon
Managed Streaming for Apache Kafka (Amazon MSK) event source.
- `"BatchSize"`: The maximum number of records in each batch that Lambda pulls from your
stream or queue and sends to your function. Lambda passes all of the records in the batch
to the function in a single call, up to the payload limit for synchronous invocation (6
MB). Amazon Kinesis – Default 100. Max 10,000. Amazon DynamoDB Streams – Default
100. Max 10,000. Amazon Simple Queue Service – Default 10. For standard queues the max
is 10,000. For FIFO queues the max is 10. Amazon Managed Streaming for Apache Kafka –
Default 100. Max 10,000. Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000. DocumentDB – Default
100. Max 10,000.
- `"BisectBatchOnFunctionError"`: (Kinesis and DynamoDB Streams only) If the function
returns an error, split the batch in two and retry.
- `"DestinationConfig"`: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka
only) A configuration object that specifies the destination of an event after Lambda
processes it.
- `"DocumentDBEventSourceConfig"`: Specific configuration settings for a DocumentDB event
source.
- `"Enabled"`: When true, the event source mapping is active. When false, Lambda pauses
polling and invocation. Default: True
- `"EventSourceArn"`: The Amazon Resource Name (ARN) of the event source. Amazon Kinesis
– The ARN of the data stream or a stream consumer. Amazon DynamoDB Streams – The ARN
of the stream. Amazon Simple Queue Service – The ARN of the queue. Amazon Managed
Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for
cross-account event source mappings). Amazon MQ – The ARN of the broker. Amazon
DocumentDB – The ARN of the DocumentDB change stream.
- `"FilterCriteria"`: An object that defines the filter criteria that determine whether
Lambda should process an event. For more information, see Lambda event filtering.
- `"FunctionResponseTypes"`: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current
response type enums applied to the event source mapping.
- `"MaximumBatchingWindowInSeconds"`: The maximum amount of time, in seconds, that Lambda
spends gathering records before invoking the function. You can configure
MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of
seconds. For streams and Amazon SQS event sources, the default batching window is 0
seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event
sources, the default batching window is 500 ms. Note that because you can only change
MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500
ms default batching window after you have changed it. To restore the default batching
window, you must create a new event source mapping. Related setting: For streams and Amazon
SQS event sources, when you set BatchSize to a value greater than 10, you must set
MaximumBatchingWindowInSeconds to at least 1.
- `"MaximumRecordAgeInSeconds"`: (Kinesis and DynamoDB Streams only) Discard records older
than the specified age. The default value is infinite (-1).
- `"MaximumRetryAttempts"`: (Kinesis and DynamoDB Streams only) Discard records after the
specified number of retries. The default value is infinite (-1). When set to infinite (-1),
failed records are retried until the record expires.
- `"ParallelizationFactor"`: (Kinesis and DynamoDB Streams only) The number of batches to
process from each shard concurrently.
- `"Queues"`: (MQ) The name of the Amazon MQ broker destination queue to consume.
- `"ScalingConfig"`: (Amazon SQS only) The scaling configuration for the event source. For
more information, see Configuring maximum concurrency for Amazon SQS event sources.
- `"SelfManagedEventSource"`: The self-managed Apache Kafka cluster to receive records from.
- `"SelfManagedKafkaEventSourceConfig"`: Specific configuration settings for a self-managed
Apache Kafka event source.
- `"SourceAccessConfigurations"`: An array of authentication protocols or VPC components
required to secure your event source.
- `"StartingPosition"`: The position in a stream from which to start reading. Required for
Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for
Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
- `"StartingPositionTimestamp"`: With StartingPosition set to AT_TIMESTAMP, the time from
which to start reading. StartingPositionTimestamp cannot be in the future.
- `"Topics"`: The name of the Kafka topic.
- `"TumblingWindowInSeconds"`: (Kinesis and DynamoDB Streams only) The duration in seconds
of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds
indicates no tumbling window.
"""
function create_event_source_mapping(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2015-03-31/event-source-mappings/",
Dict{String,Any}("FunctionName" => FunctionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_source_mapping(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/event-source-mappings/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FunctionName" => FunctionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_function(code, function_name, role)
create_function(code, function_name, role, params::Dict{String,<:Any})
Creates a Lambda function. To create a function, you need a deployment package and an
execution role. The deployment package is a .zip file archive or container image that
contains your function code. The execution role grants the function permission to use
Amazon Web Services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request
tracing. If the deployment package is a container image, then you set the package type to
Image. For a container image, the code property must include the URI of a container image
in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
If the deployment package is a .zip file archive, then you set the package type to Zip. For
a .zip file archive, the code property specifies the location of the .zip file. You must
also specify the handler and runtime properties. The code in the deployment package must be
compatible with the target instruction set architecture of the function (x86-64 or arm64).
If you do not specify the architecture, then the default value is x86-64. When you create a
function, Lambda provisions an instance of the function and its supporting resources. If
your function connects to a VPC, this process can take a minute or so. During this time,
you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields
in the response from GetFunctionConfiguration indicate when the function is ready to
invoke. For more information, see Lambda function states. A function has an unpublished
version, and can have published versions and aliases. The unpublished version changes when
you update your function's code and configuration. A published version is a snapshot of
your function code and configuration that can't be changed. An alias is a named resource
that maps to a version, and can be changed to map to a different version. Use the Publish
parameter to create version 1 of your function from its initial configuration. The other
parameters let you configure version-specific and function-level settings. You can modify
version-specific settings later with UpdateFunctionConfiguration. Function-level settings
apply to both the unpublished and published versions of the function, and include tags
(TagResource) and per-function concurrency limits (PutFunctionConcurrency). You can use
code signing if your deployment package is a .zip file archive. To enable code signing for
this function, specify the ARN of a code-signing configuration. When a user attempts to
deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a
valid signature from a trusted publisher. The code-signing configuration includes set of
signing profiles, which define the trusted publishers for this function. If another Amazon
Web Services account or an Amazon Web Service invokes your function, use AddPermission to
grant permission by creating a resource-based Identity and Access Management (IAM) policy.
You can grant permissions at the function level, on a version, or on an alias. To invoke
your function directly, use Invoke. To invoke your function in response to events in other
Amazon Web Services, create an event source mapping (CreateEventSourceMapping), or
configure a function trigger in the other service. For more information, see Invoking
Lambda functions.
# Arguments
- `code`: The code for the function.
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `role`: The Amazon Resource Name (ARN) of the function's execution role.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Architectures"`: The instruction set architecture that the function supports. Enter a
string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
- `"CodeSigningConfigArn"`: To enable code signing for this function, specify the ARN of a
code-signing configuration. A code-signing configuration includes a set of signing
profiles, which define the trusted publishers for this function.
- `"DeadLetterConfig"`: A dead-letter queue configuration that specifies the queue or topic
where Lambda sends asynchronous events when they fail processing. For more information, see
Dead-letter queues.
- `"Description"`: A description of the function.
- `"Environment"`: Environment variables that are accessible from function code during
execution.
- `"EphemeralStorage"`: The size of the function's /tmp directory in MB. The default value
is 512, but can be any whole number between 512 and 10,240 MB. For more information, see
Configuring ephemeral storage (console).
- `"FileSystemConfigs"`: Connection settings for an Amazon EFS file system.
- `"Handler"`: The name of the method within your code that Lambda calls to run your
function. Handler is required if the deployment package is a .zip file archive. The format
includes the file name. It can also include namespaces and other qualifiers, depending on
the runtime. For more information, see Lambda programming model.
- `"ImageConfig"`: Container image configuration values that override the values in the
container image Dockerfile.
- `"KMSKeyArn"`: The ARN of the Key Management Service (KMS) customer managed key that's
used to encrypt your function's environment variables. When Lambda SnapStart is activated,
Lambda also uses this key is to encrypt your function's snapshot. If you deploy your
function using a container image, Lambda also uses this key to encrypt your function when
it's deployed. Note that this is not the same key that's used to protect your container
image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a
customer managed key, Lambda uses a default service key.
- `"Layers"`: A list of function layers to add to the function's execution environment.
Specify each layer by its ARN, including the version.
- `"LoggingConfig"`: The function's Amazon CloudWatch Logs configuration settings.
- `"MemorySize"`: The amount of memory available to the function at runtime. Increasing the
function memory also increases its CPU allocation. The default value is 128 MB. The value
can be any multiple of 1 MB.
- `"PackageType"`: The type of deployment package. Set to Image for container image and set
to Zip for .zip file archive.
- `"Publish"`: Set to true to publish the first version of the function during creation.
- `"Runtime"`: The identifier of the function's runtime. Runtime is required if the
deployment package is a .zip file archive. The following list includes deprecated runtimes.
For more information, see Runtime deprecation policy.
- `"SnapStart"`: The function's SnapStart setting.
- `"Tags"`: A list of tags to apply to the function.
- `"Timeout"`: The amount of time (in seconds) that Lambda allows a function to run before
stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more
information, see Lambda execution environment.
- `"TracingConfig"`: Set Mode to Active to sample and trace a subset of incoming requests
with X-Ray.
- `"VpcConfig"`: For network connectivity to Amazon Web Services resources in a VPC,
specify a list of security groups and subnets in the VPC. When you connect a function to a
VPC, it can access resources and the internet only through that VPC. For more information,
see Configuring a Lambda function to access resources in a VPC.
"""
function create_function(
Code, FunctionName, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2015-03-31/functions",
Dict{String,Any}("Code" => Code, "FunctionName" => FunctionName, "Role" => Role);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_function(
Code,
FunctionName,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/functions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Code" => Code, "FunctionName" => FunctionName, "Role" => Role
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_function_url_config(auth_type, function_name)
create_function_url_config(auth_type, function_name, params::Dict{String,<:Any})
Creates a Lambda function URL with the specified configuration parameters. A function URL
is a dedicated HTTP(S) endpoint that you can use to invoke your function.
# Arguments
- `auth_type`: The type of authentication that your function URL uses. Set to AWS_IAM if
you want to restrict access to authenticated users only. Set to NONE if you want to bypass
IAM authentication to create a public endpoint. For more information, see Security and auth
model for Lambda function URLs.
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cors"`: The cross-origin resource sharing (CORS) settings for your function URL.
- `"InvokeMode"`: Use one of the following options: BUFFERED – This is the default
option. Lambda invokes your function using the Invoke API operation. Invocation results are
available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda
invokes your function using the InvokeWithResponseStream API operation. The maximum
response payload size is 20 MB, however, you can request a quota increase.
- `"Qualifier"`: The alias name.
"""
function create_function_url_config(
AuthType, FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2021-10-31/functions/$(FunctionName)/url",
Dict{String,Any}("AuthType" => AuthType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_function_url_config(
AuthType,
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2021-10-31/functions/$(FunctionName)/url",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AuthType" => AuthType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alias(function_name, name)
delete_alias(function_name, name, params::Dict{String,<:Any})
Deletes a Lambda function alias.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
- `name`: The name of the alias.
"""
function delete_alias(FunctionName, Name; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"DELETE",
"/2015-03-31/functions/$(FunctionName)/aliases/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alias(
FunctionName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2015-03-31/functions/$(FunctionName)/aliases/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_code_signing_config(code_signing_config_arn)
delete_code_signing_config(code_signing_config_arn, params::Dict{String,<:Any})
Deletes the code signing configuration. You can delete the code signing configuration only
if no function is using it.
# Arguments
- `code_signing_config_arn`: The The Amazon Resource Name (ARN) of the code signing
configuration.
"""
function delete_code_signing_config(
CodeSigningConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_code_signing_config(
CodeSigningConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_source_mapping(uuid)
delete_event_source_mapping(uuid, params::Dict{String,<:Any})
Deletes an event source mapping. You can get the identifier of a mapping from the output of
ListEventSourceMappings. When you delete an event source mapping, it enters a Deleting
state and might not be completely deleted for several seconds.
# Arguments
- `uuid`: The identifier of the event source mapping.
"""
function delete_event_source_mapping(
UUID; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2015-03-31/event-source-mappings/$(UUID)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_source_mapping(
UUID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2015-03-31/event-source-mappings/$(UUID)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function(function_name)
delete_function(function_name, params::Dict{String,<:Any})
Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user
to have explicit permissions for DeleteAlias. To delete Lambda event source mappings that
invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and resources that
invoke your function directly, delete the trigger in the service where you originally
configured it.
# Arguments
- `function_name`: The name or ARN of the Lambda function or version. Name formats
Function name – my-function (name-only), my-function:1 (with version). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version to delete. You can't delete a version that an alias
references.
"""
function delete_function(FunctionName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"DELETE",
"/2015-03-31/functions/$(FunctionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2015-03-31/functions/$(FunctionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function_code_signing_config(function_name)
delete_function_code_signing_config(function_name, params::Dict{String,<:Any})
Removes the code signing configuration from the function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
"""
function delete_function_code_signing_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2020-06-30/functions/$(FunctionName)/code-signing-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function_code_signing_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2020-06-30/functions/$(FunctionName)/code-signing-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function_concurrency(function_name)
delete_function_concurrency(function_name, params::Dict{String,<:Any})
Removes a concurrent execution limit from a function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
"""
function delete_function_concurrency(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2017-10-31/functions/$(FunctionName)/concurrency";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function_concurrency(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2017-10-31/functions/$(FunctionName)/concurrency",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function_event_invoke_config(function_name)
delete_function_event_invoke_config(function_name, params::Dict{String,<:Any})
Deletes the configuration for asynchronous invocation for a function, version, or alias. To
configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name - my-function (name-only), my-function:v1 (with alias). Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN -
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: A version number or alias name.
"""
function delete_function_event_invoke_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function_event_invoke_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function_url_config(function_name)
delete_function_url_config(function_name, params::Dict{String,<:Any})
Deletes a Lambda function URL. When you delete a function URL, you can't recover it.
Creating a new function URL results in a different URL address.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: The alias name.
"""
function delete_function_url_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2021-10-31/functions/$(FunctionName)/url";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function_url_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2021-10-31/functions/$(FunctionName)/url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_layer_version(layer_name, version_number)
delete_layer_version(layer_name, version_number, params::Dict{String,<:Any})
Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to
functions. To avoid breaking functions, a copy of the version remains in Lambda until no
functions refer to it.
# Arguments
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
- `version_number`: The version number.
"""
function delete_layer_version(
LayerName, VersionNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_layer_version(
LayerName,
VersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_provisioned_concurrency_config(function_name, qualifier)
delete_provisioned_concurrency_config(function_name, qualifier, params::Dict{String,<:Any})
Deletes the provisioned concurrency configuration for a function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `qualifier`: The version number or alias name.
"""
function delete_provisioned_concurrency_config(
FunctionName, Qualifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency",
Dict{String,Any}("Qualifier" => Qualifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_provisioned_concurrency_config(
FunctionName,
Qualifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Qualifier" => Qualifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_settings()
get_account_settings(params::Dict{String,<:Any})
Retrieves details about your account's limits and usage in an Amazon Web Services Region.
"""
function get_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2016-08-19/account-settings/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2016-08-19/account-settings/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_alias(function_name, name)
get_alias(function_name, name, params::Dict{String,<:Any})
Returns details about a Lambda function alias.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
- `name`: The name of the alias.
"""
function get_alias(FunctionName, Name; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/aliases/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_alias(
FunctionName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/aliases/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_code_signing_config(code_signing_config_arn)
get_code_signing_config(code_signing_config_arn, params::Dict{String,<:Any})
Returns information about the specified code signing configuration.
# Arguments
- `code_signing_config_arn`: The The Amazon Resource Name (ARN) of the code signing
configuration.
"""
function get_code_signing_config(
CodeSigningConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_code_signing_config(
CodeSigningConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_source_mapping(uuid)
get_event_source_mapping(uuid, params::Dict{String,<:Any})
Returns details about an event source mapping. You can get the identifier of a mapping from
the output of ListEventSourceMappings.
# Arguments
- `uuid`: The identifier of the event source mapping.
"""
function get_event_source_mapping(UUID; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/event-source-mappings/$(UUID)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_source_mapping(
UUID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2015-03-31/event-source-mappings/$(UUID)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function(function_name)
get_function(function_name, params::Dict{String,<:Any})
Returns information about the function or function version, with a link to download the
deployment package that's valid for 10 minutes. If you specify a function version, only
details that are specific to that version are returned.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name – my-function (name-only), my-function:v1 (with alias). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version or alias to get details about a published version of the
function.
"""
function get_function(FunctionName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_code_signing_config(function_name)
get_function_code_signing_config(function_name, params::Dict{String,<:Any})
Returns the code signing configuration for the specified function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
"""
function get_function_code_signing_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2020-06-30/functions/$(FunctionName)/code-signing-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_code_signing_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2020-06-30/functions/$(FunctionName)/code-signing-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_concurrency(function_name)
get_function_concurrency(function_name, params::Dict{String,<:Any})
Returns details about the reserved concurrency configuration for a function. To set a
concurrency limit for a function, use PutFunctionConcurrency.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
"""
function get_function_concurrency(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2019-09-30/functions/$(FunctionName)/concurrency";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_concurrency(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2019-09-30/functions/$(FunctionName)/concurrency",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_configuration(function_name)
get_function_configuration(function_name, params::Dict{String,<:Any})
Returns the version-specific settings of a Lambda function or version. The output includes
only options that can vary between versions of a function. To modify these settings, use
UpdateFunctionConfiguration. To get all of a function's details, including function-level
settings, use GetFunction.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name – my-function (name-only), my-function:v1 (with alias). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version or alias to get details about a published version of the
function.
"""
function get_function_configuration(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_configuration(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_event_invoke_config(function_name)
get_function_event_invoke_config(function_name, params::Dict{String,<:Any})
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name - my-function (name-only), my-function:v1 (with alias). Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN -
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: A version number or alias name.
"""
function get_function_event_invoke_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_event_invoke_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_url_config(function_name)
get_function_url_config(function_name, params::Dict{String,<:Any})
Returns details about a Lambda function URL.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: The alias name.
"""
function get_function_url_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2021-10-31/functions/$(FunctionName)/url";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_url_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2021-10-31/functions/$(FunctionName)/url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_layer_version(layer_name, version_number)
get_layer_version(layer_name, version_number, params::Dict{String,<:Any})
Returns information about a version of an Lambda layer, with a link to download the layer
archive that's valid for 10 minutes.
# Arguments
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
- `version_number`: The version number.
"""
function get_layer_version(
LayerName, VersionNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_layer_version(
LayerName,
VersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_layer_version_by_arn(arn)
get_layer_version_by_arn(arn, params::Dict{String,<:Any})
Returns information about a version of an Lambda layer, with a link to download the layer
archive that's valid for 10 minutes.
# Arguments
- `arn`: The ARN of the layer version.
"""
function get_layer_version_by_arn(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2018-10-31/layers?find=LayerVersion",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_layer_version_by_arn(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2018-10-31/layers?find=LayerVersion",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_layer_version_policy(layer_name, version_number)
get_layer_version_policy(layer_name, version_number, params::Dict{String,<:Any})
Returns the permission policy for a version of an Lambda layer. For more information, see
AddLayerVersionPermission.
# Arguments
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
- `version_number`: The version number.
"""
function get_layer_version_policy(
LayerName, VersionNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_layer_version_policy(
LayerName,
VersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(function_name)
get_policy(function_name, params::Dict{String,<:Any})
Returns the resource-based IAM policy for a function, version, or alias.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name – my-function (name-only), my-function:v1 (with alias). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version or alias to get the policy for that resource.
"""
function get_policy(FunctionName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_provisioned_concurrency_config(function_name, qualifier)
get_provisioned_concurrency_config(function_name, qualifier, params::Dict{String,<:Any})
Retrieves the provisioned concurrency configuration for a function's alias or version.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `qualifier`: The version number or alias name.
"""
function get_provisioned_concurrency_config(
FunctionName, Qualifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency",
Dict{String,Any}("Qualifier" => Qualifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_provisioned_concurrency_config(
FunctionName,
Qualifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Qualifier" => Qualifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_runtime_management_config(function_name)
get_runtime_management_config(function_name, params::Dict{String,<:Any})
Retrieves the runtime management configuration for a function's version. If the runtime
update mode is Manual, this includes the ARN of the runtime version and the runtime update
mode. If the runtime update mode is Auto or Function update, this includes the runtime
update mode and null is returned for the ARN. For more information, see Runtime updates.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version of the function. This can be LATEST or a published
version number. If no value is specified, the configuration for the LATEST version is
returned.
"""
function get_runtime_management_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2021-07-20/functions/$(FunctionName)/runtime-management-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_runtime_management_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2021-07-20/functions/$(FunctionName)/runtime-management-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invoke(function_name)
invoke(function_name, params::Dict{String,<:Any})
Invokes a Lambda function. You can invoke a function synchronously (and wait for the
response), or asynchronously. By default, Lambda invokes your function synchronously (i.e.
theInvocationType is RequestResponse). To invoke a function asynchronously, set
InvocationType to Event. Lambda passes the ClientContext object to your function for
synchronous invocations only. For synchronous invocation, details about the function
response, including errors, are included in the response body and headers. For either
invocation type, you can find more information in the execution log and trace. When an
error occurs, your function may be invoked multiple times. Retry behavior varies by error
type, client, event source, and invocation type. For example, if you invoke a function
asynchronously and it returns an error, Lambda executes the function up to two more times.
For more information, see Error handling and automatic retries in Lambda. For asynchronous
invocation, Lambda adds events to a queue before sending them to your function. If your
function does not have enough capacity to keep up with the queue, events may be lost.
Occasionally, your function may receive the same event multiple times, even if no error
occurs. To retain events that were not processed, configure your function with a
dead-letter queue. The status code in the API response doesn't reflect function errors.
Error codes are reserved for errors that prevent your function from executing, such as
permissions errors, quota errors, or issues with your function's code and configuration.
For example, Lambda returns TooManyRequestsException if running the function would cause
you to exceed a concurrency limit at either the account level
(ConcurrentInvocationLimitExceeded) or function level
(ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long timeout,
your client might disconnect during synchronous invocation while it waits for a response.
Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long
connections with timeout or keep-alive settings. This operation requires permission for the
lambda:InvokeFunction action. For details on how to set up permissions for cross-account
invocations, see Granting function access to other accounts.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name – my-function (name-only), my-function:v1 (with alias). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Payload"`: The JSON that you want to provide to your Lambda function as input. You can
enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also
specify a file path. For example, --payload file://payload.json.
- `"Qualifier"`: Specify a version or alias to invoke a published version of the function.
- `"X-Amz-Client-Context"`: Up to 3,583 bytes of base64-encoded data about the invoking
client to pass to the function in the context object. Lambda passes the ClientContext
object to your function for synchronous invocations only.
- `"X-Amz-Invocation-Type"`: Choose from the following options. RequestResponse
(default) – Invoke the function synchronously. Keep the connection open until the
function returns a response or times out. The API response includes the function response
and additional data. Event – Invoke the function asynchronously. Send events that fail
multiple times to the function's dead-letter queue (if one is configured). The API response
only includes a status code. DryRun – Validate parameter values and verify that the
user or role has permission to invoke the function.
- `"X-Amz-Log-Type"`: Set to Tail to include the execution log in the response. Applies to
synchronously invoked functions only.
"""
function invoke(FunctionName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/invocations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/invocations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invoke_async(function_name, invoke_args)
invoke_async(function_name, invoke_args, params::Dict{String,<:Any})
For asynchronous function invocation, use Invoke. Invokes a function asynchronously. If
you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active
tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned
on.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `invoke_args`: The JSON that you want to provide to your Lambda function as input.
"""
function invoke_async(
FunctionName, InvokeArgs; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2014-11-13/functions/$(FunctionName)/invoke-async/",
Dict{String,Any}("InvokeArgs" => InvokeArgs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke_async(
FunctionName,
InvokeArgs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2014-11-13/functions/$(FunctionName)/invoke-async/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InvokeArgs" => InvokeArgs), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invoke_with_response_stream(function_name)
invoke_with_response_stream(function_name, params::Dict{String,<:Any})
Configure your Lambda functions to stream response payloads back to clients. For more
information, see Configuring a Lambda function to stream responses. This operation requires
permission for the lambda:InvokeFunction action. For details on how to set up permissions
for cross-account invocations, see Granting function access to other accounts.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Payload"`: The JSON that you want to provide to your Lambda function as input. You can
enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also
specify a file path. For example, --payload file://payload.json.
- `"Qualifier"`: The alias name.
- `"X-Amz-Client-Context"`: Up to 3,583 bytes of base64-encoded data about the invoking
client to pass to the function in the context object.
- `"X-Amz-Invocation-Type"`: Use one of the following options: RequestResponse (default)
– Invoke the function synchronously. Keep the connection open until the function returns
a response or times out. The API operation response includes the function response and
additional data. DryRun – Validate parameter values and verify that the IAM user or
role has permission to invoke the function.
- `"X-Amz-Log-Type"`: Set to Tail to include the execution log in the response. Applies to
synchronously invoked functions only.
"""
function invoke_with_response_stream(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2021-11-15/functions/$(FunctionName)/response-streaming-invocations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke_with_response_stream(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2021-11-15/functions/$(FunctionName)/response-streaming-invocations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_aliases(function_name)
list_aliases(function_name, params::Dict{String,<:Any})
Returns a list of aliases for a Lambda function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FunctionVersion"`: Specify a function version to only list aliases that invoke that
version.
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: Limit the number of aliases returned.
"""
function list_aliases(FunctionName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/aliases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_aliases(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/aliases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_code_signing_configs()
list_code_signing_configs(params::Dict{String,<:Any})
Returns a list of code signing configurations. A request returns up to 10,000
configurations per call. You can use the MaxItems parameter to return fewer configurations
per call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: Maximum number of items to return.
"""
function list_code_signing_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2020-04-22/code-signing-configs/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_code_signing_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2020-04-22/code-signing-configs/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_source_mappings()
list_event_source_mappings(params::Dict{String,<:Any})
Lists event source mappings. Specify an EventSourceArn to show only event source mappings
for a single event source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventSourceArn"`: The Amazon Resource Name (ARN) of the event source. Amazon Kinesis
– The ARN of the data stream or a stream consumer. Amazon DynamoDB Streams – The ARN
of the stream. Amazon Simple Queue Service – The ARN of the queue. Amazon Managed
Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for
cross-account event source mappings). Amazon MQ – The ARN of the broker. Amazon
DocumentDB – The ARN of the DocumentDB change stream.
- `"FunctionName"`: The name or ARN of the Lambda function. Name formats Function name
– MyFunction. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN –
123456789012:function:MyFunction. The length constraint applies only to the full ARN. If
you specify only the function name, it's limited to 64 characters in length.
- `"Marker"`: A pagination token returned by a previous call.
- `"MaxItems"`: The maximum number of event source mappings to return. Note that
ListEventSourceMappings returns a maximum of 100 items in each response, even if you set
the number higher.
"""
function list_event_source_mappings(; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/event-source-mappings/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_event_source_mappings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2015-03-31/event-source-mappings/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_function_event_invoke_configs(function_name)
list_function_event_invoke_configs(function_name, params::Dict{String,<:Any})
Retrieves a list of configurations for asynchronous invocation for a function. To configure
options for asynchronous invocation, use PutFunctionEventInvokeConfig.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- my-function. Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN -
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: The maximum number of configurations to return.
"""
function list_function_event_invoke_configs(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_function_event_invoke_configs(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_function_url_configs(function_name)
list_function_url_configs(function_name, params::Dict{String,<:Any})
Returns a list of Lambda function URLs for the specified function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: The maximum number of function URLs to return in the response. Note that
ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the
number higher.
"""
function list_function_url_configs(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2021-10-31/functions/$(FunctionName)/urls";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_function_url_configs(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2021-10-31/functions/$(FunctionName)/urls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_functions()
list_functions(params::Dict{String,<:Any})
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda
returns up to 50 functions per call. Set FunctionVersion to ALL to include all published
versions of each function in addition to the unpublished version. The ListFunctions
operation returns a subset of the FunctionConfiguration fields. To get the additional
fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason,
LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use
GetFunction.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FunctionVersion"`: Set to ALL to include entries for all published versions of each
function.
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MasterRegion"`: For Lambda@Edge functions, the Amazon Web Services Region of the master
function. For example, us-east-1 filters the list of functions to include only Lambda@Edge
functions replicated from a master function in US East (N. Virginia). If specified, you
must set FunctionVersion to ALL.
- `"MaxItems"`: The maximum number of functions to return in the response. Note that
ListFunctions returns a maximum of 50 items in each response, even if you set the number
higher.
"""
function list_functions(; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2015-03-31/functions/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_functions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2015-03-31/functions/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_functions_by_code_signing_config(code_signing_config_arn)
list_functions_by_code_signing_config(code_signing_config_arn, params::Dict{String,<:Any})
List the functions that use the specified code signing configuration. You can use this
method prior to deleting a code signing configuration, to verify that no functions are
using it.
# Arguments
- `code_signing_config_arn`: The The Amazon Resource Name (ARN) of the code signing
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: Maximum number of items to return.
"""
function list_functions_by_code_signing_config(
CodeSigningConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)/functions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_functions_by_code_signing_config(
CodeSigningConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)/functions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_layer_versions(layer_name)
list_layer_versions(layer_name, params::Dict{String,<:Any})
Lists the versions of an Lambda layer. Versions that have been deleted aren't listed.
Specify a runtime identifier to list only versions that indicate that they're compatible
with that runtime. Specify a compatible architecture to include only layer versions that
are compatible with that architecture.
# Arguments
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CompatibleArchitecture"`: The compatible instruction set architecture.
- `"CompatibleRuntime"`: A runtime identifier. For example, java21. The following list
includes deprecated runtimes. For more information, see Runtime deprecation policy.
- `"Marker"`: A pagination token returned by a previous call.
- `"MaxItems"`: The maximum number of versions to return.
"""
function list_layer_versions(LayerName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2018-10-31/layers/$(LayerName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_layer_versions(
LayerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2018-10-31/layers/$(LayerName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_layers()
list_layers(params::Dict{String,<:Any})
Lists Lambda layers and shows information about the latest version of each. Specify a
runtime identifier to list only layers that indicate that they're compatible with that
runtime. Specify a compatible architecture to include only layers that are compatible with
that instruction set architecture.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CompatibleArchitecture"`: The compatible instruction set architecture.
- `"CompatibleRuntime"`: A runtime identifier. For example, java21. The following list
includes deprecated runtimes. For more information, see Runtime deprecation policy.
- `"Marker"`: A pagination token returned by a previous call.
- `"MaxItems"`: The maximum number of layers to return.
"""
function list_layers(; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET", "/2018-10-31/layers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_layers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2018-10-31/layers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioned_concurrency_configs(function_name)
list_provisioned_concurrency_configs(function_name, params::Dict{String,<:Any})
Retrieves a list of provisioned concurrency configurations for a function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: Specify a number to limit the number of configurations returned.
"""
function list_provisioned_concurrency_configs(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency?List=ALL";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioned_concurrency_configs(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency?List=ALL",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(arn)
list_tags(arn, params::Dict{String,<:Any})
Returns a function's tags. You can also view tags with GetFunction.
# Arguments
- `arn`: The function's Amazon Resource Name (ARN). Note: Lambda does not support adding
tags to aliases or versions.
"""
function list_tags(ARN; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"GET",
"/2017-03-31/tags/$(ARN)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
ARN, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2017-03-31/tags/$(ARN)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_versions_by_function(function_name)
list_versions_by_function(function_name, params::Dict{String,<:Any})
Returns a list of versions, with the version-specific configuration of each. Lambda returns
up to 50 versions per call.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"MaxItems"`: The maximum number of versions to return. Note that ListVersionsByFunction
returns a maximum of 50 items in each response, even if you set the number higher.
"""
function list_versions_by_function(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_versions_by_function(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"GET",
"/2015-03-31/functions/$(FunctionName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_layer_version(content, layer_name)
publish_layer_version(content, layer_name, params::Dict{String,<:Any})
Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the
same layer name, a new version is created. Add layers to your function with CreateFunction
or UpdateFunctionConfiguration.
# Arguments
- `content`: The function layer archive.
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CompatibleArchitectures"`: A list of compatible instruction set architectures.
- `"CompatibleRuntimes"`: A list of compatible function runtimes. Used for filtering with
ListLayers and ListLayerVersions. The following list includes deprecated runtimes. For more
information, see Runtime deprecation policy.
- `"Description"`: The description of the version.
- `"LicenseInfo"`: The layer's software license. It can be any of the following: An SPDX
license identifier. For example, MIT. The URL of a license hosted on the internet. For
example, https://opensource.org/licenses/MIT. The full text of the license.
"""
function publish_layer_version(
Content, LayerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2018-10-31/layers/$(LayerName)/versions",
Dict{String,Any}("Content" => Content);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_layer_version(
Content,
LayerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2018-10-31/layers/$(LayerName)/versions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Content" => Content), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_version(function_name)
publish_version(function_name, params::Dict{String,<:Any})
Creates a version from the current code and configuration of a function. Use versions to
create a snapshot of your function code and configuration that doesn't change. Lambda
doesn't publish a version if the function's configuration and code haven't changed since
the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the
function before publishing a version. Clients can invoke versions directly or with an
alias. To create an alias, use CreateAlias.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CodeSha256"`: Only publish a version if the hash value matches the value that's
specified. Use this option to avoid publishing a version if the function code has changed
since you last updated it. You can get the hash for the version that you uploaded from the
output of UpdateFunctionCode.
- `"Description"`: A description for the version to override the description in the
function configuration.
- `"RevisionId"`: Only update the function if the revision ID matches the ID that's
specified. Use this option to avoid publishing a version if the function configuration has
changed since you last updated it.
"""
function publish_version(FunctionName; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_version(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2015-03-31/functions/$(FunctionName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_function_code_signing_config(code_signing_config_arn, function_name)
put_function_code_signing_config(code_signing_config_arn, function_name, params::Dict{String,<:Any})
Update the code signing configuration for the function. Changes to the code signing
configuration take effect the next time a user tries to deploy a code package to the
function.
# Arguments
- `code_signing_config_arn`: The The Amazon Resource Name (ARN) of the code signing
configuration.
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
"""
function put_function_code_signing_config(
CodeSigningConfigArn, FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2020-06-30/functions/$(FunctionName)/code-signing-config",
Dict{String,Any}("CodeSigningConfigArn" => CodeSigningConfigArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_function_code_signing_config(
CodeSigningConfigArn,
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2020-06-30/functions/$(FunctionName)/code-signing-config",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CodeSigningConfigArn" => CodeSigningConfigArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_function_concurrency(function_name, reserved_concurrent_executions)
put_function_concurrency(function_name, reserved_concurrent_executions, params::Dict{String,<:Any})
Sets the maximum number of simultaneous executions for a function, and reserves capacity
for that concurrency level. Concurrency settings apply to the function as a whole,
including all published versions and the unpublished version. Reserving concurrency both
ensures that your function has capacity to process the specified number of events
simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the
current setting for a function. Use GetAccountSettings to see your Regional concurrency
limit. You can reserve concurrency for as many functions as you like, as long as you leave
at least 100 simultaneous executions unreserved for functions that aren't configured with a
per-function limit. For more information, see Lambda function scaling.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `reserved_concurrent_executions`: The number of simultaneous executions to reserve for
the function.
"""
function put_function_concurrency(
FunctionName,
ReservedConcurrentExecutions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2017-10-31/functions/$(FunctionName)/concurrency",
Dict{String,Any}("ReservedConcurrentExecutions" => ReservedConcurrentExecutions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_function_concurrency(
FunctionName,
ReservedConcurrentExecutions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2017-10-31/functions/$(FunctionName)/concurrency",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservedConcurrentExecutions" => ReservedConcurrentExecutions
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_function_event_invoke_config(function_name)
put_function_event_invoke_config(function_name, params::Dict{String,<:Any})
Configures options for asynchronous invocation on a function, version, or alias. If a
configuration already exists for a function, version, or alias, this operation overwrites
it. If you exclude any settings, they are removed. To set one option without affecting
existing settings for other options, use UpdateFunctionEventInvokeConfig. By default,
Lambda retries an asynchronous invocation twice if the function returns an error. It
retains events in a queue for up to six hours. When an event fails all processing attempts
or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain
discarded events, configure a dead-letter queue with UpdateFunctionConfiguration. To send
an invocation record to a queue, topic, function, or event bus, specify a destination. You
can configure separate destinations for successful invocations (on-success) and events that
fail all processing attempts (on-failure). You can configure destinations in addition to or
instead of a dead-letter queue.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name - my-function (name-only), my-function:v1 (with alias). Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN -
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationConfig"`: A destination for events after they have been sent to a function
for processing. Destinations Function - The Amazon Resource Name (ARN) of a Lambda
function. Queue - The ARN of a standard SQS queue. Topic - The ARN of a standard SNS
topic. Event Bus - The ARN of an Amazon EventBridge event bus.
- `"MaximumEventAgeInSeconds"`: The maximum age of a request that Lambda sends to a
function for processing.
- `"MaximumRetryAttempts"`: The maximum number of times to retry when the function returns
an error.
- `"Qualifier"`: A version number or alias name.
"""
function put_function_event_invoke_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_function_event_invoke_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_provisioned_concurrency_config(function_name, provisioned_concurrent_executions, qualifier)
put_provisioned_concurrency_config(function_name, provisioned_concurrent_executions, qualifier, params::Dict{String,<:Any})
Adds a provisioned concurrency configuration to a function's alias or version.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `provisioned_concurrent_executions`: The amount of provisioned concurrency to allocate
for the version or alias.
- `qualifier`: The version number or alias name.
"""
function put_provisioned_concurrency_config(
FunctionName,
ProvisionedConcurrentExecutions,
Qualifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency",
Dict{String,Any}(
"ProvisionedConcurrentExecutions" => ProvisionedConcurrentExecutions,
"Qualifier" => Qualifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_provisioned_concurrency_config(
FunctionName,
ProvisionedConcurrentExecutions,
Qualifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2019-09-30/functions/$(FunctionName)/provisioned-concurrency",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProvisionedConcurrentExecutions" => ProvisionedConcurrentExecutions,
"Qualifier" => Qualifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_runtime_management_config(function_name, update_runtime_on)
put_runtime_management_config(function_name, update_runtime_on, params::Dict{String,<:Any})
Sets the runtime management configuration for a function's version. For more information,
see Runtime updates.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
- `update_runtime_on`: Specify the runtime update mode. Auto (default) - Automatically
update to the most recent and secure runtime version using a Two-phase runtime version
rollout. This is the best choice for most customers to ensure they always benefit from
runtime updates. Function update - Lambda updates the runtime of your function to the
most recent and secure runtime version when you update your function. This approach
synchronizes runtime updates with function deployments, giving you control over when
runtime updates are applied and allowing you to detect and mitigate rare runtime update
incompatibilities early. When using this setting, you need to regularly update your
functions to keep their runtime up-to-date. Manual - You specify a runtime version in
your function configuration. The function will use this runtime version indefinitely. In
the rare case where a new runtime version is incompatible with an existing function, this
allows you to roll back your function to an earlier runtime version. For more information,
see Roll back a runtime version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version of the function. This can be LATEST or a published
version number. If no value is specified, the configuration for the LATEST version is
returned.
- `"RuntimeVersionArn"`: The ARN of the runtime version you want the function to use. This
is only required if you're using the Manual runtime update mode.
"""
function put_runtime_management_config(
FunctionName, UpdateRuntimeOn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2021-07-20/functions/$(FunctionName)/runtime-management-config",
Dict{String,Any}("UpdateRuntimeOn" => UpdateRuntimeOn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_runtime_management_config(
FunctionName,
UpdateRuntimeOn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2021-07-20/functions/$(FunctionName)/runtime-management-config",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("UpdateRuntimeOn" => UpdateRuntimeOn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_layer_version_permission(layer_name, statement_id, version_number)
remove_layer_version_permission(layer_name, statement_id, version_number, params::Dict{String,<:Any})
Removes a statement from the permissions policy for a version of an Lambda layer. For more
information, see AddLayerVersionPermission.
# Arguments
- `layer_name`: The name or Amazon Resource Name (ARN) of the layer.
- `statement_id`: The identifier that was specified when the statement was added.
- `version_number`: The version number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RevisionId"`: Only update the policy if the revision ID matches the ID specified. Use
this option to avoid modifying a policy that has changed since you last read it.
"""
function remove_layer_version_permission(
LayerName, StatementId, VersionNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)/policy/$(StatementId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_layer_version_permission(
LayerName,
StatementId,
VersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2018-10-31/layers/$(LayerName)/versions/$(VersionNumber)/policy/$(StatementId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_permission(function_name, statement_id)
remove_permission(function_name, statement_id, params::Dict{String,<:Any})
Revokes function-use permission from an Amazon Web Service or another Amazon Web Services
account. You can get the ID of the statement from the output of GetPolicy.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name – my-function (name-only), my-function:v1 (with alias). Function ARN
– arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
- `statement_id`: Statement ID of the permission to remove.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qualifier"`: Specify a version or alias to remove permissions from a published version
of the function.
- `"RevisionId"`: Update the policy only if the revision ID matches the ID that's
specified. Use this option to avoid modifying a policy that has changed since you last read
it.
"""
function remove_permission(
FunctionName, StatementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"DELETE",
"/2015-03-31/functions/$(FunctionName)/policy/$(StatementId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_permission(
FunctionName,
StatementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2015-03-31/functions/$(FunctionName)/policy/$(StatementId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})
Adds tags to a function.
# Arguments
- `arn`: The function's Amazon Resource Name (ARN).
- `tags`: A list of tags to apply to the function.
"""
function tag_resource(ARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"POST",
"/2017-03-31/tags/$(ARN)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ARN,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2017-03-31/tags/$(ARN)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(arn, tag_keys)
untag_resource(arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a function.
# Arguments
- `arn`: The function's Amazon Resource Name (ARN).
- `tag_keys`: A list of tag keys to remove from the function.
"""
function untag_resource(ARN, tagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"DELETE",
"/2017-03-31/tags/$(ARN)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ARN,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"DELETE",
"/2017-03-31/tags/$(ARN)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_alias(function_name, name)
update_alias(function_name, name, params::Dict{String,<:Any})
Updates the configuration of a Lambda function alias.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
- MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to
the full ARN. If you specify only the function name, it is limited to 64 characters in
length.
- `name`: The name of the alias.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the alias.
- `"FunctionVersion"`: The function version that the alias invokes.
- `"RevisionId"`: Only update the alias if the revision ID matches the ID that's specified.
Use this option to avoid modifying an alias that has changed since you last read it.
- `"RoutingConfig"`: The routing configuration of the alias.
"""
function update_alias(FunctionName, Name; aws_config::AbstractAWSConfig=global_aws_config())
return lambda(
"PUT",
"/2015-03-31/functions/$(FunctionName)/aliases/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_alias(
FunctionName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2015-03-31/functions/$(FunctionName)/aliases/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_code_signing_config(code_signing_config_arn)
update_code_signing_config(code_signing_config_arn, params::Dict{String,<:Any})
Update the code signing configuration. Changes to the code signing configuration take
effect the next time a user tries to deploy a code package to the function.
# Arguments
- `code_signing_config_arn`: The The Amazon Resource Name (ARN) of the code signing
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedPublishers"`: Signing profiles for this code signing configuration.
- `"CodeSigningPolicies"`: The code signing policy.
- `"Description"`: Descriptive name for this code signing configuration.
"""
function update_code_signing_config(
CodeSigningConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_code_signing_config(
CodeSigningConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2020-04-22/code-signing-configs/$(CodeSigningConfigArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_source_mapping(uuid)
update_event_source_mapping(uuid, params::Dict{String,<:Any})
Updates an event source mapping. You can change the function that Lambda invokes, or pause
invocation and resume later from the same location. For details about how to configure
different event sources, see the following topics. Amazon DynamoDB Streams Amazon
Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka
Amazon DocumentDB The following error handling options are available only for stream
sources (DynamoDB and Kinesis): BisectBatchOnFunctionError – If the function returns
an error, split the batch in two and retry. DestinationConfig – Send discarded records
to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds – Discard
records older than the specified age. The default value is infinite (-1). When set to
infinite (-1), failed records are retried until the record expires MaximumRetryAttempts
– Discard records after the specified number of retries. The default value is infinite
(-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor – Process multiple batches from each shard concurrently. For
information about which configuration parameters apply to each event source, see the
following topics. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS
Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon DocumentDB
# Arguments
- `uuid`: The identifier of the event source mapping.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BatchSize"`: The maximum number of records in each batch that Lambda pulls from your
stream or queue and sends to your function. Lambda passes all of the records in the batch
to the function in a single call, up to the payload limit for synchronous invocation (6
MB). Amazon Kinesis – Default 100. Max 10,000. Amazon DynamoDB Streams – Default
100. Max 10,000. Amazon Simple Queue Service – Default 10. For standard queues the max
is 10,000. For FIFO queues the max is 10. Amazon Managed Streaming for Apache Kafka –
Default 100. Max 10,000. Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000. DocumentDB – Default
100. Max 10,000.
- `"BisectBatchOnFunctionError"`: (Kinesis and DynamoDB Streams only) If the function
returns an error, split the batch in two and retry.
- `"DestinationConfig"`: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka
only) A configuration object that specifies the destination of an event after Lambda
processes it.
- `"DocumentDBEventSourceConfig"`: Specific configuration settings for a DocumentDB event
source.
- `"Enabled"`: When true, the event source mapping is active. When false, Lambda pauses
polling and invocation. Default: True
- `"FilterCriteria"`: An object that defines the filter criteria that determine whether
Lambda should process an event. For more information, see Lambda event filtering.
- `"FunctionName"`: The name or ARN of the Lambda function. Name formats Function name
– MyFunction. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN –
123456789012:function:MyFunction. The length constraint applies only to the full ARN. If
you specify only the function name, it's limited to 64 characters in length.
- `"FunctionResponseTypes"`: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current
response type enums applied to the event source mapping.
- `"MaximumBatchingWindowInSeconds"`: The maximum amount of time, in seconds, that Lambda
spends gathering records before invoking the function. You can configure
MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of
seconds. For streams and Amazon SQS event sources, the default batching window is 0
seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event
sources, the default batching window is 500 ms. Note that because you can only change
MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500
ms default batching window after you have changed it. To restore the default batching
window, you must create a new event source mapping. Related setting: For streams and Amazon
SQS event sources, when you set BatchSize to a value greater than 10, you must set
MaximumBatchingWindowInSeconds to at least 1.
- `"MaximumRecordAgeInSeconds"`: (Kinesis and DynamoDB Streams only) Discard records older
than the specified age. The default value is infinite (-1).
- `"MaximumRetryAttempts"`: (Kinesis and DynamoDB Streams only) Discard records after the
specified number of retries. The default value is infinite (-1). When set to infinite (-1),
failed records are retried until the record expires.
- `"ParallelizationFactor"`: (Kinesis and DynamoDB Streams only) The number of batches to
process from each shard concurrently.
- `"ScalingConfig"`: (Amazon SQS only) The scaling configuration for the event source. For
more information, see Configuring maximum concurrency for Amazon SQS event sources.
- `"SourceAccessConfigurations"`: An array of authentication protocols or VPC components
required to secure your event source.
- `"TumblingWindowInSeconds"`: (Kinesis and DynamoDB Streams only) The duration in seconds
of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds
indicates no tumbling window.
"""
function update_event_source_mapping(
UUID; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2015-03-31/event-source-mappings/$(UUID)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_source_mapping(
UUID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2015-03-31/event-source-mappings/$(UUID)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_function_code(function_name)
update_function_code(function_name, params::Dict{String,<:Any})
Updates a Lambda function's code. If code signing is enabled for the function, the code
package must be signed by a trusted publisher. For more information, see Configuring code
signing for Lambda. If the function's package type is Image, then you must specify the code
package in ImageUri as the URI of a container image in the Amazon ECR registry. If the
function's package type is Zip, then you must specify the deployment package as a .zip file
archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also
provide the function code inline using the ZipFile field. The code in the deployment
package must be compatible with the target instruction set architecture of the function
(x86-64 or arm64). The function's code is locked when you publish a version. You can't
modify the code of a published version, only the unpublished version. For a function
defined as a container image, Lambda resolves the image tag to an image digest. In Amazon
ECR, if you update the image tag to a new image, Lambda does not automatically update the
function.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Architectures"`: The instruction set architecture that the function supports. Enter a
string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
- `"DryRun"`: Set to true to validate the request parameters and access permissions without
modifying the function code.
- `"ImageUri"`: URI of a container image in the Amazon ECR registry. Do not use for a
function defined with a .zip file archive.
- `"Publish"`: Set to true to publish a new version of the function after updating the
code. This has the same effect as calling PublishVersion separately.
- `"RevisionId"`: Update the function only if the revision ID matches the ID that's
specified. Use this option to avoid modifying a function that has changed since you last
read it.
- `"S3Bucket"`: An Amazon S3 bucket in the same Amazon Web Services Region as your
function. The bucket can be in a different Amazon Web Services account. Use only with a
function defined with a .zip file archive deployment package.
- `"S3Key"`: The Amazon S3 key of the deployment package. Use only with a function defined
with a .zip file archive deployment package.
- `"S3ObjectVersion"`: For versioned objects, the version of the deployment package object
to use.
- `"ZipFile"`: The base64-encoded contents of the deployment package. Amazon Web Services
SDK and CLI clients handle the encoding for you. Use only with a function defined with a
.zip file archive deployment package.
"""
function update_function_code(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2015-03-31/functions/$(FunctionName)/code";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_function_code(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2015-03-31/functions/$(FunctionName)/code",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_function_configuration(function_name)
update_function_configuration(function_name, params::Dict{String,<:Any})
Modify the version-specific settings of a Lambda function. When you update a function,
Lambda provisions an instance of the function and its supporting resources. If your
function connects to a VPC, this process can take a minute. During this time, you can't
modify the function, but you can still invoke it. The LastUpdateStatus,
LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from
GetFunctionConfiguration indicate when the update is complete and the function is
processing events with the new configuration. For more information, see Lambda function
states. These settings can vary between versions of a function and are locked when you
publish a version. You can't modify the configuration of a published version, only the
unpublished version. To configure function concurrency, use PutFunctionConcurrency. To
grant invoke permissions to an Amazon Web Services account or Amazon Web Service, use
AddPermission.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeadLetterConfig"`: A dead-letter queue configuration that specifies the queue or topic
where Lambda sends asynchronous events when they fail processing. For more information, see
Dead-letter queues.
- `"Description"`: A description of the function.
- `"Environment"`: Environment variables that are accessible from function code during
execution.
- `"EphemeralStorage"`: The size of the function's /tmp directory in MB. The default value
is 512, but can be any whole number between 512 and 10,240 MB. For more information, see
Configuring ephemeral storage (console).
- `"FileSystemConfigs"`: Connection settings for an Amazon EFS file system.
- `"Handler"`: The name of the method within your code that Lambda calls to run your
function. Handler is required if the deployment package is a .zip file archive. The format
includes the file name. It can also include namespaces and other qualifiers, depending on
the runtime. For more information, see Lambda programming model.
- `"ImageConfig"`: Container image configuration values that override the values in the
container image Docker file.
- `"KMSKeyArn"`: The ARN of the Key Management Service (KMS) customer managed key that's
used to encrypt your function's environment variables. When Lambda SnapStart is activated,
Lambda also uses this key is to encrypt your function's snapshot. If you deploy your
function using a container image, Lambda also uses this key to encrypt your function when
it's deployed. Note that this is not the same key that's used to protect your container
image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a
customer managed key, Lambda uses a default service key.
- `"Layers"`: A list of function layers to add to the function's execution environment.
Specify each layer by its ARN, including the version.
- `"LoggingConfig"`: The function's Amazon CloudWatch Logs configuration settings.
- `"MemorySize"`: The amount of memory available to the function at runtime. Increasing the
function memory also increases its CPU allocation. The default value is 128 MB. The value
can be any multiple of 1 MB.
- `"RevisionId"`: Update the function only if the revision ID matches the ID that's
specified. Use this option to avoid modifying a function that has changed since you last
read it.
- `"Role"`: The Amazon Resource Name (ARN) of the function's execution role.
- `"Runtime"`: The identifier of the function's runtime. Runtime is required if the
deployment package is a .zip file archive. The following list includes deprecated runtimes.
For more information, see Runtime deprecation policy.
- `"SnapStart"`: The function's SnapStart setting.
- `"Timeout"`: The amount of time (in seconds) that Lambda allows a function to run before
stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more
information, see Lambda execution environment.
- `"TracingConfig"`: Set Mode to Active to sample and trace a subset of incoming requests
with X-Ray.
- `"VpcConfig"`: For network connectivity to Amazon Web Services resources in a VPC,
specify a list of security groups and subnets in the VPC. When you connect a function to a
VPC, it can access resources and the internet only through that VPC. For more information,
see Configuring a Lambda function to access resources in a VPC.
"""
function update_function_configuration(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2015-03-31/functions/$(FunctionName)/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_function_configuration(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2015-03-31/functions/$(FunctionName)/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_function_event_invoke_config(function_name)
update_function_event_invoke_config(function_name, params::Dict{String,<:Any})
Updates the configuration for asynchronous invocation for a function, version, or alias. To
configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
# Arguments
- `function_name`: The name or ARN of the Lambda function, version, or alias. Name formats
Function name - my-function (name-only), my-function:v1 (with alias). Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN -
123456789012:function:my-function. You can append a version number or alias to any of the
formats. The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationConfig"`: A destination for events after they have been sent to a function
for processing. Destinations Function - The Amazon Resource Name (ARN) of a Lambda
function. Queue - The ARN of a standard SQS queue. Topic - The ARN of a standard SNS
topic. Event Bus - The ARN of an Amazon EventBridge event bus.
- `"MaximumEventAgeInSeconds"`: The maximum age of a request that Lambda sends to a
function for processing.
- `"MaximumRetryAttempts"`: The maximum number of times to retry when the function returns
an error.
- `"Qualifier"`: A version number or alias name.
"""
function update_function_event_invoke_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"POST",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_function_event_invoke_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"POST",
"/2019-09-25/functions/$(FunctionName)/event-invoke-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_function_url_config(function_name)
update_function_url_config(function_name, params::Dict{String,<:Any})
Updates the configuration for a Lambda function URL.
# Arguments
- `function_name`: The name or ARN of the Lambda function. Name formats Function name
– my-function. Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN –
123456789012:function:my-function. The length constraint applies only to the full ARN. If
you specify only the function name, it is limited to 64 characters in length.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthType"`: The type of authentication that your function URL uses. Set to AWS_IAM if
you want to restrict access to authenticated users only. Set to NONE if you want to bypass
IAM authentication to create a public endpoint. For more information, see Security and auth
model for Lambda function URLs.
- `"Cors"`: The cross-origin resource sharing (CORS) settings for your function URL.
- `"InvokeMode"`: Use one of the following options: BUFFERED – This is the default
option. Lambda invokes your function using the Invoke API operation. Invocation results are
available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda
invokes your function using the InvokeWithResponseStream API operation. The maximum
response payload size is 20 MB, however, you can request a quota increase.
- `"Qualifier"`: The alias name.
"""
function update_function_url_config(
FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lambda(
"PUT",
"/2021-10-31/functions/$(FunctionName)/url";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_function_url_config(
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lambda(
"PUT",
"/2021-10-31/functions/$(FunctionName)/url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 15656 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: launch_wizard
using AWS.Compat
using AWS.UUIDs
"""
create_deployment(deployment_pattern_name, name, specifications, workload_name)
create_deployment(deployment_pattern_name, name, specifications, workload_name, params::Dict{String,<:Any})
Creates a deployment for the given workload. Deployments created by this operation are not
available in the Launch Wizard console to use the Clone deployment action on.
# Arguments
- `deployment_pattern_name`: The name of the deployment pattern supported by a given
workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported
values for this parameter.
- `name`: The name of the deployment.
- `specifications`: The settings specified for the deployment. These settings define how to
deploy and configure your resources created by the deployment. For more information about
the specifications required for creating a deployment for a SAP workload, see SAP
deployment specifications. To retrieve the specifications required to create a deployment
for other workloads, use the GetWorkloadDeploymentPattern operation.
- `workload_name`: The name of the workload. You can use the ListWorkloads operation to
discover supported values for this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dryRun"`: Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have the required
permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
- `"tags"`: The tags to add to the deployment.
"""
function create_deployment(
deploymentPatternName,
name,
specifications,
workloadName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/createDeployment",
Dict{String,Any}(
"deploymentPatternName" => deploymentPatternName,
"name" => name,
"specifications" => specifications,
"workloadName" => workloadName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
deploymentPatternName,
name,
specifications,
workloadName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/createDeployment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"deploymentPatternName" => deploymentPatternName,
"name" => name,
"specifications" => specifications,
"workloadName" => workloadName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_deployment(deployment_id)
delete_deployment(deployment_id, params::Dict{String,<:Any})
Deletes a deployment.
# Arguments
- `deployment_id`: The ID of the deployment.
"""
function delete_deployment(deploymentId; aws_config::AbstractAWSConfig=global_aws_config())
return launch_wizard(
"POST",
"/deleteDeployment",
Dict{String,Any}("deploymentId" => deploymentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_deployment(
deploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/deleteDeployment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("deploymentId" => deploymentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployment(deployment_id)
get_deployment(deployment_id, params::Dict{String,<:Any})
Returns information about the deployment.
# Arguments
- `deployment_id`: The ID of the deployment.
"""
function get_deployment(deploymentId; aws_config::AbstractAWSConfig=global_aws_config())
return launch_wizard(
"POST",
"/getDeployment",
Dict{String,Any}("deploymentId" => deploymentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployment(
deploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/getDeployment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("deploymentId" => deploymentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workload(workload_name)
get_workload(workload_name, params::Dict{String,<:Any})
Returns information about a workload.
# Arguments
- `workload_name`: The name of the workload.
"""
function get_workload(workloadName; aws_config::AbstractAWSConfig=global_aws_config())
return launch_wizard(
"POST",
"/getWorkload",
Dict{String,Any}("workloadName" => workloadName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workload(
workloadName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/getWorkload",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workloadName" => workloadName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workload_deployment_pattern(deployment_pattern_name, workload_name)
get_workload_deployment_pattern(deployment_pattern_name, workload_name, params::Dict{String,<:Any})
Returns details for a given workload and deployment pattern, including the available
specifications. You can use the ListWorkloads operation to discover the available workload
names and the ListWorkloadDeploymentPatterns operation to discover the available deployment
pattern names of a given workload.
# Arguments
- `deployment_pattern_name`: The name of the deployment pattern.
- `workload_name`: The name of the workload.
"""
function get_workload_deployment_pattern(
deploymentPatternName, workloadName; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"POST",
"/getWorkloadDeploymentPattern",
Dict{String,Any}(
"deploymentPatternName" => deploymentPatternName, "workloadName" => workloadName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workload_deployment_pattern(
deploymentPatternName,
workloadName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/getWorkloadDeploymentPattern",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"deploymentPatternName" => deploymentPatternName,
"workloadName" => workloadName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployment_events(deployment_id)
list_deployment_events(deployment_id, params::Dict{String,<:Any})
Lists the events of a deployment.
# Arguments
- `deployment_id`: The ID of the deployment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return for this request. To get the next
page of items, make another request with the token returned in the output.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function list_deployment_events(
deploymentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"POST",
"/listDeploymentEvents",
Dict{String,Any}("deploymentId" => deploymentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deployment_events(
deploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/listDeploymentEvents",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("deploymentId" => deploymentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployments()
list_deployments(params::Dict{String,<:Any})
Lists the deployments that have been created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Filters to scope the results. The following filters are supported:
WORKLOAD_NAME - The name used in deployments. DEPLOYMENT_STATUS - COMPLETED | CREATING |
DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS |
VALIDATING
- `"maxResults"`: The maximum number of items to return for this request. To get the next
page of items, make another request with the token returned in the output.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function list_deployments(; aws_config::AbstractAWSConfig=global_aws_config())
return launch_wizard(
"POST", "/listDeployments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_deployments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"POST",
"/listDeployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags associated with a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workload_deployment_patterns(workload_name)
list_workload_deployment_patterns(workload_name, params::Dict{String,<:Any})
Lists the workload deployment patterns for a given workload name. You can use the
ListWorkloads operation to discover the available workload names.
# Arguments
- `workload_name`: The name of the workload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return for this request. To get the next
page of items, make another request with the token returned in the output.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function list_workload_deployment_patterns(
workloadName; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"POST",
"/listWorkloadDeploymentPatterns",
Dict{String,Any}("workloadName" => workloadName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workload_deployment_patterns(
workloadName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/listWorkloadDeploymentPatterns",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workloadName" => workloadName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workloads()
list_workloads(params::Dict{String,<:Any})
Lists the available workload names. You can use the ListWorkloadDeploymentPatterns
operation to discover the available deployment patterns for a given workload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return for this request. To get the next
page of items, make another request with the token returned in the output.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function list_workloads(; aws_config::AbstractAWSConfig=global_aws_config())
return launch_wizard(
"POST", "/listWorkloads"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workloads(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"POST",
"/listWorkloads",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tags to the given resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: One or more tags to attach to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return launch_wizard(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the given resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: Keys identifying the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return launch_wizard(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return launch_wizard(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 84307 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lex_model_building_service
using AWS.Compat
using AWS.UUIDs
"""
create_bot_version(name)
create_bot_version(name, params::Dict{String,<:Any})
Creates a new version of the bot based on the LATEST version. If the LATEST version of this
resource hasn't changed since you created the last version, Amazon Lex doesn't create a new
version. It returns the last created version. You can update only the LATEST version of
the bot. You can't update the numbered versions that you create with the CreateBotVersion
operation. When you create the first version of a bot, Amazon Lex sets the version to 1.
Subsequent versions increment by 1. For more information, see versioning-intro. This
operation requires permission for the lex:CreateBotVersion action.
# Arguments
- `name`: The name of the bot that you want to create a new version of. The name is case
sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checksum"`: Identifies a specific revision of the LATEST version of the bot. If you
specify a checksum and the LATEST version of the bot has a different checksum, a
PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new
version. If you don't specify a checksum, Amazon Lex publishes the LATEST version.
"""
function create_bot_version(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"POST",
"/bots/$(name)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot_version(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"POST",
"/bots/$(name)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_intent_version(name)
create_intent_version(name, params::Dict{String,<:Any})
Creates a new version of an intent based on the LATEST version of the intent. If the LATEST
version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create
a new version. It returns the last version you created. You can update only the LATEST
version of the intent. You can't update the numbered versions that you create with the
CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets
the version to 1. Subsequent versions increment by 1. For more information, see
versioning-intro. This operation requires permissions to perform the
lex:CreateIntentVersion action.
# Arguments
- `name`: The name of the intent that you want to create a new version of. The name is case
sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checksum"`: Checksum of the LATEST version of the intent that should be used to create
the new version. If you specify a checksum and the LATEST version of the intent has a
different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't
publish a new version. If you don't specify a checksum, Amazon Lex publishes the LATEST
version.
"""
function create_intent_version(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"POST",
"/intents/$(name)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_intent_version(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"POST",
"/intents/$(name)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_slot_type_version(name)
create_slot_type_version(name, params::Dict{String,<:Any})
Creates a new version of a slot type based on the LATEST version of the specified slot
type. If the LATEST version of this resource has not changed since the last version that
you created, Amazon Lex doesn't create a new version. It returns the last version that you
created. You can update only the LATEST version of a slot type. You can't update the
numbered versions that you create with the CreateSlotTypeVersion operation. When you
create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions
increment by 1. For more information, see versioning-intro. This operation requires
permissions for the lex:CreateSlotTypeVersion action.
# Arguments
- `name`: The name of the slot type that you want to create a new version for. The name is
case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checksum"`: Checksum for the LATEST version of the slot type that you want to publish.
If you specify a checksum and the LATEST version of the slot type has a different checksum,
Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new
version. If you don't specify a checksum, Amazon Lex publishes the LATEST version.
"""
function create_slot_type_version(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"POST",
"/slottypes/$(name)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_slot_type_version(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"POST",
"/slottypes/$(name)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot(name)
delete_bot(name, params::Dict{String,<:Any})
Deletes all versions of the bot, including the LATEST version. To delete a specific version
of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately
remove the bot schema. Instead, it is marked for deletion and removed later. Amazon Lex
stores utterances indefinitely for improving the ability of your bot to respond to user
inputs. These utterances are not removed when the bot is deleted. To remove the utterances,
use the DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead,
the DeleteBot operation returns a ResourceInUseException exception that includes a
reference to the alias that refers to the bot. To remove the reference to the bot, delete
the alias. If you get the same exception again, delete the referring alias until the
DeleteBot operation is successful. This operation requires permissions for the
lex:DeleteBot action.
# Arguments
- `name`: The name of the bot. The name is case sensitive.
"""
function delete_bot(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"DELETE", "/bots/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_bot(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/bots/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_alias(bot_name, name)
delete_bot_alias(bot_name, name, params::Dict{String,<:Any})
Deletes an alias for the specified bot. You can't delete an alias that is used in the
association between a bot and a messaging channel. If an alias is used in a channel
association, the DeleteBot operation returns a ResourceInUseException exception that
includes a reference to the channel association that refers to the bot. You can remove the
reference to the alias by deleting the channel association. If you get the same exception
again, delete the referring association until the DeleteBotAlias operation is successful.
# Arguments
- `bot_name`: The name of the bot that the alias points to.
- `name`: The name of the alias to delete. The name is case sensitive.
"""
function delete_bot_alias(botName, name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"DELETE",
"/bots/$(botName)/aliases/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_alias(
botName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/bots/$(botName)/aliases/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_channel_association(alias_name, bot_name, name)
delete_bot_channel_association(alias_name, bot_name, name, params::Dict{String,<:Any})
Deletes the association between an Amazon Lex bot and a messaging platform. This operation
requires permission for the lex:DeleteBotChannelAssociation action.
# Arguments
- `alias_name`: An alias that points to the specific version of the Amazon Lex bot to which
this association is being made.
- `bot_name`: The name of the Amazon Lex bot.
- `name`: The name of the association. The name is case sensitive.
"""
function delete_bot_channel_association(
aliasName, botName, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/bots/$(botName)/aliases/$(aliasName)/channels/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_channel_association(
aliasName,
botName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/bots/$(botName)/aliases/$(aliasName)/channels/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_version(name, version)
delete_bot_version(name, version, params::Dict{String,<:Any})
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot
operation. This operation requires permissions for the lex:DeleteBotVersion action.
# Arguments
- `name`: The name of the bot.
- `version`: The version of the bot to delete. You cannot delete the LATEST version of the
bot. To delete the LATEST version, use the DeleteBot operation.
"""
function delete_bot_version(
name, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/bots/$(name)/versions/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_version(
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/bots/$(name)/versions/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_intent(name)
delete_intent(name, params::Dict{String,<:Any})
Deletes all versions of the intent, including the LATEST version. To delete a specific
version of the intent, use the DeleteIntentVersion operation. You can delete a version of
an intent only if it is not referenced. To delete an intent that is referred to in one or
more bots (see how-it-works), you must remove those references first. If you get the
ResourceInUseException exception, it provides an example reference that shows where the
intent is referenced. To remove the reference to the intent, either update the bot or
delete it. If you get the same exception when you attempt to delete the intent again,
repeat until the intent has no references and the call to DeleteIntent is successful.
This operation requires permission for the lex:DeleteIntent action.
# Arguments
- `name`: The name of the intent. The name is case sensitive.
"""
function delete_intent(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"DELETE", "/intents/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_intent(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/intents/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_intent_version(name, version)
delete_intent_version(name, version, params::Dict{String,<:Any})
Deletes a specific version of an intent. To delete all versions of a intent, use the
DeleteIntent operation. This operation requires permissions for the
lex:DeleteIntentVersion action.
# Arguments
- `name`: The name of the intent.
- `version`: The version of the intent to delete. You cannot delete the LATEST version of
the intent. To delete the LATEST version, use the DeleteIntent operation.
"""
function delete_intent_version(
name, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/intents/$(name)/versions/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_intent_version(
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/intents/$(name)/versions/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_slot_type(name)
delete_slot_type(name, params::Dict{String,<:Any})
Deletes all versions of the slot type, including the LATEST version. To delete a specific
version of the slot type, use the DeleteSlotTypeVersion operation. You can delete a
version of a slot type only if it is not referenced. To delete a slot type that is referred
to in one or more intents, you must remove those references first. If you get the
ResourceInUseException exception, the exception provides an example reference that shows
the intent where the slot type is referenced. To remove the reference to the slot type,
either update the intent or delete it. If you get the same exception when you attempt to
delete the slot type again, repeat until the slot type has no references and the
DeleteSlotType call is successful. This operation requires permission for the
lex:DeleteSlotType action.
# Arguments
- `name`: The name of the slot type. The name is case sensitive.
"""
function delete_slot_type(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"DELETE",
"/slottypes/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_slot_type(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/slottypes/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_slot_type_version(name, version)
delete_slot_type_version(name, version, params::Dict{String,<:Any})
Deletes a specific version of a slot type. To delete all versions of a slot type, use the
DeleteSlotType operation. This operation requires permissions for the
lex:DeleteSlotTypeVersion action.
# Arguments
- `name`: The name of the slot type.
- `version`: The version of the slot type to delete. You cannot delete the LATEST version
of the slot type. To delete the LATEST version, use the DeleteSlotType operation.
"""
function delete_slot_type_version(
name, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/slottypes/$(name)/version/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_slot_type_version(
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/slottypes/$(name)/version/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_utterances(bot_name, user_id)
delete_utterances(bot_name, user_id, params::Dict{String,<:Any})
Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot.
Utterances are stored for 15 days for use with the GetUtterancesView operation, and then
stored indefinitely for use in improving the ability of your bot to respond to user input.
Use the DeleteUtterances operation to manually delete stored utterances for a specific
user. When you use the DeleteUtterances operation, utterances stored for improving your
bot's ability to respond to user input are deleted immediately. Utterances stored for use
with the GetUtterancesView operation are deleted after 15 days. This operation requires
permissions for the lex:DeleteUtterances action.
# Arguments
- `bot_name`: The name of the bot that stored the utterances.
- `user_id`: The unique identifier for the user that made the utterances. This is the user
ID that was sent in the PostContent or PostText operation request that contained the
utterance.
"""
function delete_utterances(
botName, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/bots/$(botName)/utterances/$(userId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_utterances(
botName,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/bots/$(botName)/utterances/$(userId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bot(name, versionoralias)
get_bot(name, versionoralias, params::Dict{String,<:Any})
Returns metadata information for a specific bot. You must provide the bot name and the bot
version or alias. This operation requires permissions for the lex:GetBot action.
# Arguments
- `name`: The name of the bot. The name is case sensitive.
- `versionoralias`: The version or alias of the bot.
"""
function get_bot(name, versionoralias; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/bots/$(name)/versions/$(versionoralias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bot(
name,
versionoralias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/bots/$(name)/versions/$(versionoralias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bot_alias(bot_name, name)
get_bot_alias(bot_name, name, params::Dict{String,<:Any})
Returns information about an Amazon Lex bot alias. For more information about aliases, see
versioning-aliases. This operation requires permissions for the lex:GetBotAlias action.
# Arguments
- `bot_name`: The name of the bot.
- `name`: The name of the bot alias. The name is case sensitive.
"""
function get_bot_alias(botName, name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bot_alias(
botName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bot_aliases(bot_name)
get_bot_aliases(bot_name, params::Dict{String,<:Any})
Returns a list of aliases for a specified Amazon Lex bot. This operation requires
permissions for the lex:GetBotAliases action.
# Arguments
- `bot_name`: The name of the bot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of aliases to return in the response. The default is
50. .
- `"nameContains"`: Substring to match in bot alias names. An alias will be returned if any
part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and
\"abcxyz.\"
- `"nextToken"`: A pagination token for fetching the next page of aliases. If the response
to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch
the next page of aliases, specify the pagination token in the next request.
"""
function get_bot_aliases(botName; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bot_aliases(
botName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bot_channel_association(alias_name, bot_name, name)
get_bot_channel_association(alias_name, bot_name, name, params::Dict{String,<:Any})
Returns information about the association between an Amazon Lex bot and a messaging
platform. This operation requires permissions for the lex:GetBotChannelAssociation action.
# Arguments
- `alias_name`: An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
- `bot_name`: The name of the Amazon Lex bot.
- `name`: The name of the association between the bot and the channel. The name is case
sensitive.
"""
function get_bot_channel_association(
aliasName, botName, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/$(aliasName)/channels/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bot_channel_association(
aliasName,
botName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/$(aliasName)/channels/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bot_channel_associations(alias_name, bot_name)
get_bot_channel_associations(alias_name, bot_name, params::Dict{String,<:Any})
Returns a list of all of the channels associated with the specified bot. The
GetBotChannelAssociations operation requires permissions for the
lex:GetBotChannelAssociations action.
# Arguments
- `alias_name`: An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
- `bot_name`: The name of the Amazon Lex bot in the association.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of associations to return in the response. The default
is 50.
- `"nameContains"`: Substring to match in channel association names. An association will be
returned if any part of its name matches the substring. For example, \"xyz\" matches both
\"xyzabc\" and \"abcxyz.\" To return all bot channel associations, use a hyphen (\"-\") as
the nameContains parameter.
- `"nextToken"`: A pagination token for fetching the next page of associations. If the
response to this call is truncated, Amazon Lex returns a pagination token in the response.
To fetch the next page of associations, specify the pagination token in the next request.
"""
function get_bot_channel_associations(
aliasName, botName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/$(aliasName)/channels/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bot_channel_associations(
aliasName,
botName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/bots/$(botName)/aliases/$(aliasName)/channels/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bot_versions(name)
get_bot_versions(name, params::Dict{String,<:Any})
Gets information about all of the versions of a bot. The GetBotVersions operation returns a
BotMetadata object for each version of a bot. For example, if a bot has three numbered
versions, the GetBotVersions operation returns four BotMetadata objects in the response,
one for each numbered version and one for the LATEST version. The GetBotVersions operation
always returns at least one version, the LATEST version. This operation requires
permissions for the lex:GetBotVersions action.
# Arguments
- `name`: The name of the bot for which versions should be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of bot versions to return in the response. The default
is 10.
- `"nextToken"`: A pagination token for fetching the next page of bot versions. If the
response to this call is truncated, Amazon Lex returns a pagination token in the response.
To fetch the next page of versions, specify the pagination token in the next request.
"""
function get_bot_versions(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/bots/$(name)/versions/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bot_versions(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/bots/$(name)/versions/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bots()
get_bots(params::Dict{String,<:Any})
Returns bot information as follows: If you provide the nameContains field, the response
includes information for the LATEST version of all bots whose name contains the specified
string. If you don't specify the nameContains field, the operation returns information
about the LATEST version of all of your bots. This operation requires permission for the
lex:GetBots action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of bots to return in the response that the request
will return. The default is 10.
- `"nameContains"`: Substring to match in bot names. A bot will be returned if any part of
its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"
- `"nextToken"`: A pagination token that fetches the next page of bots. If the response to
this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the
next page of bots, specify the pagination token in the next request.
"""
function get_bots(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET", "/bots/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET", "/bots/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_builtin_intent(signature)
get_builtin_intent(signature, params::Dict{String,<:Any})
Returns information about a built-in intent. This operation requires permission for the
lex:GetBuiltinIntent action.
# Arguments
- `signature`: The unique identifier for a built-in intent. To find the signature for an
intent, see Standard Built-in Intents in the Alexa Skills Kit.
"""
function get_builtin_intent(signature; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/builtins/intents/$(signature)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_builtin_intent(
signature,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/builtins/intents/$(signature)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_builtin_intents()
get_builtin_intents(params::Dict{String,<:Any})
Gets a list of built-in intents that meet the specified criteria. This operation requires
permission for the lex:GetBuiltinIntents action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: A list of locales that the intent supports.
- `"maxResults"`: The maximum number of intents to return in the response. The default is
10.
- `"nextToken"`: A pagination token that fetches the next page of intents. If this API call
is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page
of intents, use the pagination token in the next request.
- `"signatureContains"`: Substring to match in built-in intent signatures. An intent will
be returned if any part of its signature matches the substring. For example, \"xyz\"
matches both \"xyzabc\" and \"abcxyz.\" To find the signature for an intent, see Standard
Built-in Intents in the Alexa Skills Kit.
"""
function get_builtin_intents(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET", "/builtins/intents/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_builtin_intents(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/builtins/intents/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_builtin_slot_types()
get_builtin_slot_types(params::Dict{String,<:Any})
Gets a list of built-in slot types that meet the specified criteria. For a list of built-in
slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires
permission for the lex:GetBuiltInSlotTypes action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: A list of locales that the slot type supports.
- `"maxResults"`: The maximum number of slot types to return in the response. The default
is 10.
- `"nextToken"`: A pagination token that fetches the next page of slot types. If the
response to this API call is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of slot types, specify the pagination token in the next
request.
- `"signatureContains"`: Substring to match in built-in slot type signatures. A slot type
will be returned if any part of its signature matches the substring. For example, \"xyz\"
matches both \"xyzabc\" and \"abcxyz.\"
"""
function get_builtin_slot_types(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/builtins/slottypes/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_builtin_slot_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/builtins/slottypes/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_export(export_type, name, resource_type, version)
get_export(export_type, name, resource_type, version, params::Dict{String,<:Any})
Exports the contents of a Amazon Lex resource in a specified format.
# Arguments
- `export_type`: The format of the exported data.
- `name`: The name of the bot to export.
- `resource_type`: The type of resource to export.
- `version`: The version of the bot to export.
"""
function get_export(
exportType,
name,
resourceType,
version;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/exports/",
Dict{String,Any}(
"exportType" => exportType,
"name" => name,
"resourceType" => resourceType,
"version" => version,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_export(
exportType,
name,
resourceType,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/exports/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"exportType" => exportType,
"name" => name,
"resourceType" => resourceType,
"version" => version,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import(import_id)
get_import(import_id, params::Dict{String,<:Any})
Gets information about an import job started with the StartImport operation.
# Arguments
- `import_id`: The identifier of the import job information to return.
"""
function get_import(importId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/imports/$(importId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import(
importId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/imports/$(importId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_intent(name, version)
get_intent(name, version, params::Dict{String,<:Any})
Returns information about an intent. In addition to the intent name, you must specify the
intent version. This operation requires permissions to perform the lex:GetIntent action.
# Arguments
- `name`: The name of the intent. The name is case sensitive.
- `version`: The version of the intent.
"""
function get_intent(name, version; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/intents/$(name)/versions/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_intent(
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/intents/$(name)/versions/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_intent_versions(name)
get_intent_versions(name, params::Dict{String,<:Any})
Gets information about all of the versions of an intent. The GetIntentVersions operation
returns an IntentMetadata object for each version of an intent. For example, if an intent
has three numbered versions, the GetIntentVersions operation returns four IntentMetadata
objects in the response, one for each numbered version and one for the LATEST version. The
GetIntentVersions operation always returns at least one version, the LATEST version. This
operation requires permissions for the lex:GetIntentVersions action.
# Arguments
- `name`: The name of the intent for which versions should be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of intent versions to return in the response. The
default is 10.
- `"nextToken"`: A pagination token for fetching the next page of intent versions. If the
response to this call is truncated, Amazon Lex returns a pagination token in the response.
To fetch the next page of versions, specify the pagination token in the next request.
"""
function get_intent_versions(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/intents/$(name)/versions/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_intent_versions(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/intents/$(name)/versions/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_intents()
get_intents(params::Dict{String,<:Any})
Returns intent information as follows: If you specify the nameContains field, returns
the LATEST version of all intents that contain the specified string. If you don't
specify the nameContains field, returns information about the LATEST version of all
intents. The operation requires permission for the lex:GetIntents action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of intents to return in the response. The default is
10.
- `"nameContains"`: Substring to match in intent names. An intent will be returned if any
part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and
\"abcxyz.\"
- `"nextToken"`: A pagination token that fetches the next page of intents. If the response
to this API call is truncated, Amazon Lex returns a pagination token in the response. To
fetch the next page of intents, specify the pagination token in the next request.
"""
function get_intents(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET", "/intents/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_intents(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET", "/intents/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_migration(migration_id)
get_migration(migration_id, params::Dict{String,<:Any})
Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an
Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to
the migration.
# Arguments
- `migration_id`: The unique identifier of the migration to view. The migrationID is
returned by the operation.
"""
function get_migration(migrationId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/migrations/$(migrationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_migration(
migrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/migrations/$(migrationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_migrations()
get_migrations(params::Dict{String,<:Any})
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of migrations to return in the response. The default
is 10.
- `"migrationStatusEquals"`: Filters the list to contain only migrations in the specified
state.
- `"nextToken"`: A pagination token that fetches the next page of migrations. If the
response to this operation is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of migrations, specify the pagination token in the request.
- `"sortByAttribute"`: The field to sort the list of migrations by. You can sort by the
Amazon Lex V1 bot name or the date and time that the migration was started.
- `"sortByOrder"`: The order so sort the list.
- `"v1BotNameContains"`: Filters the list to contain only bots whose name contains the
specified string. The string is matched anywhere in bot name.
"""
function get_migrations(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET", "/migrations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_migrations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET", "/migrations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_slot_type(name, version)
get_slot_type(name, version, params::Dict{String,<:Any})
Returns information about a specific version of a slot type. In addition to specifying the
slot type name, you must specify the slot type version. This operation requires permissions
for the lex:GetSlotType action.
# Arguments
- `name`: The name of the slot type. The name is case sensitive.
- `version`: The version of the slot type.
"""
function get_slot_type(name, version; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/slottypes/$(name)/versions/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_slot_type(
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/slottypes/$(name)/versions/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_slot_type_versions(name)
get_slot_type_versions(name, params::Dict{String,<:Any})
Gets information about all versions of a slot type. The GetSlotTypeVersions operation
returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot
type has three numbered versions, the GetSlotTypeVersions operation returns four
SlotTypeMetadata objects in the response, one for each numbered version and one for the
LATEST version. The GetSlotTypeVersions operation always returns at least one version, the
LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action.
# Arguments
- `name`: The name of the slot type for which versions should be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of slot type versions to return in the response. The
default is 10.
- `"nextToken"`: A pagination token for fetching the next page of slot type versions. If
the response to this call is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of versions, specify the pagination token in the next
request.
"""
function get_slot_type_versions(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET",
"/slottypes/$(name)/versions/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_slot_type_versions(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/slottypes/$(name)/versions/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_slot_types()
get_slot_types(params::Dict{String,<:Any})
Returns slot type information as follows: If you specify the nameContains field, returns
the LATEST version of all slot types that contain the specified string. If you don't
specify the nameContains field, returns information about the LATEST version of all slot
types. The operation requires permission for the lex:GetSlotTypes action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of slot types to return in the response. The default
is 10.
- `"nameContains"`: Substring to match in slot type names. A slot type will be returned if
any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\"
and \"abcxyz.\"
- `"nextToken"`: A pagination token that fetches the next page of slot types. If the
response to this API call is truncated, Amazon Lex returns a pagination token in the
response. To fetch next page of slot types, specify the pagination token in the next
request.
"""
function get_slot_types(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"GET", "/slottypes/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_slot_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET", "/slottypes/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_utterances_view(bot_versions, botname, status_type)
get_utterances_view(bot_versions, botname, status_type, params::Dict{String,<:Any})
Use the GetUtterancesView operation to get information about the utterances that your users
have made to your bot. You can use this list to tune the utterances that your bot responds
to. For example, say that you have created a bot to order flowers. After your users have
used your bot for a while, use the GetUtterancesView operation to see the requests that
they have made and whether they have been successful. You might find that the utterance \"I
want flowers\" is not being recognized. You could add this utterance to the OrderFlowers
intent so that your bot recognizes that utterance. After you publish a new version of a
bot, you can get information about the old version and the new so that you can compare the
performance across the two versions. Utterance statistics are generated once a day. Data
is available for the last 15 days. You can request information for up to 5 versions of your
bot in each request. Amazon Lex returns the most frequent utterances received by the bot in
the last 15 days. The response contains information about a maximum of 100 utterances for
each version. If you set childDirected field to true when you created your bot, if you are
using slot obfuscation with one or more slots, or if you opted out of participating in
improving Amazon Lex, utterances are not available. This operation requires permissions for
the lex:GetUtterancesView action.
# Arguments
- `bot_versions`: An array of bot versions for which utterance information should be
returned. The limit is 5 versions per request.
- `botname`: The name of the bot for which utterance information should be returned.
- `status_type`: To return utterances that were recognized and handled, use Detected. To
return utterances that were not recognized, use Missed.
"""
function get_utterances_view(
bot_versions, botname, status_type; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/bots/$(botname)/utterances?view=aggregation",
Dict{String,Any}("bot_versions" => bot_versions, "status_type" => status_type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_utterances_view(
bot_versions,
botname,
status_type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/bots/$(botname)/utterances?view=aggregation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bot_versions" => bot_versions, "status_type" => status_type
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot
channels can have tags associated with them.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to get a list of tags for.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bot(child_directed, locale, name)
put_bot(child_directed, locale, name, params::Dict{String,<:Any})
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or
update a bot you are only required to specify a name, a locale, and whether the bot is
directed toward children under age 13. You can use this to add intents later, or to remove
intents from an existing bot. When you create a bot with the minimum information, the bot
is created or updated but Amazon Lex returns the response FAILED. You can build the bot
after you add one or more intents. For more information about Amazon Lex bots, see
how-it-works. If you specify the name of an existing bot, the fields in the request
replace the existing values in the LATEST version of the bot. Amazon Lex removes any fields
that you don't provide values for in the request, except for the idleTTLInSeconds and
privacySettings fields, which are set to their default values. If you don't specify values
for required fields, Amazon Lex throws an exception. This operation requires permissions
for the lex:PutBot action. For more information, see security-iam.
# Arguments
- `child_directed`: For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part, to children under
age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true or false in the childDirected field. By specifying true in the childDirected field,
you confirm that your use of Amazon Lex is related to a website, program, or other
application that is directed or targeted, in whole or in part, to children under age 13 and
subject to COPPA. By specifying false in the childDirected field, you confirm that your use
of Amazon Lex is not related to a website, program, or other application that is directed
or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may
not specify a default value for the childDirected field that does not accurately reflect
whether your use of Amazon Lex is related to a website, program, or other application that
is directed or targeted, in whole or in part, to children under age 13 and subject to
COPPA. If your use of Amazon Lex relates to a website, program, or other application that
is directed in whole or in part, to children under age 13, you must obtain any required
verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in
connection with websites, programs, or other applications that are directed or targeted, in
whole or in part, to children under age 13, see the Amazon Lex FAQ.
- `locale`: Specifies the target locale for the bot. Any intent used in the bot must be
compatible with the locale of the bot. The default is en-US.
- `name`: The name of the bot. The name is not case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"abortStatement"`: When Amazon Lex can't understand the user's input in context, it
tries to elicit the information a few times. After that, Amazon Lex sends the message
defined in abortStatement to the user, and then cancels the conversation. To set the number
of retries, use the valueElicitationPrompt field for the slot type. For example, in a
pizza ordering bot, Amazon Lex might ask a user \"What type of crust would you like?\" If
the user's response is not one of the expected responses (for example, \"thin crust, \"deep
dish,\" etc.), Amazon Lex tries to elicit a correct response a few more times. For
example, in a pizza ordering application, OrderPizza might be one of the intents. This
intent might require the CrustType slot. You specify the valueElicitationPrompt field when
you create the CrustType slot. If you have defined a fallback intent the cancel statement
will not be sent to the user, the fallback intent is used instead. For more information,
see AMAZON.FallbackIntent.
- `"checksum"`: Identifies a specific revision of the LATEST version. When you create a new
bot, leave the checksum field blank. If you specify a checksum you get a
BadRequestException exception. When you want to update a bot, set the checksum field to the
checksum of the most recent revision of the LATEST version. If you don't specify the
checksum field, or if the checksum does not match the LATEST version, you get a
PreconditionFailedException exception.
- `"clarificationPrompt"`: When Amazon Lex doesn't understand the user's intent, it uses
this message to get clarification. To specify how many times Amazon Lex should repeat the
clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it
sends the message in the abortStatement field. When you create a clarification prompt,
make sure that it suggests the correct response from the user. for example, for a bot that
orders pizza and drinks, you might create this clarification prompt: \"What would you like
to do? You can say 'Order a pizza' or 'Order a drink.'\" If you have defined a fallback
intent, it will be invoked if the clarification prompt is repeated the number of times
defined in the maxAttempts field. For more information, see AMAZON.FallbackIntent. If you
don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request
exception in three cases: Follow-up prompt - When the user responds to a follow-up
prompt but does not provide an intent. For example, in response to a follow-up prompt that
says \"Would you like anything else today?\" the user says \"Yes.\" Amazon Lex will return
a 400 Bad Request exception because it does not have a clarification prompt to send to the
user to get an intent. Lambda function - When using a Lambda function, you return an
ElicitIntent dialog type. Since Amazon Lex does not have a clarification prompt to get an
intent from the user, it returns a 400 Bad Request exception. PutSession operation - When
using the PutSession operation, you send an ElicitIntent dialog type. Since Amazon Lex does
not have a clarification prompt to get an intent from the user, it returns a 400 Bad
Request exception.
- `"createVersion"`: When set to true a new numbered version of the bot is created. This is
the same as calling the CreateBotVersion operation. If you don't specify createVersion, the
default is false.
- `"description"`: A description of the bot.
- `"detectSentiment"`: When set to true user utterances are sent to Amazon Comprehend for
sentiment analysis. If you don't specify detectSentiment, the default is false.
- `"enableModelImprovements"`: Set to true to enable access to natural language
understanding improvements. When you set the enableModelImprovements parameter to true you
can use the nluIntentConfidenceThreshold parameter to configure confidence scores. For more
information, see Confidence Scores. You can only set the enableModelImprovements parameter
in certain Regions. If you set the parameter to true, your bot has access to accuracy
improvements. The Regions where you can set the enableModelImprovements parameter to true
are: US East (N. Virginia) (us-east-1) US West (Oregon) (us-west-2) Asia Pacific
(Sydney) (ap-southeast-2) EU (Ireland) (eu-west-1) In other Regions, the
enableModelImprovements parameter is set to true by default. In these Regions setting the
parameter to false throws a ValidationException exception.
- `"idleSessionTTLInSeconds"`: The maximum time in seconds that Amazon Lex retains the data
gathered in a conversation. A user interaction session remains active for the amount of
time specified. If no conversation occurs during this time, the session expires and Amazon
Lex deletes any data provided before the timeout. For example, suppose that a user chooses
the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user
doesn't complete the order within the specified time, Amazon Lex discards the slot
information that it gathered, and the user must start over. If you don't include the
idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default
value. This is also true if the request replaces an existing bot. The default is 300
seconds (5 minutes).
- `"intents"`: An array of Intent objects. Each intent represents a command that a user can
express. For example, a pizza ordering bot might support an OrderPizza intent. For more
information, see how-it-works.
- `"nluIntentConfidenceThreshold"`: Determines the threshold where Amazon Lex will insert
the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative
intents in a PostContent or PostText response. AMAZON.FallbackIntent and
AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. You must
set the enableModelImprovements parameter to true to use confidence scores in the following
regions. US East (N. Virginia) (us-east-1) US West (Oregon) (us-west-2) Asia Pacific
(Sydney) (ap-southeast-2) EU (Ireland) (eu-west-1) In other Regions, the
enableModelImprovements parameter is set to true by default. For example, suppose a bot is
configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex
returns three alternative intents with the following confidence scores: IntentA (0.70),
IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent IntentA IntentB IntentC
- `"processBehavior"`: If you set the processBehavior element to BUILD, Amazon Lex builds
the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but
doesn't build it. If you don't specify this value, the default value is BUILD.
- `"tags"`: A list of tags to add to the bot. You can only add tags when you create a bot,
you can't use the PutBot operation to update the tags on a bot. To update tags, use the
TagResource operation.
- `"voiceId"`: The Amazon Polly voice ID that you want Amazon Lex to use for voice
interactions with the user. The locale configured for the voice must match the locale of
the bot. For more information, see Voices in Amazon Polly in the Amazon Polly Developer
Guide.
"""
function put_bot(
childDirected, locale, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"PUT",
"/bots/$(name)/versions/$LATEST",
Dict{String,Any}("childDirected" => childDirected, "locale" => locale);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bot(
childDirected,
locale,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"PUT",
"/bots/$(name)/versions/$LATEST",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("childDirected" => childDirected, "locale" => locale),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bot_alias(bot_name, bot_version, name)
put_bot_alias(bot_name, bot_version, name, params::Dict{String,<:Any})
Creates an alias for the specified version of the bot or replaces an alias for the
specified bot. To change the version of the bot that the alias points to, replace the
alias. For more information about aliases, see versioning-aliases. This operation requires
permissions for the lex:PutBotAlias action.
# Arguments
- `bot_name`: The name of the bot.
- `bot_version`: The version of the bot.
- `name`: The name of the alias. The name is not case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checksum"`: Identifies a specific revision of the LATEST version. When you create a new
bot alias, leave the checksum field blank. If you specify a checksum you get a
BadRequestException exception. When you want to update a bot alias, set the checksum field
to the checksum of the most recent revision of the LATEST version. If you don't specify the
checksum field, or if the checksum does not match the LATEST version, you get a
PreconditionFailedException exception.
- `"conversationLogs"`: Settings for conversation logs for the alias.
- `"description"`: A description of the alias.
- `"tags"`: A list of tags to add to the bot alias. You can only add tags when you create
an alias, you can't use the PutBotAlias operation to update the tags on a bot alias. To
update tags, use the TagResource operation.
"""
function put_bot_alias(
botName, botVersion, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"PUT",
"/bots/$(botName)/aliases/$(name)",
Dict{String,Any}("botVersion" => botVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bot_alias(
botName,
botVersion,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"PUT",
"/bots/$(botName)/aliases/$(name)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("botVersion" => botVersion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_intent(name)
put_intent(name, params::Dict{String,<:Any})
Creates an intent or replaces an existing intent. To define the interaction between the
user and your bot, you use one or more intents. For a pizza ordering bot, for example, you
would create an OrderPizza intent. To create an intent or replace an existing intent, you
must provide the following: Intent name. For example, OrderPizza. Sample utterances.
For example, \"Can I order a pizza, please.\" and \"I want to order a pizza.\"
Information to be gathered. You specify slot types for the information that your bot will
request from the user. You can specify standard slot types, such as a date or a time, or
custom slot types such as the size and crust of a pizza. How the intent will be
fulfilled. You can provide a Lambda function or configure the intent to return the intent
information to the client application. If you use a Lambda function, when all of the intent
information is available, Amazon Lex invokes your Lambda function. If you configure your
intent to return the intent information to the client application. You can specify other
optional information in the request, such as: A confirmation prompt to ask the user to
confirm an intent. For example, \"Shall I order your pizza?\" A conclusion statement to
send to the user after the intent has been fulfilled. For example, \"I placed your pizza
order.\" A follow-up prompt that asks the user for additional activity. For example,
asking \"Do you want to order a drink with your pizza?\" If you specify an existing
intent name to update the intent, Amazon Lex replaces the values in the LATEST version of
the intent with the values in the request. Amazon Lex removes fields that you don't provide
in the request. If you don't specify the required fields, Amazon Lex throws an exception.
When you update the LATEST version of an intent, the status field of any bot that uses the
LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent action.
# Arguments
- `name`: The name of the intent. The name is not case sensitive. The name can't match a
built-in intent name, or a built-in intent name with \"AMAZON.\" removed. For example,
because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom
intent called HelpIntent. For a list of built-in intents, see Standard Built-in Intents in
the Alexa Skills Kit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checksum"`: Identifies a specific revision of the LATEST version. When you create a new
intent, leave the checksum field blank. If you specify a checksum you get a
BadRequestException exception. When you want to update a intent, set the checksum field to
the checksum of the most recent revision of the LATEST version. If you don't specify the
checksum field, or if the checksum does not match the LATEST version, you get a
PreconditionFailedException exception.
- `"conclusionStatement"`: The statement that you want Amazon Lex to convey to the user
after the intent is successfully fulfilled by the Lambda function. This element is
relevant only if you provide a Lambda function in the fulfillmentActivity. If you return
the intent to the client application, you can't specify this element. The followUpPrompt
and conclusionStatement are mutually exclusive. You can specify only one.
- `"confirmationPrompt"`: Prompts the user to confirm the intent. This question should have
a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that
the intent is ready for fulfillment. For example, with the OrderPizza intent, you might
want to confirm that the order is correct before placing it. For other intents, such as
intents that simply respond to user questions, you might not need to ask the user for
confirmation before providing the information. You you must provide both the
rejectionStatement and the confirmationPrompt, or neither.
- `"createVersion"`: When set to true a new numbered version of the intent is created. This
is the same as calling the CreateIntentVersion operation. If you do not specify
createVersion, the default is false.
- `"description"`: A description of the intent.
- `"dialogCodeHook"`: Specifies a Lambda function to invoke for each user input. You can
invoke this Lambda function to personalize user interaction. For example, suppose your bot
determines that the user is John. Your Lambda function might retrieve John's information
from a backend database and prepopulate some of the values. For example, if you find that
John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant,
to true. You might find John's phone number and set the corresponding session attribute.
- `"followUpPrompt"`: Amazon Lex uses this prompt to solicit additional activity after
fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might
prompt the user to order a drink. The action that Amazon Lex takes depends on the user's
response, as follows: If the user says \"Yes\" it responds with the clarification prompt
that is configured for the bot. if the user says \"Yes\" and continues with an utterance
that triggers an intent it starts a conversation for the intent. If the user says \"No\"
it responds with the rejection statement configured for the the follow-up prompt. If it
doesn't recognize the utterance it repeats the follow-up prompt again. The followUpPrompt
field and the conclusionStatement field are mutually exclusive. You can specify only one.
- `"fulfillmentActivity"`: Required. Describes how the intent is fulfilled. For example,
after a user provides all of the information for a pizza order, fulfillmentActivity defines
how the bot places an order with a local pizza store. You might configure Amazon Lex to
return all of the intent information to the client application, or direct it to invoke a
Lambda function that can process the intent (for example, place an order with a pizzeria).
- `"inputContexts"`: An array of InputContext objects that lists the contexts that must be
active for Amazon Lex to choose the intent in a conversation with the user.
- `"kendraConfiguration"`: Configuration information required to use the
AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more
information, see AMAZON.KendraSearchIntent.
- `"outputContexts"`: An array of OutputContext objects that lists the contexts that the
intent activates when the intent is fulfilled.
- `"parentIntentSignature"`: A unique identifier for the built-in intent to base this
intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa
Skills Kit.
- `"rejectionStatement"`: When the user answers \"no\" to the question defined in
confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent
was canceled. You must provide both the rejectionStatement and the confirmationPrompt, or
neither.
- `"sampleUtterances"`: An array of utterances (strings) that a user might say to signal
the intent. For example, \"I want {PizzaSize} pizza\", \"Order {Quantity} {PizzaSize}
pizzas\". In each utterance, a slot name is enclosed in curly braces.
- `"slots"`: An array of intent slots. At runtime, Amazon Lex elicits required slot values
from the user using prompts defined in the slots. For more information, see how-it-works.
"""
function put_intent(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"PUT",
"/intents/$(name)/versions/$LATEST";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_intent(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"PUT",
"/intents/$(name)/versions/$LATEST",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_slot_type(name)
put_slot_type(name, params::Dict{String,<:Any})
Creates a custom slot type or replaces an existing custom slot type. To create a custom
slot type, specify a name for the slot type and a set of enumeration values, which are the
values that a slot of this type can assume. For more information, see how-it-works. If you
specify the name of an existing slot type, the fields in the request replace the existing
values in the LATEST version of the slot type. Amazon Lex removes the fields that you don't
provide in the request. If you don't specify required fields, Amazon Lex throws an
exception. When you update the LATEST version of a slot type, if a bot uses the LATEST
version of an intent that contains the slot type, the bot's status field is set to
NOT_BUILT. This operation requires permissions for the lex:PutSlotType action.
# Arguments
- `name`: The name of the slot type. The name is not case sensitive. The name can't match
a built-in slot type name, or a built-in slot type name with \"AMAZON.\" removed. For
example, because there is a built-in slot type called AMAZON.DATE, you can't create a
custom slot type called DATE. For a list of built-in slot types, see Slot Type Reference in
the Alexa Skills Kit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checksum"`: Identifies a specific revision of the LATEST version. When you create a new
slot type, leave the checksum field blank. If you specify a checksum you get a
BadRequestException exception. When you want to update a slot type, set the checksum field
to the checksum of the most recent revision of the LATEST version. If you don't specify the
checksum field, or if the checksum does not match the LATEST version, you get a
PreconditionFailedException exception.
- `"createVersion"`: When set to true a new numbered version of the slot type is created.
This is the same as calling the CreateSlotTypeVersion operation. If you do not specify
createVersion, the default is false.
- `"description"`: A description of the slot type.
- `"enumerationValues"`: A list of EnumerationValue objects that defines the values that
the slot type can take. Each value can have a list of synonyms, which are additional values
that help train the machine learning model about the values that it resolves for a slot. A
regular expression slot type doesn't require enumeration values. All other slot types
require a list of enumeration values. When Amazon Lex resolves a slot value, it generates a
resolution list that contains up to five possible values for the slot. If you are using a
Lambda function, this resolution list is passed to the function. If you are not using a
Lambda function you can choose to return the value that the user entered or the first value
in the resolution list as the slot value. The valueSelectionStrategy field indicates the
option to use.
- `"parentSlotTypeSignature"`: The built-in slot type used as the parent of the slot type.
When you define a parent slot type, the new slot type has all of the same configuration as
the parent. Only AMAZON.AlphaNumeric is supported.
- `"slotTypeConfigurations"`: Configuration information that extends the parent built-in
slot type. The configuration is added to the settings for the parent slot type.
- `"valueSelectionStrategy"`: Determines the slot resolution strategy that Amazon Lex uses
to return slot type values. The field can be set to one of the following values:
ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the
slot value. TOP_RESOLUTION - If there is a resolution list for the slot, return the
first value in the resolution list as the slot type value. If there is no resolution list,
null is returned. If you don't specify the valueSelectionStrategy, the default is
ORIGINAL_VALUE.
"""
function put_slot_type(name; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"PUT",
"/slottypes/$(name)/versions/$LATEST";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_slot_type(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"PUT",
"/slottypes/$(name)/versions/$LATEST",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import(merge_strategy, payload, resource_type)
start_import(merge_strategy, payload, resource_type, params::Dict{String,<:Any})
Starts a job to import a resource to Amazon Lex.
# Arguments
- `merge_strategy`: Specifies the action that the StartImport operation should take when
there is an existing resource with the same name. FAIL_ON_CONFLICT - The import operation
is stopped on the first conflict between a resource in the import file and an existing
resource. The name of the resource causing the conflict is in the failureReason field of
the response to the GetImport operation. OVERWRITE_LATEST - The import operation proceeds
even if there is a conflict with an existing resource. The LASTEST version of the existing
resource is overwritten with the data from the import file.
- `payload`: A zip archive in binary format. The archive should contain one file, a JSON
file containing the resource to import. The resource should match the type specified in the
resourceType field.
- `resource_type`: Specifies the type of resource to export. Each resource also exports any
resources that it depends on. A bot exports dependent intents. An intent exports
dependent slot types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of tags to add to the imported bot. You can only add tags when you
import a bot, you can't add tags to an intent or slot type.
"""
function start_import(
mergeStrategy, payload, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"POST",
"/imports/",
Dict{String,Any}(
"mergeStrategy" => mergeStrategy,
"payload" => payload,
"resourceType" => resourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import(
mergeStrategy,
payload,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"POST",
"/imports/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"mergeStrategy" => mergeStrategy,
"payload" => payload,
"resourceType" => resourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_migration(migration_strategy, v1_bot_name, v1_bot_version, v2_bot_name, v2_bot_role)
start_migration(migration_strategy, v1_bot_name, v1_bot_version, v2_bot_name, v2_bot_role, params::Dict{String,<:Any})
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want
to take advantage of the new features of Amazon Lex V2. For more information, see Migrating
a bot in the Amazon Lex developer guide.
# Arguments
- `migration_strategy`: The strategy used to conduct the migration. CREATE_NEW - Creates
a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being
migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale
doesn't exist, a new locale is created in the Amazon Lex V2 bot.
- `v1_bot_name`: The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
- `v1_bot_version`: The version of the bot to migrate to Amazon Lex V2. You can migrate the
LATEST version as well as any numbered version.
- `v2_bot_name`: The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1
bot to. If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW migration
strategy. If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration
strategy to change the contents of the Amazon Lex V2 bot.
- `v2_bot_role`: The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
"""
function start_migration(
migrationStrategy,
v1BotName,
v1BotVersion,
v2BotName,
v2BotRole;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"POST",
"/migrations",
Dict{String,Any}(
"migrationStrategy" => migrationStrategy,
"v1BotName" => v1BotName,
"v1BotVersion" => v1BotVersion,
"v2BotName" => v2BotName,
"v2BotRole" => v2BotRole,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_migration(
migrationStrategy,
v1BotName,
v1BotVersion,
v2BotName,
v2BotRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"POST",
"/migrations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"migrationStrategy" => migrationStrategy,
"v1BotName" => v1BotName,
"v1BotVersion" => v1BotVersion,
"v2BotName" => v2BotName,
"v2BotRole" => v2BotRole,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tags to the specified resource. If a tag key already exists, the
existing value is replaced with the new value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to
tag.
- `tags`: A list of tag keys to add to the resource. If a tag key already exists, the
existing value is replaced with the new value.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return lex_model_building_service(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a bot, bot alias or bot channel.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to remove the tags from.
- `tag_keys`: A list of tag keys to remove from the resource. If a tag key does not exist
on the resource, it is ignored.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_model_building_service(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_model_building_service(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 192511 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lex_models_v2
using AWS.Compat
using AWS.UUIDs
"""
batch_create_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id)
batch_create_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id, params::Dict{String,<:Any})
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
# Arguments
- `bot_id`: The identifier of the bot associated with this custom vocabulary.
- `bot_version`: The identifier of the version of the bot associated with this custom
vocabulary.
- `custom_vocabulary_item_list`: A list of new custom vocabulary items. Each entry must
contain a phrase and can optionally contain a displayAs and/or a weight.
- `locale_id`: The identifier of the language and locale where this custom vocabulary is
used. The string must match one of the supported locales. For more information, see
Supported Languages .
"""
function batch_create_custom_vocabulary_item(
botId,
botVersion,
customVocabularyItemList,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/batchcreate",
Dict{String,Any}("customVocabularyItemList" => customVocabularyItemList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_custom_vocabulary_item(
botId,
botVersion,
customVocabularyItemList,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/batchcreate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("customVocabularyItemList" => customVocabularyItemList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id)
batch_delete_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id, params::Dict{String,<:Any})
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
# Arguments
- `bot_id`: The identifier of the bot associated with this custom vocabulary.
- `bot_version`: The identifier of the version of the bot associated with this custom
vocabulary.
- `custom_vocabulary_item_list`: A list of custom vocabulary items requested to be deleted.
Each entry must contain the unique custom vocabulary entry identifier.
- `locale_id`: The identifier of the language and locale where this custom vocabulary is
used. The string must match one of the supported locales. For more information, see
Supported Languages .
"""
function batch_delete_custom_vocabulary_item(
botId,
botVersion,
customVocabularyItemList,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/batchdelete",
Dict{String,Any}("customVocabularyItemList" => customVocabularyItemList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_custom_vocabulary_item(
botId,
botVersion,
customVocabularyItemList,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/batchdelete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("customVocabularyItemList" => customVocabularyItemList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id)
batch_update_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id, params::Dict{String,<:Any})
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
# Arguments
- `bot_id`: The identifier of the bot associated with this custom vocabulary
- `bot_version`: The identifier of the version of the bot associated with this custom
vocabulary.
- `custom_vocabulary_item_list`: A list of custom vocabulary items with updated fields.
Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
- `locale_id`: The identifier of the language and locale where this custom vocabulary is
used. The string must match one of the supported locales. For more information, see
Supported Languages .
"""
function batch_update_custom_vocabulary_item(
botId,
botVersion,
customVocabularyItemList,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/batchupdate",
Dict{String,Any}("customVocabularyItemList" => customVocabularyItemList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_custom_vocabulary_item(
botId,
botVersion,
customVocabularyItemList,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/batchupdate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("customVocabularyItemList" => customVocabularyItemList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
build_bot_locale(bot_id, bot_version, locale_id)
build_bot_locale(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built
into multiple locales. At runtime the locale is used to choose a specific build of the bot.
# Arguments
- `bot_id`: The identifier of the bot to build. The identifier is returned in the response
from the CreateBot operation.
- `bot_version`: The version of the bot to build. This can only be the draft version of the
bot.
- `locale_id`: The identifier of the language and locale that the bot will be used in. The
string must match one of the supported locales. All of the intents, slot types, and slots
used in the bot must have the same locale. For more information, see Supported languages.
"""
function build_bot_locale(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function build_bot_locale(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bot(bot_name, data_privacy, idle_session_ttlin_seconds, role_arn)
create_bot(bot_name, data_privacy, idle_session_ttlin_seconds, role_arn, params::Dict{String,<:Any})
Creates an Amazon Lex conversational bot.
# Arguments
- `bot_name`: The name of the bot. The bot name must be unique in the account that creates
the bot.
- `data_privacy`: Provides information on additional privacy protections Amazon Lex should
use with the bot's data.
- `idle_session_ttlin_seconds`: The time, in seconds, that Amazon Lex should keep
information about a user's conversation with the bot. A user interaction remains active
for the amount of time specified. If no conversation occurs during this time, the session
expires and Amazon Lex deletes any data provided before the timeout. You can specify
between 60 (1 minute) and 86,400 (24 hours) seconds.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that has permission to access
the bot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botMembers"`: The list of bot members in a network to be created.
- `"botTags"`: A list of tags to add to the bot. You can only add tags when you create a
bot. You can't use the UpdateBot operation to update tags. To update tags, use the
TagResource operation.
- `"botType"`: The type of a bot to create.
- `"description"`: A description of the bot. It appears in lists to help you identify a
particular bot.
- `"testBotAliasTags"`: A list of tags to add to the test alias for a bot. You can only add
tags when you create a bot. You can't use the UpdateAlias operation to update tags. To
update tags on the test alias, use the TagResource operation.
"""
function create_bot(
botName,
dataPrivacy,
idleSessionTTLInSeconds,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/",
Dict{String,Any}(
"botName" => botName,
"dataPrivacy" => dataPrivacy,
"idleSessionTTLInSeconds" => idleSessionTTLInSeconds,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot(
botName,
dataPrivacy,
idleSessionTTLInSeconds,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"botName" => botName,
"dataPrivacy" => dataPrivacy,
"idleSessionTTLInSeconds" => idleSessionTTLInSeconds,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bot_alias(bot_alias_name, bot_id)
create_bot_alias(bot_alias_name, bot_id, params::Dict{String,<:Any})
Creates an alias for the specified version of a bot. Use an alias to enable you to change
the version of a bot without updating applications that use the bot. For example, you can
create an alias called \"PROD\" that your applications use to call the Amazon Lex bot.
# Arguments
- `bot_alias_name`: The alias to create. The name must be unique for the bot.
- `bot_id`: The unique identifier of the bot that the alias applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botAliasLocaleSettings"`: Maps configuration information to a specific locale. You can
use this parameter to specify a specific Lambda function to run different functions in
different locales.
- `"botVersion"`: The version of the bot that this alias points to. You can use the
UpdateBotAlias operation to change the bot version associated with the alias.
- `"conversationLogSettings"`: Specifies whether Amazon Lex logs text and audio for a
conversation with the bot. When you enable conversation logs, text logs store text input,
transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs
store audio input in Amazon S3.
- `"description"`: A description of the alias. Use this description to help identify the
alias.
- `"sentimentAnalysisSettings"`:
- `"tags"`: A list of tags to add to the bot alias. You can only add tags when you create
an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To
update tags, use the TagResource operation.
"""
function create_bot_alias(
botAliasName, botId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botaliases/",
Dict{String,Any}("botAliasName" => botAliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot_alias(
botAliasName,
botId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botaliases/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("botAliasName" => botAliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold)
create_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold, params::Dict{String,<:Any})
Creates a locale in the bot. The locale contains the intents and slot types that the bot
uses in conversations with users in the specified language and locale. You must add a
locale to a bot before you can add intents and slot types to the bot.
# Arguments
- `bot_id`: The identifier of the bot to create the locale for.
- `bot_version`: The version of the bot to create the locale for. This can only be the
draft version of the bot.
- `locale_id`: The identifier of the language and locale that the bot will be used in. The
string must match one of the supported locales. All of the intents, slot types, and slots
used in the bot must have the same locale. For more information, see Supported languages.
- `nlu_intent_confidence_threshold`: Determines the threshold where Amazon Lex will insert
the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative
intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are
configured for the bot. For example, suppose a bot is configured with the confidence
threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative
intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC
(0.50). The response from the RecognizeText operation would be: AMAZON.FallbackIntent
IntentA IntentB IntentC
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the bot locale. Use this to help identify the bot
locale in lists.
- `"generativeAISettings"`:
- `"voiceSettings"`: The Amazon Polly voice ID that Amazon Lex uses for voice interaction
with the user.
"""
function create_bot_locale(
botId,
botVersion,
localeId,
nluIntentConfidenceThreshold;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/",
Dict{String,Any}(
"localeId" => localeId,
"nluIntentConfidenceThreshold" => nluIntentConfidenceThreshold,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot_locale(
botId,
botVersion,
localeId,
nluIntentConfidenceThreshold,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"localeId" => localeId,
"nluIntentConfidenceThreshold" => nluIntentConfidenceThreshold,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bot_replica(bot_id, replica_region)
create_bot_replica(bot_id, replica_region, params::Dict{String,<:Any})
Action to create a replication of the source bot in the secondary region.
# Arguments
- `bot_id`: The request for the unique bot ID of the source bot to be replicated in the
secondary region.
- `replica_region`: The request for the secondary region that will be used in the
replication of the source bot.
"""
function create_bot_replica(
botId, replicaRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/replicas/",
Dict{String,Any}("replicaRegion" => replicaRegion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot_replica(
botId,
replicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/replicas/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("replicaRegion" => replicaRegion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bot_version(bot_id, bot_version_locale_specification)
create_bot_version(bot_id, bot_version_locale_specification, params::Dict{String,<:Any})
Creates an immutable version of the bot. When you create the first version of a bot, Amazon
Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1.
The version number will always represent the total number of versions created of the bot,
not the current number of versions. If a bot version is deleted, that bot version number
will not be reused.
# Arguments
- `bot_id`: The identifier of the bot to create the version for.
- `bot_version_locale_specification`: Specifies the locales that Amazon Lex adds to this
version. You can choose the Draft version or any other previously published version for
each locale. When you specify a source version, the locale data is copied from the source
version to the new version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the version. Use the description to help identify the
version in lists.
"""
function create_bot_version(
botId, botVersionLocaleSpecification; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/",
Dict{String,Any}("botVersionLocaleSpecification" => botVersionLocaleSpecification);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot_version(
botId,
botVersionLocaleSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"botVersionLocaleSpecification" => botVersionLocaleSpecification
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_export(file_format, resource_specification)
create_export(file_format, resource_specification, params::Dict{String,<:Any})
Creates a zip archive containing the contents of a bot or a bot locale. The archive
contains a directory structure that contains JSON files that define the bot. You can create
an archive that contains the complete definition of a bot, or you can specify that the
archive contain only the definition of a single bot locale. For more information about
exporting bots, and about the structure of the export archive, see Importing and exporting
bots
# Arguments
- `file_format`: The file format of the bot or bot locale definition files.
- `resource_specification`: Specifies the type of resource to export, either a bot or a bot
locale. You can only specify one type of resource to export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filePassword"`: An password to use to encrypt the exported archive. Using a password is
optional, but you should encrypt the archive to protect the data in transit between Amazon
Lex and your local computer.
"""
function create_export(
fileFormat, resourceSpecification; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/exports/",
Dict{String,Any}(
"fileFormat" => fileFormat, "resourceSpecification" => resourceSpecification
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_export(
fileFormat,
resourceSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/exports/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fileFormat" => fileFormat,
"resourceSpecification" => resourceSpecification,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_intent(bot_id, bot_version, intent_name, locale_id)
create_intent(bot_id, bot_version, intent_name, locale_id, params::Dict{String,<:Any})
Creates an intent. To define the interaction between the user and your bot, you define one
or more intents. For example, for a pizza ordering bot you would create an OrderPizza
intent. When you create an intent, you must provide a name. You can optionally provide the
following: Sample utterances. For example, \"I want to order a pizza\" and \"Can I order
a pizza.\" You can't provide utterances for built-in intents. Information to be gathered.
You specify slots for the information that you bot requests from the user. You can specify
standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to
return the intent information to your client application. If you use a Lambda function,
Amazon Lex invokes the function when all of the intent information is available. A
confirmation prompt to send to the user to confirm an intent. For example, \"Shall I order
your pizza?\" A conclusion statement to send to the user after the intent is fulfilled.
For example, \"I ordered your pizza.\" A follow-up prompt that asks the user for
additional activity. For example, \"Do you want a drink with your pizza?\"
# Arguments
- `bot_id`: The identifier of the bot associated with this intent.
- `bot_version`: The version of the bot associated with this intent.
- `intent_name`: The name of the intent. Intent names must be unique in the locale that
contains the intent and cannot match the name of any built-in intent.
- `locale_id`: The identifier of the language and locale where this intent is used. All of
the bots, slot types, and slots used by the intent must have the same locale. For more
information, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the intent. Use the description to help identify the
intent in lists.
- `"dialogCodeHook"`: Specifies that Amazon Lex invokes the alias Lambda function for each
user input. You can invoke this Lambda function to personalize user interaction. For
example, suppose that your bot determines that the user's name is John. You Lambda function
might retrieve John's information from a backend database and prepopulate some of the
values. For example, if you find that John is gluten intolerant, you might set the
corresponding intent slot, glutenIntolerant to true. You might find John's phone number and
set the corresponding session attribute.
- `"fulfillmentCodeHook"`: Specifies that Amazon Lex invokes the alias Lambda function when
the intent is ready for fulfillment. You can invoke this function to complete the bot's
transaction with the user. For example, in a pizza ordering bot, the Lambda function can
look up the closest pizza restaurant to the customer's location and then place an order on
the customer's behalf.
- `"initialResponseSetting"`: Configuration settings for the response that is sent to the
user at the beginning of a conversation, before eliciting slot values.
- `"inputContexts"`: A list of contexts that must be active for this intent to be
considered by Amazon Lex. When an intent has an input context list, Amazon Lex only
considers using the intent in an interaction with the user when the specified contexts are
included in the active context list for the session. If the contexts are not active, then
Amazon Lex will not use the intent. A context can be automatically activated using the
outputContexts property or it can be set at runtime. For example, if there are two intents
with different input contexts that respond to the same utterances, only the intent with the
active context will respond. An intent may have up to 5 input contexts. If an intent has
multiple input contexts, all of the contexts must be active to consider the intent.
- `"intentClosingSetting"`: Sets the response that Amazon Lex sends to the user when the
intent is closed.
- `"intentConfirmationSetting"`: Provides prompts that Amazon Lex sends to the user to
confirm the completion of an intent. If the user answers \"no,\" the settings contain a
statement that is sent to the user to end the intent.
- `"kendraConfiguration"`: Configuration information required to use the
AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The
AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent
to invoke.
- `"outputContexts"`: A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for
the next turn of the conversation with a customer. When you use the outputContextsList
property, all of the contexts specified in the list are activated when the intent is
fulfilled. You can set up to 10 output contexts. You can also set the number of
conversation turns that the context should be active, or the length of time that the
context should be active.
- `"parentIntentSignature"`: A unique identifier for the built-in intent to base this
intent on.
- `"qnAIntentConfiguration"`: Specifies the configuration of the built-in Amazon.QnAIntent.
The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to
invoke. If you specify this field, you can't specify the kendraConfiguration field.
- `"sampleUtterances"`: An array of strings that a user might say to signal the intent. For
example, \"I want a pizza\", or \"I want a {PizzaSize} pizza\". In an utterance, slot
names are enclosed in curly braces (\"{\", \"}\") to indicate where they should be
displayed in the utterance shown to the user..
"""
function create_intent(
botId,
botVersion,
intentName,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/",
Dict{String,Any}("intentName" => intentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_intent(
botId,
botVersion,
intentName,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("intentName" => intentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_policy(policy, resource_arn)
create_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Creates a new resource policy with the specified policy statements.
# Arguments
- `policy`: A resource policy to add to the resource. The policy is a JSON structure that
contains one or more statements that define the policy. The policy must follow the IAM
syntax. For more information about the contents of a JSON policy document, see IAM JSON
policy reference . If the policy isn't valid, Amazon Lex returns a validation exception.
- `resource_arn`: The Amazon Resource Name (ARN) of the bot or bot alias that the resource
policy is attached to.
"""
function create_resource_policy(
policy, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/policy/$(resourceArn)/",
Dict{String,Any}("policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_policy(
policy,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/policy/$(resourceArn)/",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_policy_statement(action, effect, principal, resource_arn, statement_id)
create_resource_policy_statement(action, effect, principal, resource_arn, statement_id, params::Dict{String,<:Any})
Adds a new resource policy statement to a bot or bot alias. If a resource policy exists,
the statement is added to the current resource policy. If a policy doesn't exist, a new
policy is created. You can't create a resource policy statement that allows cross-account
access.
# Arguments
- `action`: The Amazon Lex action that this policy either allows or denies. The action must
apply to the resource type of the specified ARN. For more information, see Actions,
resources, and condition keys for Amazon Lex V2.
- `effect`: Determines whether the statement allows or denies access to the resource.
- `principal`: An IAM principal, such as an IAM user, IAM role, or Amazon Web Services
services that is allowed or denied access to a resource. For more information, see Amazon
Web Services JSON policy elements: Principal.
- `resource_arn`: The Amazon Resource Name (ARN) of the bot or bot alias that the resource
policy is attached to.
- `statement_id`: The name of the statement. The ID is the same as the Sid IAM property.
The statement name must be unique within the policy. For more information, see IAM JSON
policy elements: Sid.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"condition"`: Specifies a condition when the policy is in effect. If the principal of
the policy is a service principal, you must provide two condition blocks, one with a
SourceAccount global condition key and one with a SourceArn global condition key. For more
information, see IAM JSON policy elements: Condition .
- `"expectedRevisionId"`: The identifier of the revision of the policy to edit. If this
revision ID doesn't match the current revision ID, Amazon Lex throws an exception. If you
don't specify a revision, Amazon Lex overwrites the contents of the policy with the new
values.
"""
function create_resource_policy_statement(
action,
effect,
principal,
resourceArn,
statementId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/policy/$(resourceArn)/statements/",
Dict{String,Any}(
"action" => action,
"effect" => effect,
"principal" => principal,
"statementId" => statementId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_policy_statement(
action,
effect,
principal,
resourceArn,
statementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/policy/$(resourceArn)/statements/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action,
"effect" => effect,
"principal" => principal,
"statementId" => statementId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_slot(bot_id, bot_version, intent_id, locale_id, slot_name, value_elicitation_setting)
create_slot(bot_id, bot_version, intent_id, locale_id, slot_name, value_elicitation_setting, params::Dict{String,<:Any})
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example,
an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot,
you define one or more utterances that Amazon Lex uses to elicit a response from the user.
# Arguments
- `bot_id`: The identifier of the bot associated with the slot.
- `bot_version`: The version of the bot associated with the slot.
- `intent_id`: The identifier of the intent that contains the slot.
- `locale_id`: The identifier of the language and locale that the slot will be used in. The
string must match one of the supported locales. All of the bots, intents, slot types used
by the slot must have the same locale. For more information, see Supported languages.
- `slot_name`: The name of the slot. Slot names must be unique within the bot that contains
the slot.
- `value_elicitation_setting`: Specifies prompts that Amazon Lex sends to the user to
elicit a response that provides the value for the slot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the slot. Use this to help identify the slot in lists.
- `"multipleValuesSetting"`: Indicates whether the slot returns multiple values in one
response. Multi-value slots are only available in the en-US locale. If you set this value
to true in any other locale, Amazon Lex throws a ValidationException. If the
multipleValuesSetting is not set, the default value is false.
- `"obfuscationSetting"`: Determines how slot values are used in Amazon CloudWatch logs. If
the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are
obfuscated in the log output. If the value is None, the actual value is present in the log
output. The default is to obfuscate values in the CloudWatch logs.
- `"slotTypeId"`: The unique identifier for the slot type associated with this slot. The
slot type determines the values that can be entered into the slot.
- `"subSlotSetting"`: Specifications for the constituent sub slots and the expression for
the composite slot.
"""
function create_slot(
botId,
botVersion,
intentId,
localeId,
slotName,
valueElicitationSetting;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/",
Dict{String,Any}(
"slotName" => slotName, "valueElicitationSetting" => valueElicitationSetting
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_slot(
botId,
botVersion,
intentId,
localeId,
slotName,
valueElicitationSetting,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"slotName" => slotName,
"valueElicitationSetting" => valueElicitationSetting,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_slot_type(bot_id, bot_version, locale_id, slot_type_name)
create_slot_type(bot_id, bot_version, locale_id, slot_type_name, params::Dict{String,<:Any})
Creates a custom slot type To create a custom slot type, specify a name for the slot type
and a set of enumeration values, the values that a slot of this type can assume.
# Arguments
- `bot_id`: The identifier of the bot associated with this slot type.
- `bot_version`: The identifier of the bot version associated with this slot type.
- `locale_id`: The identifier of the language and locale that the slot type will be used
in. The string must match one of the supported locales. All of the bots, intents, and slots
used by the slot type must have the same locale. For more information, see Supported
languages.
- `slot_type_name`: The name for the slot. A slot type name must be unique within the
intent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compositeSlotTypeSetting"`: Specifications for a composite slot type.
- `"description"`: A description of the slot type. Use the description to help identify the
slot type in lists.
- `"externalSourceSetting"`: Sets the type of external information used to create the slot
type.
- `"parentSlotTypeSignature"`: The built-in slot type used as a parent of this slot type.
When you define a parent slot type, the new slot type has the configuration of the parent
slot type. Only AMAZON.AlphaNumeric is supported.
- `"slotTypeValues"`: A list of SlotTypeValue objects that defines the values that the slot
type can take. Each value can have a list of synonyms, additional values that help train
the machine learning model about the values that it resolves for a slot.
- `"valueSelectionSetting"`: Determines the strategy that Amazon Lex uses to select a value
from the list of possible values. The field can be set to one of the following values:
ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the
slot value. TOP_RESOLUTION - If there is a resolution list for the slot, return the
first value in the resolution list. If there is no resolution list, return null. If you
don't specify the valueSelectionSetting parameter, the default is ORIGINAL_VALUE.
"""
function create_slot_type(
botId,
botVersion,
localeId,
slotTypeName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/",
Dict{String,Any}("slotTypeName" => slotTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_slot_type(
botId,
botVersion,
localeId,
slotTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("slotTypeName" => slotTypeName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_test_set_discrepancy_report(target, test_set_id)
create_test_set_discrepancy_report(target, test_set_id, params::Dict{String,<:Any})
Create a report that describes the differences between the bot and the test set.
# Arguments
- `target`: The target bot for the test set discrepancy report.
- `test_set_id`: The test set Id for the test set discrepancy report.
"""
function create_test_set_discrepancy_report(
target, testSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/testsets/$(testSetId)/testsetdiscrepancy",
Dict{String,Any}("target" => target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_test_set_discrepancy_report(
target,
testSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/testsets/$(testSetId)/testsetdiscrepancy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("target" => target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_upload_url()
create_upload_url(params::Dict{String,<:Any})
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot
or a bot locale.
"""
function create_upload_url(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST", "/createuploadurl/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_upload_url(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/createuploadurl/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot(bot_id)
delete_bot(bot_id, params::Dict{String,<:Any})
Deletes all versions of a bot, including the Draft version. To delete a specific version,
use the DeleteBotVersion operation. When you delete a bot, all of the resources contained
in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot
types defined for the bot. If a bot has an alias, the DeleteBot operation returns a
ResourceInUseException exception. If you want to delete the bot and the alias, set the
skipResourceInUseCheck parameter to true.
# Arguments
- `bot_id`: The identifier of the bot to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"skipResourceInUseCheck"`: By default, Amazon Lex checks if any other resource, such as
an alias or bot network, is using the bot version before it is deleted and throws a
ResourceInUseException exception if the bot is being used by another resource. Set this
parameter to true to skip this check and remove the bot even if it is being used by another
resource.
"""
function delete_bot(botId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"DELETE", "/bots/$(botId)/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_bot(
botId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_alias(bot_alias_id, bot_id)
delete_bot_alias(bot_alias_id, bot_id, params::Dict{String,<:Any})
Deletes the specified bot alias.
# Arguments
- `bot_alias_id`: The unique identifier of the bot alias to delete.
- `bot_id`: The unique identifier of the bot associated with the alias to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"skipResourceInUseCheck"`: By default, Amazon Lex checks if any other resource, such as
a bot network, is using the bot alias before it is deleted and throws a
ResourceInUseException exception if the alias is being used by another resource. Set this
parameter to true to skip this check and remove the alias even if it is being used by
another resource.
"""
function delete_bot_alias(
botAliasId, botId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botaliases/$(botAliasId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_alias(
botAliasId,
botId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botaliases/$(botAliasId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_locale(bot_id, bot_version, locale_id)
delete_bot_locale(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Removes a locale from a bot. When you delete a locale, all intents, slots, and slot types
defined for the locale are also deleted.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the locale.
- `bot_version`: The version of the bot that contains the locale.
- `locale_id`: The identifier of the language and locale that will be deleted. The string
must match one of the supported locales. For more information, see Supported languages.
"""
function delete_bot_locale(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_locale(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_replica(bot_id, replica_region)
delete_bot_replica(bot_id, replica_region, params::Dict{String,<:Any})
The action to delete the replicated bot in the secondary region.
# Arguments
- `bot_id`: The unique ID of the replicated bot to be deleted from the secondary region
- `replica_region`: The secondary region of the replicated bot that will be deleted.
"""
function delete_bot_replica(
botId, replicaRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/replicas/$(replicaRegion)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_replica(
botId,
replicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/replicas/$(replicaRegion)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bot_version(bot_id, bot_version)
delete_bot_version(bot_id, bot_version, params::Dict{String,<:Any})
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot
operation.
# Arguments
- `bot_id`: The identifier of the bot that contains the version.
- `bot_version`: The version of the bot to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"skipResourceInUseCheck"`: By default, Amazon Lex checks if any other resource, such as
an alias or bot network, is using the bot version before it is deleted and throws a
ResourceInUseException exception if the version is being used by another resource. Set this
parameter to true to skip this check and remove the version even if it is being used by
another resource.
"""
function delete_bot_version(
botId, botVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bot_version(
botId,
botVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_vocabulary(bot_id, bot_version, locale_id)
delete_custom_vocabulary(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Removes a custom vocabulary from the specified locale in the specified bot.
# Arguments
- `bot_id`: The unique identifier of the bot to remove the custom vocabulary from.
- `bot_version`: The version of the bot to remove the custom vocabulary from.
- `locale_id`: The locale identifier for the locale that contains the custom vocabulary to
remove.
"""
function delete_custom_vocabulary(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_vocabulary(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_export(export_id)
delete_export(export_id, params::Dict{String,<:Any})
Removes a previous export and the associated files stored in an S3 bucket.
# Arguments
- `export_id`: The unique identifier of the export to delete.
"""
function delete_export(exportId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"DELETE",
"/exports/$(exportId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_export(
exportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/exports/$(exportId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_import(import_id)
delete_import(import_id, params::Dict{String,<:Any})
Removes a previous import and the associated file stored in an S3 bucket.
# Arguments
- `import_id`: The unique identifier of the import to delete.
"""
function delete_import(importId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"DELETE",
"/imports/$(importId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_import(
importId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/imports/$(importId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_intent(bot_id, bot_version, intent_id, locale_id)
delete_intent(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})
Removes the specified intent. Deleting an intent also deletes the slots associated with the
intent.
# Arguments
- `bot_id`: The identifier of the bot associated with the intent.
- `bot_version`: The version of the bot associated with the intent.
- `intent_id`: The unique identifier of the intent to delete.
- `locale_id`: The identifier of the language and locale where the bot will be deleted. The
string must match one of the supported locales. For more information, see Supported
languages.
"""
function delete_intent(
botId, botVersion, intentId, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_intent(
botId,
botVersion,
intentId,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy
attached, Amazon Lex returns an exception.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the bot or bot alias that has the
resource policy attached.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedRevisionId"`: The identifier of the revision to edit. If this ID doesn't match
the current revision number, Amazon Lex returns an exception If you don't specify a
revision ID, Amazon Lex will delete the current policy.
"""
function delete_resource_policy(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/policy/$(resourceArn)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/policy/$(resourceArn)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy_statement(resource_arn, statement_id)
delete_resource_policy_statement(resource_arn, statement_id, params::Dict{String,<:Any})
Deletes a policy statement from a resource policy. If you delete the last statement from a
policy, the policy is deleted. If you specify a statement ID that doesn't exist in the
policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an
exception.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the bot or bot alias that the resource
policy is attached to.
- `statement_id`: The name of the statement (SID) to delete from the policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedRevisionId"`: The identifier of the revision of the policy to delete the
statement from. If this revision ID doesn't match the current revision ID, Amazon Lex
throws an exception. If you don't specify a revision, Amazon Lex removes the current
contents of the statement.
"""
function delete_resource_policy_statement(
resourceArn, statementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/policy/$(resourceArn)/statements/$(statementId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy_statement(
resourceArn,
statementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/policy/$(resourceArn)/statements/$(statementId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_slot(bot_id, bot_version, intent_id, locale_id, slot_id)
delete_slot(bot_id, bot_version, intent_id, locale_id, slot_id, params::Dict{String,<:Any})
Deletes the specified slot from an intent.
# Arguments
- `bot_id`: The identifier of the bot associated with the slot to delete.
- `bot_version`: The version of the bot associated with the slot to delete.
- `intent_id`: The identifier of the intent associated with the slot.
- `locale_id`: The identifier of the language and locale that the slot will be deleted
from. The string must match one of the supported locales. For more information, see
Supported languages.
- `slot_id`: The identifier of the slot to delete.
"""
function delete_slot(
botId,
botVersion,
intentId,
localeId,
slotId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/$(slotId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_slot(
botId,
botVersion,
intentId,
localeId,
slotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/$(slotId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_slot_type(bot_id, bot_version, locale_id, slot_type_id)
delete_slot_type(bot_id, bot_version, locale_id, slot_type_id, params::Dict{String,<:Any})
Deletes a slot type from a bot locale. If a slot is using the slot type, Amazon Lex throws
a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck
parameter to true.
# Arguments
- `bot_id`: The identifier of the bot associated with the slot type.
- `bot_version`: The version of the bot associated with the slot type.
- `locale_id`: The identifier of the language and locale that the slot type will be deleted
from. The string must match one of the supported locales. For more information, see
Supported languages.
- `slot_type_id`: The identifier of the slot type to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"skipResourceInUseCheck"`: By default, the DeleteSlotType operations throws a
ResourceInUseException exception if you try to delete a slot type used by a slot. Set the
skipResourceInUseCheck parameter to true to skip this check and remove the slot type even
if a slot uses it.
"""
function delete_slot_type(
botId,
botVersion,
localeId,
slotTypeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_slot_type(
botId,
botVersion,
localeId,
slotTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_test_set(test_set_id)
delete_test_set(test_set_id, params::Dict{String,<:Any})
The action to delete the selected test set.
# Arguments
- `test_set_id`: The test set Id of the test set to be deleted.
"""
function delete_test_set(testSetId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"DELETE",
"/testsets/$(testSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_test_set(
testSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/testsets/$(testSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_utterances(bot_id)
delete_utterances(bot_id, params::Dict{String,<:Any})
Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot.
Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and
then stored indefinitely for use in improving the ability of your bot to respond to user
input.. Use the DeleteUtterances operation to manually delete utterances for a specific
session. When you use the DeleteUtterances operation, utterances stored for improving your
bot's ability to respond to user input are deleted immediately. Utterances stored for use
with the ListAggregatedUtterances operation are deleted after 15 days.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the utterances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"localeId"`: The identifier of the language and locale where the utterances were
collected. The string must match one of the supported locales. For more information, see
Supported languages.
- `"sessionId"`: The unique identifier of the session with the user. The ID is returned in
the response from the RecognizeText and RecognizeUtterance operations.
"""
function delete_utterances(botId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"DELETE",
"/bots/$(botId)/utterances/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_utterances(
botId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/bots/$(botId)/utterances/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot(bot_id)
describe_bot(bot_id, params::Dict{String,<:Any})
Provides metadata information about a bot.
# Arguments
- `bot_id`: The unique identifier of the bot to describe.
"""
function describe_bot(botId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"GET", "/bots/$(botId)/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_bot(
botId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot_alias(bot_alias_id, bot_id)
describe_bot_alias(bot_alias_id, bot_id, params::Dict{String,<:Any})
Get information about a specific bot alias.
# Arguments
- `bot_alias_id`: The identifier of the bot alias to describe.
- `bot_id`: The identifier of the bot associated with the bot alias to describe.
"""
function describe_bot_alias(
botAliasId, botId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botaliases/$(botAliasId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bot_alias(
botAliasId,
botId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botaliases/$(botAliasId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot_locale(bot_id, bot_version, locale_id)
describe_bot_locale(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Describes the settings that a bot has for a specific locale.
# Arguments
- `bot_id`: The identifier of the bot associated with the locale.
- `bot_version`: The version of the bot associated with the locale.
- `locale_id`: The unique identifier of the locale to describe. The string must match one
of the supported locales. For more information, see Supported languages.
"""
function describe_bot_locale(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bot_locale(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id)
describe_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id, params::Dict{String,<:Any})
Provides metadata information about a bot recommendation. This information will enable you
to get a description on the request inputs, to download associated transcripts after
processing is complete, and to download intents and slot-types generated by the bot
recommendation.
# Arguments
- `bot_id`: The unique identifier of the bot associated with the bot recommendation.
- `bot_recommendation_id`: The identifier of the bot recommendation to describe.
- `bot_version`: The version of the bot associated with the bot recommendation.
- `locale_id`: The identifier of the language and locale of the bot recommendation to
describe. The string must match one of the supported locales. For more information, see
Supported languages.
"""
function describe_bot_recommendation(
botId,
botRecommendationId,
botVersion,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bot_recommendation(
botId,
botRecommendationId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot_replica(bot_id, replica_region)
describe_bot_replica(bot_id, replica_region, params::Dict{String,<:Any})
Monitors the bot replication status through the UI console.
# Arguments
- `bot_id`: The request for the unique bot ID of the replicated bot being monitored.
- `replica_region`: The request for the region of the replicated bot being monitored.
"""
function describe_bot_replica(
botId, replicaRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/replicas/$(replicaRegion)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bot_replica(
botId,
replicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/replicas/$(replicaRegion)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot_resource_generation(bot_id, bot_version, generation_id, locale_id)
describe_bot_resource_generation(bot_id, bot_version, generation_id, locale_id, params::Dict{String,<:Any})
Returns information about a request to generate a bot through natural language description,
made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon
S3 object containing the bot locale configuration. You can then modify and import this
configuration.
# Arguments
- `bot_id`: The unique identifier of the bot for which to return the generation details.
- `bot_version`: The version of the bot for which to return the generation details.
- `generation_id`: The unique identifier of the generation request for which to return the
generation details.
- `locale_id`: The locale of the bot for which to return the generation details.
"""
function describe_bot_resource_generation(
botId,
botVersion,
generationId,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/generations/$(generationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bot_resource_generation(
botId,
botVersion,
generationId,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/generations/$(generationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bot_version(bot_id, bot_version)
describe_bot_version(bot_id, bot_version, params::Dict{String,<:Any})
Provides metadata about a version of a bot.
# Arguments
- `bot_id`: The identifier of the bot containing the version to return metadata for.
- `bot_version`: The version of the bot to return metadata for.
"""
function describe_bot_version(
botId, botVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bot_version(
botId,
botVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_vocabulary_metadata(bot_id, bot_version, locale_id)
describe_custom_vocabulary_metadata(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Provides metadata information about a custom vocabulary.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the custom vocabulary.
- `bot_version`: The bot version of the bot to return metadata for.
- `locale_id`: The locale to return the custom vocabulary information for. The locale must
be en_GB.
"""
function describe_custom_vocabulary_metadata(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_vocabulary_metadata(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_export(export_id)
describe_export(export_id, params::Dict{String,<:Any})
Gets information about a specific export.
# Arguments
- `export_id`: The unique identifier of the export to describe.
"""
function describe_export(exportId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"GET",
"/exports/$(exportId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_export(
exportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/exports/$(exportId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_import(import_id)
describe_import(import_id, params::Dict{String,<:Any})
Gets information about a specific import.
# Arguments
- `import_id`: The unique identifier of the import to describe.
"""
function describe_import(importId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"GET",
"/imports/$(importId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_import(
importId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/imports/$(importId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_intent(bot_id, bot_version, intent_id, locale_id)
describe_intent(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})
Returns metadata about an intent.
# Arguments
- `bot_id`: The identifier of the bot associated with the intent.
- `bot_version`: The version of the bot associated with the intent.
- `intent_id`: The identifier of the intent to describe.
- `locale_id`: The identifier of the language and locale of the intent to describe. The
string must match one of the supported locales. For more information, see Supported
languages.
"""
function describe_intent(
botId, botVersion, intentId, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_intent(
botId,
botVersion,
intentId,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_policy(resource_arn)
describe_resource_policy(resource_arn, params::Dict{String,<:Any})
Gets the resource policy and policy revision for a bot or bot alias.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the bot or bot alias that the resource
policy is attached to.
"""
function describe_resource_policy(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/policy/$(resourceArn)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_policy(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/policy/$(resourceArn)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_slot(bot_id, bot_version, intent_id, locale_id, slot_id)
describe_slot(bot_id, bot_version, intent_id, locale_id, slot_id, params::Dict{String,<:Any})
Gets metadata information about a slot.
# Arguments
- `bot_id`: The identifier of the bot associated with the slot.
- `bot_version`: The version of the bot associated with the slot.
- `intent_id`: The identifier of the intent that contains the slot.
- `locale_id`: The identifier of the language and locale of the slot to describe. The
string must match one of the supported locales. For more information, see Supported
languages.
- `slot_id`: The unique identifier for the slot.
"""
function describe_slot(
botId,
botVersion,
intentId,
localeId,
slotId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/$(slotId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_slot(
botId,
botVersion,
intentId,
localeId,
slotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/$(slotId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_slot_type(bot_id, bot_version, locale_id, slot_type_id)
describe_slot_type(bot_id, bot_version, locale_id, slot_type_id, params::Dict{String,<:Any})
Gets metadata information about a slot type.
# Arguments
- `bot_id`: The identifier of the bot associated with the slot type.
- `bot_version`: The version of the bot associated with the slot type.
- `locale_id`: The identifier of the language and locale of the slot type to describe. The
string must match one of the supported locales. For more information, see Supported
languages.
- `slot_type_id`: The identifier of the slot type.
"""
function describe_slot_type(
botId,
botVersion,
localeId,
slotTypeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_slot_type(
botId,
botVersion,
localeId,
slotTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_test_execution(test_execution_id)
describe_test_execution(test_execution_id, params::Dict{String,<:Any})
Gets metadata information about the test execution.
# Arguments
- `test_execution_id`: The execution Id of the test set execution.
"""
function describe_test_execution(
testExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/testexecutions/$(testExecutionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_test_execution(
testExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/testexecutions/$(testExecutionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_test_set(test_set_id)
describe_test_set(test_set_id, params::Dict{String,<:Any})
Gets metadata information about the test set.
# Arguments
- `test_set_id`: The test set Id for the test set request.
"""
function describe_test_set(testSetId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"GET",
"/testsets/$(testSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_test_set(
testSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/testsets/$(testSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_test_set_discrepancy_report(test_set_discrepancy_report_id)
describe_test_set_discrepancy_report(test_set_discrepancy_report_id, params::Dict{String,<:Any})
Gets metadata information about the test set discrepancy report.
# Arguments
- `test_set_discrepancy_report_id`: The unique identifier of the test set discrepancy
report.
"""
function describe_test_set_discrepancy_report(
testSetDiscrepancyReportId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/testsetdiscrepancy/$(testSetDiscrepancyReportId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_test_set_discrepancy_report(
testSetDiscrepancyReportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/testsetdiscrepancy/$(testSetDiscrepancyReportId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_test_set_generation(test_set_generation_id)
describe_test_set_generation(test_set_generation_id, params::Dict{String,<:Any})
Gets metadata information about the test set generation.
# Arguments
- `test_set_generation_id`: The unique identifier of the test set generation.
"""
function describe_test_set_generation(
testSetGenerationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/testsetgenerations/$(testSetGenerationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_test_set_generation(
testSetGenerationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/testsetgenerations/$(testSetGenerationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_bot_element(bot_id, bot_version, intent_id, locale_id)
generate_bot_element(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})
Generates sample utterances for an intent.
# Arguments
- `bot_id`: The bot unique Id for the bot request to generate utterances.
- `bot_version`: The bot version for the bot request to generate utterances.
- `intent_id`: The intent unique Id for the bot request to generate utterances.
- `locale_id`: The unique locale Id for the bot request to generate utterances.
"""
function generate_bot_element(
botId, botVersion, intentId, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/generate",
Dict{String,Any}("intentId" => intentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_bot_element(
botId,
botVersion,
intentId,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/generate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("intentId" => intentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_test_execution_artifacts_url(test_execution_id)
get_test_execution_artifacts_url(test_execution_id, params::Dict{String,<:Any})
The pre-signed Amazon S3 URL to download the test execution result artifacts.
# Arguments
- `test_execution_id`: The unique identifier of the completed test execution.
"""
function get_test_execution_artifacts_url(
testExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/testexecutions/$(testExecutionId)/artifacturl";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_test_execution_artifacts_url(
testExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/testexecutions/$(testExecutionId)/artifacturl",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_aggregated_utterances(aggregation_duration, bot_id, locale_id)
list_aggregated_utterances(aggregation_duration, bot_id, locale_id, params::Dict{String,<:Any})
Provides a list of utterances that users have sent to the bot. Utterances are aggregated by
the text of the utterance. For example, all instances where customers used the phrase \"I
want to order pizza\" are aggregated into the same line in the response. You can see both
detected utterances and missed utterances. A detected utterance is where the bot properly
recognized the utterance and activated the associated intent. A missed utterance was not
recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot
alias or for a bot version, but not both at the same time. Utterances statistics are not
generated under the following conditions: The childDirected field was set to true when
the bot was created. You are using slot obfuscation with one or more slots. You opted
out of participating in improving Amazon Lex.
# Arguments
- `aggregation_duration`: The time window for aggregating the utterance information. You
can specify a time between one hour and two weeks.
- `bot_id`: The unique identifier of the bot associated with this request.
- `locale_id`: The identifier of the language and locale where the utterances were
collected. For more information, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botAliasId"`: The identifier of the bot alias associated with this request. If you
specify the bot alias, you can't specify the bot version.
- `"botVersion"`: The identifier of the bot version associated with this request. If you
specify the bot version, you can't specify the bot alias.
- `"filters"`: Provides the specification of a filter used to limit the utterances in the
response to only those that match the filter specification. You can only specify one filter
and one string to filter on.
- `"maxResults"`: The maximum number of utterances to return in each page of results. If
there are fewer results than the maximum page size, only the actual number of results are
returned. If you don't specify the maxResults parameter, 1,000 results are returned.
- `"nextToken"`: If the response from the ListAggregatedUtterances operation contains more
results that specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
- `"sortBy"`: Specifies sorting parameters for the list of utterances. You can sort by the
hit count, the missed count, or the number of distinct sessions the utterance appeared in.
"""
function list_aggregated_utterances(
aggregationDuration, botId, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/aggregatedutterances/",
Dict{String,Any}(
"aggregationDuration" => aggregationDuration, "localeId" => localeId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_aggregated_utterances(
aggregationDuration,
botId,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/aggregatedutterances/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"aggregationDuration" => aggregationDuration, "localeId" => localeId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_alias_replicas(bot_id, replica_region)
list_bot_alias_replicas(bot_id, replica_region, params::Dict{String,<:Any})
The action to list the replicated bots created from the source bot alias.
# Arguments
- `bot_id`: The request for the unique bot ID of the replicated bot created from the source
bot alias.
- `replica_region`: The request for the secondary region of the replicated bot created from
the source bot alias.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The request for maximum results to list the replicated bots created from
the source bot alias.
- `"nextToken"`: The request for the next token for the replicated bot created from the
source bot alias.
"""
function list_bot_alias_replicas(
botId, replicaRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/replicas/$(replicaRegion)/botaliases/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_alias_replicas(
botId,
replicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/replicas/$(replicaRegion)/botaliases/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_aliases(bot_id)
list_bot_aliases(bot_id, params::Dict{String,<:Any})
Gets a list of aliases for the specified bot.
# Arguments
- `bot_id`: The identifier of the bot to list aliases for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of aliases to return in each page of results. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListBotAliases operation contains more results
than specified in the maxResults parameter, a token is returned in the response. Use that
token in the nextToken parameter to return the next page of results.
"""
function list_bot_aliases(botId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST",
"/bots/$(botId)/botaliases/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_aliases(
botId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botaliases/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_locales(bot_id, bot_version)
list_bot_locales(bot_id, bot_version, params::Dict{String,<:Any})
Gets a list of locales for the specified bot.
# Arguments
- `bot_id`: The identifier of the bot to list locales for.
- `bot_version`: The version of the bot to list locales for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Provides the specification for a filter used to limit the response to only
those locales that match the filter specification. You can only specify one filter and one
value to filter on.
- `"maxResults"`: The maximum number of aliases to return in each page of results. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListBotLocales operation contains more results
than specified in the maxResults parameter, a token is returned in the response. Use that
token as the nextToken parameter to return the next page of results.
- `"sortBy"`: Specifies sorting parameters for the list of locales. You can sort by locale
name in ascending or descending order.
"""
function list_bot_locales(
botId, botVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_locales(
botId,
botVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_recommendations(bot_id, bot_version, locale_id)
list_bot_recommendations(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Get a list of bot recommendations that meet the specified criteria.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the bot recommendation list.
- `bot_version`: The version of the bot that contains the bot recommendation list.
- `locale_id`: The identifier of the language and locale of the bot recommendation list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of bot recommendations to return in each page of
results. If there are fewer results than the max page size, only the actual number of
results are returned.
- `"nextToken"`: If the response from the ListBotRecommendation operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
"""
function list_bot_recommendations(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_recommendations(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_replicas(bot_id)
list_bot_replicas(bot_id, params::Dict{String,<:Any})
The action to list the replicated bots.
# Arguments
- `bot_id`: The request for the unique bot IDs in the list of replicated bots.
"""
function list_bot_replicas(botId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST",
"/bots/$(botId)/replicas/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_replicas(
botId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/replicas/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_resource_generations(bot_id, bot_version, locale_id)
list_bot_resource_generations(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Lists the generation requests made for a bot locale.
# Arguments
- `bot_id`: The unique identifier of the bot whose generation requests you want to view.
- `bot_version`: The version of the bot whose generation requests you want to view.
- `locale_id`: The locale of the bot whose generation requests you want to view.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: If the total number of results is greater than the number specified in the
maxResults, the response returns a token in the nextToken field. Use this token when making
a request to return the next batch of results.
- `"sortBy"`: An object containing information about the attribute and the method by which
to sort the results
"""
function list_bot_resource_generations(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/generations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_resource_generations(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/generations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_version_replicas(bot_id, replica_region)
list_bot_version_replicas(bot_id, replica_region, params::Dict{String,<:Any})
Contains information about all the versions replication statuses applicable for Global
Resiliency.
# Arguments
- `bot_id`: The request for the unique ID in the list of replicated bots.
- `replica_region`: The request for the region used in the list of replicated bots.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum results given in the list of replicated bots.
- `"nextToken"`: The next token given in the list of replicated bots.
- `"sortBy"`: The requested sort category for the list of replicated bots.
"""
function list_bot_version_replicas(
botId, replicaRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/replicas/$(replicaRegion)/botversions/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_version_replicas(
botId,
replicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/replicas/$(replicaRegion)/botversions/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bot_versions(bot_id)
list_bot_versions(bot_id, params::Dict{String,<:Any})
Gets information about all of the versions of a bot. The ListBotVersions operation returns
a summary of each version of a bot. For example, if a bot has three numbered versions, the
ListBotVersions operation returns for summaries, one for each numbered version and one for
the DRAFT version. The ListBotVersions operation always returns at least one version, the
DRAFT version.
# Arguments
- `bot_id`: The identifier of the bot to list versions for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of versions to return in each page of results. If
there are fewer results than the max page size, only the actual number of results are
returned.
- `"nextToken"`: If the response to the ListBotVersion operation contains more results than
specified in the maxResults parameter, a token is returned in the response. Use that token
in the nextToken parameter to return the next page of results.
- `"sortBy"`: Specifies sorting parameters for the list of versions. You can specify that
the list be sorted by version name in either ascending or descending order.
"""
function list_bot_versions(botId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bot_versions(
botId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bots()
list_bots(params::Dict{String,<:Any})
Gets a list of available bots.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Provides the specification of a filter used to limit the bots in the
response to only those that match the filter specification. You can only specify one filter
and one string to filter on.
- `"maxResults"`: The maximum number of bots to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListBots operation contains more results than
specified in the maxResults parameter, a token is returned in the response. Use the
returned token in the nextToken parameter of a ListBots request to return the next page of
results. For a complete set of results, call the ListBots operation until the nextToken
returned in the response is null.
- `"sortBy"`: Specifies sorting parameters for the list of bots. You can specify that the
list be sorted by bot name in ascending or descending order.
"""
function list_bots(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST", "/bots/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_bots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST", "/bots/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_built_in_intents(locale_id)
list_built_in_intents(locale_id, params::Dict{String,<:Any})
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. To
use a built-in intent as a the base for your own intent, include the built-in intent
signature in the parentIntentSignature parameter when you call the CreateIntent operation.
For more information, see CreateIntent.
# Arguments
- `locale_id`: The identifier of the language and locale of the intents to list. The string
must match one of the supported locales. For more information, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of built-in intents to return in each page of results.
If there are fewer results than the max page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListBuiltInIntents operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
- `"sortBy"`: Specifies sorting parameters for the list of built-in intents. You can
specify that the list be sorted by the built-in intent signature in either ascending or
descending order.
"""
function list_built_in_intents(localeId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST",
"/builtins/locales/$(localeId)/intents/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_built_in_intents(
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/builtins/locales/$(localeId)/intents/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_built_in_slot_types(locale_id)
list_built_in_slot_types(locale_id, params::Dict{String,<:Any})
Gets a list of built-in slot types that meet the specified criteria.
# Arguments
- `locale_id`: The identifier of the language and locale of the slot types to list. The
string must match one of the supported locales. For more information, see Supported
languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of built-in slot types to return in each page of
results. If there are fewer results than the max page size, only the actual number of
results are returned.
- `"nextToken"`: If the response from the ListBuiltInSlotTypes operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
- `"sortBy"`: Determines the sort order for the response from the ListBuiltInSlotTypes
operation. You can choose to sort by the slot type signature in either ascending or
descending order.
"""
function list_built_in_slot_types(
localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/builtins/locales/$(localeId)/slottypes/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_built_in_slot_types(
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/builtins/locales/$(localeId)/slottypes/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_vocabulary_items(bot_id, bot_version, locale_id)
list_custom_vocabulary_items(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
# Arguments
- `bot_id`: The identifier of the version of the bot associated with this custom vocabulary.
- `bot_version`: The bot version of the bot to the list custom vocabulary request.
- `locale_id`: The identifier of the language and locale where this custom vocabulary is
used. The string must match one of the supported locales. For more information, see
Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items returned by the list operation.
- `"nextToken"`: The nextToken identifier to the list custom vocabulary request.
"""
function list_custom_vocabulary_items(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_vocabulary_items(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/customvocabulary/DEFAULT/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_exports()
list_exports(params::Dict{String,<:Any})
Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list
for 7 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botId"`: The unique identifier that Amazon Lex assigned to the bot.
- `"botVersion"`: The version of the bot to list exports for.
- `"filters"`: Provides the specification of a filter used to limit the exports in the
response to only those that match the filter specification. You can only specify one filter
and one string to filter on.
- `"localeId"`: Specifies the resources that should be exported. If you don't specify a
resource type in the filters parameter, both bot locales and custom vocabularies are
exported.
- `"maxResults"`: The maximum number of exports to return in each page of results. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListExports operation contains more results that
specified in the maxResults parameter, a token is returned in the response. Use the
returned token in the nextToken parameter of a ListExports request to return the next page
of results. For a complete set of results, call the ListExports operation until the
nextToken returned in the response is null.
- `"sortBy"`: Determines the field that the list of exports is sorted by. You can sort by
the LastUpdatedDateTime field in ascending or descending order.
"""
function list_exports(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST", "/exports/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_exports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST", "/exports/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_imports()
list_imports(params::Dict{String,<:Any})
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list
for 7 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botId"`: The unique identifier that Amazon Lex assigned to the bot.
- `"botVersion"`: The version of the bot to list imports for.
- `"filters"`: Provides the specification of a filter used to limit the bots in the
response to only those that match the filter specification. You can only specify one filter
and one string to filter on.
- `"localeId"`: Specifies the locale that should be present in the list. If you don't
specify a resource type in the filters parameter, the list contains both bot locales and
custom vocabularies.
- `"maxResults"`: The maximum number of imports to return in each page of results. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListImports operation contains more results than
specified in the maxResults parameter, a token is returned in the response. Use the
returned token in the nextToken parameter of a ListImports request to return the next page
of results. For a complete set of results, call the ListImports operation until the
nextToken returned in the response is null.
- `"sortBy"`: Determines the field that the list of imports is sorted by. You can sort by
the LastUpdatedDateTime field in ascending or descending order.
"""
function list_imports(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST", "/imports/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_imports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST", "/imports/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_intent_metrics(bot_id, end_date_time, metrics, start_date_time)
list_intent_metrics(bot_id, end_date_time, metrics, start_date_time, params::Dict{String,<:Any})
Retrieves summary metrics for the intents in your bot. The following fields are required:
metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to
specify the metric to calculate, the statistic field to specify whether to calculate the
Sum, Average, or Max number, and the order field to specify whether to sort the results in
Ascending or Descending order. startDateTime and endDateTime – Define a time range for
which you want to retrieve results. Of the optional fields, you can organize the results
in the following ways: Use the filters field to filter the results, the groupBy field to
specify categories by which to group the results, and the binBy field to specify time
intervals by which to group the results. Use the maxResults field to limit the number of
results to return in a single response and the nextToken field to return the next batch of
results if the response does not return the full set of results. Note that an order field
exists in both binBy and metrics. You can specify only one order in a given request.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve intent metrics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see intent metrics.
- `metrics`: A list of objects, each of which contains a metric you want to list, the
statistic for the metric you want to return, and the order by which to organize the results.
- `start_date_time`: The timestamp that marks the beginning of the range of time for which
you want to see intent metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"binBy"`: A list of objects, each of which contains specifications for organizing the
results by time.
- `"filters"`: A list of objects, each of which describes a condition by which you want to
filter the results.
- `"groupBy"`: A list of objects, each of which specifies how to group the results. You can
group by the following criteria: IntentName – The name of the intent.
IntentEndState – The final state of the intent. The possible end states are detailed in
Key definitions in the user guide.
- `"maxResults"`: The maximum number of results to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListIntentMetrics operation contains more results
than specified in the maxResults parameter, a token is returned in the response. Use the
returned token in the nextToken parameter of a ListIntentMetrics request to return the next
page of results. For a complete set of results, call the ListIntentMetrics operation until
the nextToken returned in the response is null.
"""
function list_intent_metrics(
botId,
endDateTime,
metrics,
startDateTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/intentmetrics",
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_intent_metrics(
botId,
endDateTime,
metrics,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/intentmetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_intent_paths(bot_id, end_date_time, intent_path, start_date_time)
list_intent_paths(bot_id, end_date_time, intent_path, start_date_time, params::Dict{String,<:Any})
Retrieves summary statistics for a path of intents that users take over sessions with your
bot. The following fields are required: startDateTime and endDateTime – Define a time
range for which you want to retrieve results. intentPath – Define an order of intents
for which you want to retrieve metrics. Separate intents in the path with a forward slash.
For example, populate the intentPath field with /BookCar/BookHotel to see details about how
many times users invoked the BookCar and BookHotel intents in that order. Use the
optional filters field to filter the results.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve intent path metrics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see intent path metrics.
- `intent_path`: The intent path for which you want to retrieve metrics. Use a forward
slash to separate intents in the path. For example: /BookCar /BookCar/BookHotel
/BookHotel/BookCar
- `start_date_time`: The date and time that marks the beginning of the range of time for
which you want to see intent path metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A list of objects, each describes a condition by which you want to filter
the results.
"""
function list_intent_paths(
botId,
endDateTime,
intentPath,
startDateTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/intentpaths",
Dict{String,Any}(
"endDateTime" => endDateTime,
"intentPath" => intentPath,
"startDateTime" => startDateTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_intent_paths(
botId,
endDateTime,
intentPath,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/intentpaths",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime,
"intentPath" => intentPath,
"startDateTime" => startDateTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_intent_stage_metrics(bot_id, end_date_time, metrics, start_date_time)
list_intent_stage_metrics(bot_id, end_date_time, metrics, start_date_time, params::Dict{String,<:Any})
Retrieves summary metrics for the stages within intents in your bot. The following fields
are required: metrics – A list of AnalyticsIntentStageMetric objects. In each object,
use the name field to specify the metric to calculate, the statistic field to specify
whether to calculate the Sum, Average, or Max number, and the order field to specify
whether to sort the results in Ascending or Descending order. startDateTime and
endDateTime – Define a time range for which you want to retrieve results. Of the
optional fields, you can organize the results in the following ways: Use the filters
field to filter the results, the groupBy field to specify categories by which to group the
results, and the binBy field to specify time intervals by which to group the results. Use
the maxResults field to limit the number of results to return in a single response and the
nextToken field to return the next batch of results if the response does not return the
full set of results. Note that an order field exists in both binBy and metrics. You can
only specify one order in a given request.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve intent stage metrics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see intent stage metrics.
- `metrics`: A list of objects, each of which contains a metric you want to list, the
statistic for the metric you want to return, and the method by which to organize the
results.
- `start_date_time`: The date and time that marks the beginning of the range of time for
which you want to see intent stage metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"binBy"`: A list of objects, each of which contains specifications for organizing the
results by time.
- `"filters"`: A list of objects, each of which describes a condition by which you want to
filter the results.
- `"groupBy"`: A list of objects, each of which specifies how to group the results. You can
group by the following criteria: IntentStageName – The name of the intent stage.
SwitchedToIntent – The intent to which the conversation was switched (if any).
- `"maxResults"`: The maximum number of results to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListIntentStageMetrics operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to
return the next page of results. For a complete set of results, call the
ListIntentStageMetrics operation until the nextToken returned in the response is null.
"""
function list_intent_stage_metrics(
botId,
endDateTime,
metrics,
startDateTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/intentstagemetrics",
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_intent_stage_metrics(
botId,
endDateTime,
metrics,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/intentstagemetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_intents(bot_id, bot_version, locale_id)
list_intents(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Get a list of intents that meet the specified criteria.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the intent.
- `bot_version`: The version of the bot that contains the intent.
- `locale_id`: The identifier of the language and locale of the intents to list. The string
must match one of the supported locales. For more information, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Provides the specification of a filter used to limit the intents in the
response to only those that match the filter specification. You can only specify one filter
and only one string to filter on.
- `"maxResults"`: The maximum number of intents to return in each page of results. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListIntents operation contains more results than
specified in the maxResults parameter, a token is returned in the response. Use the
returned token in the nextToken parameter of a ListIntents request to return the next page
of results. For a complete set of results, call the ListIntents operation until the
nextToken returned in the response is null.
- `"sortBy"`: Determines the sort order for the response from the ListIntents operation.
You can choose to sort by the intent name or last updated date in either ascending or
descending order.
"""
function list_intents(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_intents(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommended_intents(bot_id, bot_recommendation_id, bot_version, locale_id)
list_recommended_intents(bot_id, bot_recommendation_id, bot_version, locale_id, params::Dict{String,<:Any})
Gets a list of recommended intents provided by the bot recommendation that you can use in
your bot. Intents in the response are ordered by relevance.
# Arguments
- `bot_id`: The unique identifier of the bot associated with the recommended intents.
- `bot_recommendation_id`: The identifier of the bot recommendation that contains the
recommended intents.
- `bot_version`: The version of the bot that contains the recommended intents.
- `locale_id`: The identifier of the language and locale of the recommended intents.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of bot recommendations to return in each page of
results. If there are fewer results than the max page size, only the actual number of
results are returned.
- `"nextToken"`: If the response from the ListRecommendedIntents operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
"""
function list_recommended_intents(
botId,
botRecommendationId,
botVersion,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/intents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recommended_intents(
botId,
botRecommendationId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/intents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_session_analytics_data(bot_id, end_date_time, start_date_time)
list_session_analytics_data(bot_id, end_date_time, start_date_time, params::Dict{String,<:Any})
Retrieves a list of metadata for individual user sessions with your bot. The startDateTime
and endDateTime fields are required. These fields define a time range for which you want to
retrieve results. Of the optional fields, you can organize the results in the following
ways: Use the filters field to filter the results and the sortBy field to specify the
values by which to sort the results. Use the maxResults field to limit the number of
results to return in a single response and the nextToken field to return the next batch of
results if the response does not return the full set of results.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve session analytics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see session analytics.
- `start_date_time`: The date and time that marks the beginning of the range of time for
which you want to see session analytics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A list of objects, each of which describes a condition by which you want to
filter the results.
- `"maxResults"`: The maximum number of results to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListSessionAnalyticsData operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to
return the next page of results. For a complete set of results, call the
ListSessionAnalyticsData operation until the nextToken returned in the response is null.
- `"sortBy"`: An object specifying the measure and method by which to sort the session
analytics data.
"""
function list_session_analytics_data(
botId, endDateTime, startDateTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/sessions",
Dict{String,Any}("endDateTime" => endDateTime, "startDateTime" => startDateTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_session_analytics_data(
botId,
endDateTime,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/sessions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime, "startDateTime" => startDateTime
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_session_metrics(bot_id, end_date_time, metrics, start_date_time)
list_session_metrics(bot_id, end_date_time, metrics, start_date_time, params::Dict{String,<:Any})
Retrieves summary metrics for the user sessions with your bot. The following fields are
required: metrics – A list of AnalyticsSessionMetric objects. In each object, use the
name field to specify the metric to calculate, the statistic field to specify whether to
calculate the Sum, Average, or Max number, and the order field to specify whether to sort
the results in Ascending or Descending order. startDateTime and endDateTime – Define a
time range for which you want to retrieve results. Of the optional fields, you can
organize the results in the following ways: Use the filters field to filter the results,
the groupBy field to specify categories by which to group the results, and the binBy field
to specify time intervals by which to group the results. Use the maxResults field to
limit the number of results to return in a single response and the nextToken field to
return the next batch of results if the response does not return the full set of results.
Note that an order field exists in both binBy and metrics. Currently, you can specify it in
either field, but not in both.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve session metrics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see session metrics.
- `metrics`: A list of objects, each of which contains a metric you want to list, the
statistic for the metric you want to return, and the method by which to organize the
results.
- `start_date_time`: The date and time that marks the beginning of the range of time for
which you want to see session metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"binBy"`: A list of objects, each of which contains specifications for organizing the
results by time.
- `"filters"`: A list of objects, each of which describes a condition by which you want to
filter the results.
- `"groupBy"`: A list of objects, each of which specifies how to group the results. You can
group by the following criteria: ConversationEndState – The final state of the
conversation. The possible end states are detailed in Key definitions in the user guide.
LocaleId – The unique identifier of the bot locale.
- `"maxResults"`: The maximum number of results to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListSessionMetrics operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return
the next page of results. For a complete set of results, call the ListSessionMetrics
operation until the nextToken returned in the response is null.
"""
function list_session_metrics(
botId,
endDateTime,
metrics,
startDateTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/sessionmetrics",
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_session_metrics(
botId,
endDateTime,
metrics,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/sessionmetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_slot_types(bot_id, bot_version, locale_id)
list_slot_types(bot_id, bot_version, locale_id, params::Dict{String,<:Any})
Gets a list of slot types that match the specified criteria.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the slot types.
- `bot_version`: The version of the bot that contains the slot type.
- `locale_id`: The identifier of the language and locale of the slot types to list. The
string must match one of the supported locales. For more information, see Supported
languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Provides the specification of a filter used to limit the slot types in the
response to only those that match the filter specification. You can only specify one filter
and only one string to filter on.
- `"maxResults"`: The maximum number of slot types to return in each page of results. If
there are fewer results than the max page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListSlotTypes operation contains more results
than specified in the maxResults parameter, a token is returned in the response. Use that
token in the nextToken parameter to return the next page of results.
- `"sortBy"`: Determines the sort order for the response from the ListSlotTypes operation.
You can choose to sort by the slot type name or last updated date in either ascending or
descending order.
"""
function list_slot_types(
botId, botVersion, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_slot_types(
botId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_slots(bot_id, bot_version, intent_id, locale_id)
list_slots(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})
Gets a list of slots that match the specified criteria.
# Arguments
- `bot_id`: The identifier of the bot that contains the slot.
- `bot_version`: The version of the bot that contains the slot.
- `intent_id`: The unique identifier of the intent that contains the slot.
- `locale_id`: The identifier of the language and locale of the slots to list. The string
must match one of the supported locales. For more information, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Provides the specification of a filter used to limit the slots in the
response to only those that match the filter specification. You can only specify one filter
and only one string to filter on.
- `"maxResults"`: The maximum number of slots to return in each page of results. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListSlots operation contains more results than
specified in the maxResults parameter, a token is returned in the response. Use that token
in the nextToken parameter to return the next page of results.
- `"sortBy"`: Determines the sort order for the response from the ListSlots operation. You
can choose to sort by the slot name or last updated date in either ascending or descending
order.
"""
function list_slots(
botId, botVersion, intentId, localeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_slots(
botId,
botVersion,
intentId,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels
can have tags associated with them.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to get a list of tags for.
"""
function list_tags_for_resource(
resourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"GET",
"/tags/$(resourceARN)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"GET",
"/tags/$(resourceARN)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_execution_result_items(result_filter_by, test_execution_id)
list_test_execution_result_items(result_filter_by, test_execution_id, params::Dict{String,<:Any})
Gets a list of test execution result items.
# Arguments
- `result_filter_by`: The filter for the list of results from the test set execution.
- `test_execution_id`: The unique identifier of the test execution to list the result items.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of test execution result items to return in each page.
If there are fewer results than the max page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListTestExecutionResultItems operation contains
more results than specified in the maxResults parameter, a token is returned in the
response. Use that token in the nextToken parameter to return the next page of results.
"""
function list_test_execution_result_items(
resultFilterBy, testExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/testexecutions/$(testExecutionId)/results",
Dict{String,Any}("resultFilterBy" => resultFilterBy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_test_execution_result_items(
resultFilterBy,
testExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/testexecutions/$(testExecutionId)/results",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resultFilterBy" => resultFilterBy), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_executions()
list_test_executions(params::Dict{String,<:Any})
The list of test set executions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of test executions to return in each page. If there
are fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListTestExecutions operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
- `"sortBy"`: The sort order of the test set executions.
"""
function list_test_executions(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST", "/testexecutions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_test_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/testexecutions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_set_records(test_set_id)
list_test_set_records(test_set_id, params::Dict{String,<:Any})
The list of test set records.
# Arguments
- `test_set_id`: The identifier of the test set to list its test set records.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of test set records to return in each page. If there
are fewer records than the max page size, only the actual number of records are returned.
- `"nextToken"`: If the response from the ListTestSetRecords operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use that token in the nextToken parameter to return the next page of results.
"""
function list_test_set_records(testSetId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST",
"/testsets/$(testSetId)/records";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_test_set_records(
testSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/testsets/$(testSetId)/records",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_sets()
list_test_sets(params::Dict{String,<:Any})
The list of the test sets
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of test sets to return in each page. If there are
fewer results than the max page size, only the actual number of results are returned.
- `"nextToken"`: If the response from the ListTestSets operation contains more results than
specified in the maxResults parameter, a token is returned in the response. Use that token
in the nextToken parameter to return the next page of results.
- `"sortBy"`: The sort order for the list of test sets.
"""
function list_test_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST", "/testsets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_test_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST", "/testsets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_utterance_analytics_data(bot_id, end_date_time, start_date_time)
list_utterance_analytics_data(bot_id, end_date_time, start_date_time, params::Dict{String,<:Any})
To use this API operation, your IAM role must have permissions to perform the
ListAggregatedUtterances operation, which provides access to utterance-related analytics.
See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves a
list of metadata for individual user utterances to your bot. The following fields are
required: startDateTime and endDateTime – Define a time range for which you want to
retrieve results. Of the optional fields, you can organize the results in the following
ways: Use the filters field to filter the results and the sortBy field to specify the
values by which to sort the results. Use the maxResults field to limit the number of
results to return in a single response and the nextToken field to return the next batch of
results if the response does not return the full set of results.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve utterance analytics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see utterance analytics.
- `start_date_time`: The date and time that marks the beginning of the range of time for
which you want to see utterance analytics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A list of objects, each of which describes a condition by which you want to
filter the results.
- `"maxResults"`: The maximum number of results to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListUtteranceAnalyticsData operation contains
more results than specified in the maxResults parameter, a token is returned in the
response. Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData
request to return the next page of results. For a complete set of results, call the
ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
- `"sortBy"`: An object specifying the measure and method by which to sort the utterance
analytics data.
"""
function list_utterance_analytics_data(
botId, endDateTime, startDateTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/utterances",
Dict{String,Any}("endDateTime" => endDateTime, "startDateTime" => startDateTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_utterance_analytics_data(
botId,
endDateTime,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/utterances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime, "startDateTime" => startDateTime
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_utterance_metrics(bot_id, end_date_time, metrics, start_date_time)
list_utterance_metrics(bot_id, end_date_time, metrics, start_date_time, params::Dict{String,<:Any})
To use this API operation, your IAM role must have permissions to perform the
ListAggregatedUtterances operation, which provides access to utterance-related analytics.
See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves
summary metrics for the utterances in your bot. The following fields are required:
metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field
to specify the metric to calculate, the statistic field to specify whether to calculate the
Sum, Average, or Max number, and the order field to specify whether to sort the results in
Ascending or Descending order. startDateTime and endDateTime – Define a time range for
which you want to retrieve results. Of the optional fields, you can organize the results
in the following ways: Use the filters field to filter the results, the groupBy field to
specify categories by which to group the results, and the binBy field to specify time
intervals by which to group the results. Use the maxResults field to limit the number of
results to return in a single response and the nextToken field to return the next batch of
results if the response does not return the full set of results. Note that an order field
exists in both binBy and metrics. Currently, you can specify it in either field, but not in
both.
# Arguments
- `bot_id`: The identifier for the bot for which you want to retrieve utterance metrics.
- `end_date_time`: The date and time that marks the end of the range of time for which you
want to see utterance metrics.
- `metrics`: A list of objects, each of which contains a metric you want to list, the
statistic for the metric you want to return, and the method by which to organize the
results.
- `start_date_time`: The date and time that marks the beginning of the range of time for
which you want to see utterance metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: A list containing attributes related to the utterance that you want the
response to return. The following attributes are possible: LastUsedIntent – The last
used intent at the time of the utterance.
- `"binBy"`: A list of objects, each of which contains specifications for organizing the
results by time.
- `"filters"`: A list of objects, each of which describes a condition by which you want to
filter the results.
- `"groupBy"`: A list of objects, each of which specifies how to group the results. You can
group by the following criteria: UtteranceText – The transcription of the utterance.
UtteranceState – The state of the utterance. The possible states are detailed in Key
definitions in the user guide.
- `"maxResults"`: The maximum number of results to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of results are
returned.
- `"nextToken"`: If the response from the ListUtteranceMetrics operation contains more
results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to
return the next page of results. For a complete set of results, call the
ListUtteranceMetrics operation until the nextToken returned in the response is null.
"""
function list_utterance_metrics(
botId,
endDateTime,
metrics,
startDateTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/utterancemetrics",
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_utterance_metrics(
botId,
endDateTime,
metrics,
startDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/analytics/utterancemetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endDateTime" => endDateTime,
"metrics" => metrics,
"startDateTime" => startDateTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_associated_transcripts(bot_id, bot_recommendation_id, bot_version, filters, locale_id)
search_associated_transcripts(bot_id, bot_recommendation_id, bot_version, filters, locale_id, params::Dict{String,<:Any})
Search for associated transcripts that meet the specified criteria.
# Arguments
- `bot_id`: The unique identifier of the bot associated with the transcripts that you are
searching.
- `bot_recommendation_id`: The unique identifier of the bot recommendation associated with
the transcripts to search.
- `bot_version`: The version of the bot containing the transcripts that you are searching.
- `filters`: A list of filter objects.
- `locale_id`: The identifier of the language and locale of the transcripts to search. The
string must match one of the supported locales. For more information, see Supported
languages
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of bot recommendations to return in each page of
results. If there are fewer results than the max page size, only the actual number of
results are returned.
- `"nextIndex"`: If the response from the SearchAssociatedTranscriptsRequest operation
contains more results than specified in the maxResults parameter, an index is returned in
the response. Use that index in the nextIndex parameter to return the next page of results.
- `"searchOrder"`: How SearchResults are ordered. Valid values are Ascending or Descending.
The default is Descending.
"""
function search_associated_transcripts(
botId,
botRecommendationId,
botVersion,
filters,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/associatedtranscripts",
Dict{String,Any}("filters" => filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_associated_transcripts(
botId,
botRecommendationId,
botVersion,
filters,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/associatedtranscripts",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("filters" => filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_bot_recommendation(bot_id, bot_version, locale_id, transcript_source_setting)
start_bot_recommendation(bot_id, bot_version, locale_id, transcript_source_setting, params::Dict{String,<:Any})
Use this to provide your transcript data, and to start the bot recommendation process.
# Arguments
- `bot_id`: The unique identifier of the bot containing the bot recommendation.
- `bot_version`: The version of the bot containing the bot recommendation.
- `locale_id`: The identifier of the language and locale of the bot recommendation to
start. The string must match one of the supported locales. For more information, see
Supported languages
- `transcript_source_setting`: The object representing the Amazon S3 bucket containing the
transcript, as well as the associated metadata.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"encryptionSetting"`: The object representing the passwords that will be used to encrypt
the data related to the bot recommendation results, as well as the KMS key ARN used to
encrypt the associated metadata.
"""
function start_bot_recommendation(
botId,
botVersion,
localeId,
transcriptSourceSetting;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/",
Dict{String,Any}("transcriptSourceSetting" => transcriptSourceSetting);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_bot_recommendation(
botId,
botVersion,
localeId,
transcriptSourceSetting,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("transcriptSourceSetting" => transcriptSourceSetting),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_bot_resource_generation(bot_id, bot_version, generation_input_prompt, locale_id)
start_bot_resource_generation(bot_id, bot_version, generation_input_prompt, locale_id, params::Dict{String,<:Any})
Starts a request for the descriptive bot builder to generate a bot locale configuration
based on the prompt you provide it. After you make this call, use the
DescribeBotResourceGeneration operation to check on the status of the generation and for
the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the
Amazon S3 object containing the bot locale configuration. You can then modify and import
this configuration.
# Arguments
- `bot_id`: The unique identifier of the bot for which to generate intents and slot types.
- `bot_version`: The version of the bot for which to generate intents and slot types.
- `generation_input_prompt`: The prompt to generate intents and slot types for the bot
locale. Your description should be both detailed and precise to help generate appropriate
and sufficient intents for your bot. Include a list of actions to improve the intent
creation process.
- `locale_id`: The locale of the bot for which to generate intents and slot types.
"""
function start_bot_resource_generation(
botId,
botVersion,
generationInputPrompt,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/startgeneration",
Dict{String,Any}("generationInputPrompt" => generationInputPrompt);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_bot_resource_generation(
botId,
botVersion,
generationInputPrompt,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/startgeneration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("generationInputPrompt" => generationInputPrompt),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import(import_id, merge_strategy, resource_specification)
start_import(import_id, merge_strategy, resource_specification, params::Dict{String,<:Any})
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you
uploaded to an S3 bucket.
# Arguments
- `import_id`: The unique identifier for the import. It is included in the response from
the CreateUploadUrl operation.
- `merge_strategy`: The strategy to use when there is a name conflict between the imported
resource and an existing resource. When the merge strategy is FailOnConflict existing
resources are not overwritten and the import fails.
- `resource_specification`: Parameters for creating the bot, bot locale or custom
vocabulary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filePassword"`: The password used to encrypt the zip archive that contains the resource
definition. You should always encrypt the zip archive to protect it during transit between
your site and Amazon Lex.
"""
function start_import(
importId,
mergeStrategy,
resourceSpecification;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/imports/",
Dict{String,Any}(
"importId" => importId,
"mergeStrategy" => mergeStrategy,
"resourceSpecification" => resourceSpecification,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import(
importId,
mergeStrategy,
resourceSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/imports/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"importId" => importId,
"mergeStrategy" => mergeStrategy,
"resourceSpecification" => resourceSpecification,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_test_execution(api_mode, target, test_set_id)
start_test_execution(api_mode, target, test_set_id, params::Dict{String,<:Any})
The action to start test set execution.
# Arguments
- `api_mode`: Indicates whether we use streaming or non-streaming APIs for the test set
execution. For streaming, StartConversation Runtime API is used. Whereas, for
non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
- `target`: The target bot for the test set execution.
- `test_set_id`: The test set Id for the test set execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"testExecutionModality"`: Indicates whether audio or text is used.
"""
function start_test_execution(
apiMode, target, testSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"POST",
"/testsets/$(testSetId)/testexecutions",
Dict{String,Any}("apiMode" => apiMode, "target" => target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_test_execution(
apiMode,
target,
testSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/testsets/$(testSetId)/testexecutions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("apiMode" => apiMode, "target" => target), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_test_set_generation(generation_data_source, role_arn, storage_location, test_set_name)
start_test_set_generation(generation_data_source, role_arn, storage_location, test_set_name, params::Dict{String,<:Any})
The action to start the generation of test set.
# Arguments
- `generation_data_source`: The data source for the test set generation.
- `role_arn`: The roleARN used for any operation in the test set to access resources in the
Amazon Web Services account.
- `storage_location`: The Amazon S3 storage location for the test set generation.
- `test_set_name`: The test set name for the test set generation request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The test set description for the test set generation request.
- `"testSetTags"`: A list of tags to add to the test set. You can only add tags when you
import/generate a new test set. You can't use the UpdateTestSet operation to update tags.
To update tags, use the TagResource operation.
"""
function start_test_set_generation(
generationDataSource,
roleArn,
storageLocation,
testSetName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/testsetgenerations",
Dict{String,Any}(
"generationDataSource" => generationDataSource,
"roleArn" => roleArn,
"storageLocation" => storageLocation,
"testSetName" => testSetName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_test_set_generation(
generationDataSource,
roleArn,
storageLocation,
testSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/testsetgenerations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"generationDataSource" => generationDataSource,
"roleArn" => roleArn,
"storageLocation" => storageLocation,
"testSetName" => testSetName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id)
stop_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id, params::Dict{String,<:Any})
Stop an already running Bot Recommendation request.
# Arguments
- `bot_id`: The unique identifier of the bot containing the bot recommendation to be
stopped.
- `bot_recommendation_id`: The unique identifier of the bot recommendation to be stopped.
- `bot_version`: The version of the bot containing the bot recommendation.
- `locale_id`: The identifier of the language and locale of the bot recommendation to stop.
The string must match one of the supported locales. For more information, see Supported
languages
"""
function stop_bot_recommendation(
botId,
botRecommendationId,
botVersion,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/stopbotrecommendation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_bot_recommendation(
botId,
botRecommendationId,
botVersion,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/stopbotrecommendation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tags to the specified resource. If a tag key already exists, the
existing value is replaced with the new value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to
tag.
- `tags`: A list of tag keys to add to the resource. If a tag key already exists, the
existing value is replaced with the new value.
"""
function tag_resource(resourceARN, tags; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"POST",
"/tags/$(resourceARN)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceARN,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"POST",
"/tags/$(resourceARN)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a bot, bot alias, or bot channel.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to remove the tags from.
- `tag_keys`: A list of tag keys to remove from the resource. If a tag key does not exist
on the resource, it is ignored.
"""
function untag_resource(
resourceARN, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"DELETE",
"/tags/$(resourceARN)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceARN,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"DELETE",
"/tags/$(resourceARN)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bot(bot_id, bot_name, data_privacy, idle_session_ttlin_seconds, role_arn)
update_bot(bot_id, bot_name, data_privacy, idle_session_ttlin_seconds, role_arn, params::Dict{String,<:Any})
Updates the configuration of an existing bot.
# Arguments
- `bot_id`: The unique identifier of the bot to update. This identifier is returned by the
CreateBot operation.
- `bot_name`: The new name of the bot. The name must be unique in the account that creates
the bot.
- `data_privacy`: Provides information on additional privacy protections Amazon Lex should
use with the bot's data.
- `idle_session_ttlin_seconds`: The time, in seconds, that Amazon Lex should keep
information about a user's conversation with the bot. A user interaction remains active for
the amount of time specified. If no conversation occurs during this time, the session
expires and Amazon Lex deletes any data provided before the timeout. You can specify
between 60 (1 minute) and 86,400 (24 hours) seconds.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that has permissions to access
the bot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botMembers"`: The list of bot members in the network associated with the update action.
- `"botType"`: The type of the bot to be updated.
- `"description"`: A description of the bot.
"""
function update_bot(
botId,
botName,
dataPrivacy,
idleSessionTTLInSeconds,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/",
Dict{String,Any}(
"botName" => botName,
"dataPrivacy" => dataPrivacy,
"idleSessionTTLInSeconds" => idleSessionTTLInSeconds,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bot(
botId,
botName,
dataPrivacy,
idleSessionTTLInSeconds,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"botName" => botName,
"dataPrivacy" => dataPrivacy,
"idleSessionTTLInSeconds" => idleSessionTTLInSeconds,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bot_alias(bot_alias_id, bot_alias_name, bot_id)
update_bot_alias(bot_alias_id, bot_alias_name, bot_id, params::Dict{String,<:Any})
Updates the configuration of an existing bot alias.
# Arguments
- `bot_alias_id`: The unique identifier of the bot alias.
- `bot_alias_name`: The new name to assign to the bot alias.
- `bot_id`: The identifier of the bot with the updated alias.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"botAliasLocaleSettings"`: The new Lambda functions to use in each locale for the bot
alias.
- `"botVersion"`: The new bot version to assign to the bot alias.
- `"conversationLogSettings"`: The new settings for storing conversation logs in Amazon
CloudWatch Logs and Amazon S3 buckets.
- `"description"`: The new description to assign to the bot alias.
- `"sentimentAnalysisSettings"`:
"""
function update_bot_alias(
botAliasId, botAliasName, botId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botaliases/$(botAliasId)/",
Dict{String,Any}("botAliasName" => botAliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bot_alias(
botAliasId,
botAliasName,
botId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botaliases/$(botAliasId)/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("botAliasName" => botAliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold)
update_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold, params::Dict{String,<:Any})
Updates the settings that a bot has for a specific locale.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the locale.
- `bot_version`: The version of the bot that contains the locale to be updated. The version
can only be the DRAFT version.
- `locale_id`: The identifier of the language and locale to update. The string must match
one of the supported locales. For more information, see Supported languages.
- `nlu_intent_confidence_threshold`: The new confidence threshold where Amazon Lex inserts
the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible
intents for an utterance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new description of the locale.
- `"generativeAISettings"`: Contains settings for generative AI features powered by Amazon
Bedrock for your bot locale. Use this object to turn generative AI features on and off.
Pricing may differ if you turn a feature on. For more information, see LINK.
- `"voiceSettings"`: The new Amazon Polly voice Amazon Lex should use for voice interaction
with the user.
"""
function update_bot_locale(
botId,
botVersion,
localeId,
nluIntentConfidenceThreshold;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/",
Dict{String,Any}("nluIntentConfidenceThreshold" => nluIntentConfidenceThreshold);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bot_locale(
botId,
botVersion,
localeId,
nluIntentConfidenceThreshold,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"nluIntentConfidenceThreshold" => nluIntentConfidenceThreshold
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bot_recommendation(bot_id, bot_recommendation_id, bot_version, encryption_setting, locale_id)
update_bot_recommendation(bot_id, bot_recommendation_id, bot_version, encryption_setting, locale_id, params::Dict{String,<:Any})
Updates an existing bot recommendation request.
# Arguments
- `bot_id`: The unique identifier of the bot containing the bot recommendation to be
updated.
- `bot_recommendation_id`: The unique identifier of the bot recommendation to be updated.
- `bot_version`: The version of the bot containing the bot recommendation to be updated.
- `encryption_setting`: The object representing the passwords that will be used to encrypt
the data related to the bot recommendation results, as well as the KMS key ARN used to
encrypt the associated metadata.
- `locale_id`: The identifier of the language and locale of the bot recommendation to
update. The string must match one of the supported locales. For more information, see
Supported languages
"""
function update_bot_recommendation(
botId,
botRecommendationId,
botVersion,
encryptionSetting,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/",
Dict{String,Any}("encryptionSetting" => encryptionSetting);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bot_recommendation(
botId,
botRecommendationId,
botVersion,
encryptionSetting,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/botrecommendations/$(botRecommendationId)/",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("encryptionSetting" => encryptionSetting), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_export(export_id)
update_export(export_id, params::Dict{String,<:Any})
Updates the password used to protect an export zip archive. The password is not required.
If you don't supply a password, Amazon Lex generates a zip file that is not protected by a
password. This is the archive that is available at the pre-signed S3 URL provided by the
DescribeExport operation.
# Arguments
- `export_id`: The unique identifier Amazon Lex assigned to the export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filePassword"`: The new password to use to encrypt the export zip archive.
"""
function update_export(exportId; aws_config::AbstractAWSConfig=global_aws_config())
return lex_models_v2(
"PUT",
"/exports/$(exportId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_export(
exportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/exports/$(exportId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_intent(bot_id, bot_version, intent_id, intent_name, locale_id)
update_intent(bot_id, bot_version, intent_id, intent_name, locale_id, params::Dict{String,<:Any})
Updates the settings for an intent.
# Arguments
- `bot_id`: The identifier of the bot that contains the intent.
- `bot_version`: The version of the bot that contains the intent. Must be DRAFT.
- `intent_id`: The unique identifier of the intent to update.
- `intent_name`: The new name for the intent.
- `locale_id`: The identifier of the language and locale where this intent is used. The
string must match one of the supported locales. For more information, see Supported
languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new description of the intent.
- `"dialogCodeHook"`: The new Lambda function to use between each turn of the conversation
with the bot.
- `"fulfillmentCodeHook"`: The new Lambda function to call when all of the intents required
slots are provided and the intent is ready for fulfillment.
- `"initialResponseSetting"`: Configuration settings for a response sent to the user before
Amazon Lex starts eliciting slots.
- `"inputContexts"`: A new list of contexts that must be active in order for Amazon Lex to
consider the intent.
- `"intentClosingSetting"`: The new response that Amazon Lex sends the user when the intent
is closed.
- `"intentConfirmationSetting"`: New prompts that Amazon Lex sends to the user to confirm
the completion of an intent.
- `"kendraConfiguration"`: New configuration settings for connecting to an Amazon Kendra
index.
- `"outputContexts"`: A new list of contexts that Amazon Lex activates when the intent is
fulfilled.
- `"parentIntentSignature"`: The signature of the new built-in intent to use as the parent
of this intent.
- `"qnAIntentConfiguration"`: Specifies the configuration of the built-in Amazon.QnAIntent.
The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to
invoke. If you specify this field, you can't specify the kendraConfiguration field.
- `"sampleUtterances"`: New utterances used to invoke the intent.
- `"slotPriorities"`: A new list of slots and their priorities that are contained by the
intent.
"""
function update_intent(
botId,
botVersion,
intentId,
intentName,
localeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/",
Dict{String,Any}("intentName" => intentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_intent(
botId,
botVersion,
intentId,
intentName,
localeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("intentName" => intentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_policy(policy, resource_arn)
update_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Replaces the existing resource policy for a bot or bot alias with a new one. If the policy
doesn't exist, Amazon Lex returns an exception.
# Arguments
- `policy`: A resource policy to add to the resource. The policy is a JSON structure that
contains one or more statements that define the policy. The policy must follow the IAM
syntax. For more information about the contents of a JSON policy document, see IAM JSON
policy reference . If the policy isn't valid, Amazon Lex returns a validation exception.
- `resource_arn`: The Amazon Resource Name (ARN) of the bot or bot alias that the resource
policy is attached to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedRevisionId"`: The identifier of the revision of the policy to update. If this
revision ID doesn't match the current revision ID, Amazon Lex throws an exception. If you
don't specify a revision, Amazon Lex overwrites the contents of the policy with the new
values.
"""
function update_resource_policy(
policy, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/policy/$(resourceArn)/",
Dict{String,Any}("policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_policy(
policy,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/policy/$(resourceArn)/",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_slot(bot_id, bot_version, intent_id, locale_id, slot_id, slot_name, value_elicitation_setting)
update_slot(bot_id, bot_version, intent_id, locale_id, slot_id, slot_name, value_elicitation_setting, params::Dict{String,<:Any})
Updates the settings for a slot.
# Arguments
- `bot_id`: The unique identifier of the bot that contains the slot.
- `bot_version`: The version of the bot that contains the slot. Must always be DRAFT.
- `intent_id`: The identifier of the intent that contains the slot.
- `locale_id`: The identifier of the language and locale that contains the slot. The string
must match one of the supported locales. For more information, see Supported languages.
- `slot_id`: The unique identifier for the slot to update.
- `slot_name`: The new name for the slot.
- `value_elicitation_setting`: A new set of prompts that Amazon Lex sends to the user to
elicit a response the provides a value for the slot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new description for the slot.
- `"multipleValuesSetting"`: Determines whether the slot accepts multiple values in one
response. Multiple value slots are only available in the en-US locale. If you set this
value to true in any other locale, Amazon Lex throws a ValidationException. If the
multipleValuesSetting is not set, the default value is false.
- `"obfuscationSetting"`: New settings that determine how slot values are formatted in
Amazon CloudWatch logs.
- `"slotTypeId"`: The unique identifier of the new slot type to associate with this slot.
- `"subSlotSetting"`: Specifications for the constituent sub slots and the expression for
the composite slot.
"""
function update_slot(
botId,
botVersion,
intentId,
localeId,
slotId,
slotName,
valueElicitationSetting;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/$(slotId)/",
Dict{String,Any}(
"slotName" => slotName, "valueElicitationSetting" => valueElicitationSetting
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_slot(
botId,
botVersion,
intentId,
localeId,
slotId,
slotName,
valueElicitationSetting,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/intents/$(intentId)/slots/$(slotId)/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"slotName" => slotName,
"valueElicitationSetting" => valueElicitationSetting,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name)
update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name, params::Dict{String,<:Any})
Updates the configuration of an existing slot type.
# Arguments
- `bot_id`: The identifier of the bot that contains the slot type.
- `bot_version`: The version of the bot that contains the slot type. Must be DRAFT.
- `locale_id`: The identifier of the language and locale that contains the slot type. The
string must match one of the supported locales. For more information, see Supported
languages.
- `slot_type_id`: The unique identifier of the slot type to update.
- `slot_type_name`: The new name of the slot type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compositeSlotTypeSetting"`: Specifications for a composite slot type.
- `"description"`: The new description of the slot type.
- `"externalSourceSetting"`:
- `"parentSlotTypeSignature"`: The new built-in slot type that should be used as the parent
of this slot type.
- `"slotTypeValues"`: A new list of values and their optional synonyms that define the
values that the slot type can take.
- `"valueSelectionSetting"`: The strategy that Amazon Lex should use when deciding on a
value from the list of slot type values.
"""
function update_slot_type(
botId,
botVersion,
localeId,
slotTypeId,
slotTypeName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/",
Dict{String,Any}("slotTypeName" => slotTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_slot_type(
botId,
botVersion,
localeId,
slotTypeId,
slotTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("slotTypeName" => slotTypeName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_test_set(test_set_id, test_set_name)
update_test_set(test_set_id, test_set_name, params::Dict{String,<:Any})
The action to update the test set.
# Arguments
- `test_set_id`: The test set Id for which update test operation to be performed.
- `test_set_name`: The new test set name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new test set description.
"""
function update_test_set(
testSetId, testSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_models_v2(
"PUT",
"/testsets/$(testSetId)",
Dict{String,Any}("testSetName" => testSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_test_set(
testSetId,
testSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_models_v2(
"PUT",
"/testsets/$(testSetId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("testSetName" => testSetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 19951 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lex_runtime_service
using AWS.Compat
using AWS.UUIDs
"""
delete_session(bot_alias, bot_name, user_id)
delete_session(bot_alias, bot_name, user_id, params::Dict{String,<:Any})
Removes session information for a specified bot, alias, and user ID.
# Arguments
- `bot_alias`: The alias in use for the bot that contains the session data.
- `bot_name`: The name of the bot that contains the session data.
- `user_id`: The identifier of the user associated with the session data.
"""
function delete_session(
botAlias, botName, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_runtime_service(
"DELETE",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/session";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_session(
botAlias,
botName,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_service(
"DELETE",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/session",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session(bot_alias, bot_name, user_id)
get_session(bot_alias, bot_name, user_id, params::Dict{String,<:Any})
Returns session information for a specified bot, alias, and user ID.
# Arguments
- `bot_alias`: The alias in use for the bot that contains the session data.
- `bot_name`: The name of the bot that contains the session data.
- `user_id`: The ID of the client application user. Amazon Lex uses this to identify a
user's conversation with your bot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checkpointLabelFilter"`: A string used to filter the intents returned in the
recentIntentSummaryView structure. When you specify a filter, only intents with their
checkpointLabel field set to that string are returned.
"""
function get_session(
botAlias, botName, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_runtime_service(
"GET",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/session/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session(
botAlias,
botName,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_service(
"GET",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/session/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
post_content(content-_type, bot_alias, bot_name, input_stream, user_id)
post_content(content-_type, bot_alias, bot_name, input_stream, user_id, params::Dict{String,<:Any})
Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and
audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the
machine learning model that it built for the bot. The PostContent operation supports audio
input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition
accuracy in telephone audio applications. In response, Amazon Lex returns the next
message to convey to the user. Consider the following example messages: For a user
input \"I would like a pizza,\" Amazon Lex might return a response with a message eliciting
slot data (for example, PizzaSize): \"What size pizza would you like?\". After the user
provides all of the pizza order information, Amazon Lex might return a response with a
message to get user confirmation: \"Order the pizza?\". After the user replies \"Yes\"
to the confirmation prompt, Amazon Lex might return a conclusion statement: \"Thank you,
your cheese pizza has been ordered.\". Not all Amazon Lex messages require a response
from the user. For example, conclusion statements do not require a response. Some messages
require only a yes or no response. In addition to the message, Amazon Lex provides
additional context about the message in the response that you can use to enhance client
behavior, such as displaying the appropriate client user interface. Consider the following
examples: If the message is to elicit slot data, Amazon Lex returns the following
context information: x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting
information x-amz-lex-slots header set to a map of slots configured for the intent with
their current values If the message is a confirmation prompt, the
x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit
header is omitted. If the message is a clarification prompt configured for the intent,
indicating that the user intent is not understood, the x-amz-dialog-state header is set to
ElicitIntent and the x-amz-slot-to-elicit header is omitted. In addition, Amazon Lex
also returns your application-specific sessionAttributes. For more information, see
Managing Conversation Context.
# Arguments
- `content-_type`: You pass this value as the Content-Type HTTP header. Indicates the
audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order. audio/l16; rate=16000;
channels=1 audio/x-l16; sample-rate=16000; channel-count=1 audio/lpcm;
sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false Opus
format audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000;
frame-size-milliseconds=4 Text format text/plain; charset=utf-8
- `bot_alias`: Alias of the Amazon Lex bot.
- `bot_name`: Name of the Amazon Lex bot.
- `input_stream`: User input in PCM or Opus audio format or text format as described in
the Content-Type HTTP header. You can stream audio data to Amazon Lex or you can create a
local buffer that captures all of the audio data before sending. In general, you get better
performance if you stream audio data rather than buffering the data locally.
- `user_id`: The ID of the client application user. Amazon Lex uses this to identify a
user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors. The
userID field must not contain any personally identifiable information of the user, for
example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device,
use a user-specific identifier. If you want the same user to be able to have two
independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same
bot. For example, a user can't have a conversation with the PROD and BETA versions of the
same bot. If you anticipate that a user will need to have conversation with two different
versions, for example, while testing, include the bot alias in the user ID to separate the
two conversations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept"`: You pass this value as the Accept HTTP header. The message Amazon Lex
returns in the response can be either text or speech based on the Accept HTTP header value
in the request. If the value is text/plain; charset=utf-8, Amazon Lex returns text in
the response. If the value begins with audio/, Amazon Lex returns speech in the
response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you
specified in the Accept header). For example, if you specify audio/mpeg as the value,
Amazon Lex returns speech in the MPEG format. If the value is audio/pcm, the speech
returned is audio/pcm in 16-bit, little endian format. The following are the accepted
values: audio/mpeg audio/ogg audio/pcm text/plain; charset=utf-8 audio/*
(defaults to mpeg)
- `"x-amz-lex-active-contexts"`: A list of contexts active for the request. A context can
be activated when a previous intent is fulfilled, or by including the context in the
request, If you don't specify a list of contexts, Amazon Lex will use the current list of
contexts for the session. If you specify an empty list, all contexts for the session are
cleared.
- `"x-amz-lex-request-attributes"`: You pass this value as the x-amz-lex-request-attributes
HTTP header. Request-specific information passed between Amazon Lex and a client
application. The value must be a JSON serialized and base64 encoded map with string keys
and values. The total size of the requestAttributes and sessionAttributes headers is
limited to 12 KB. The namespace x-amz-lex: is reserved for special attributes. Don't create
any request attributes with the prefix x-amz-lex:. For more information, see Setting
Request Attributes.
- `"x-amz-lex-session-attributes"`: You pass this value as the x-amz-lex-session-attributes
HTTP header. Application-specific information passed between Amazon Lex and a client
application. The value must be a JSON serialized and base64 encoded map with string keys
and values. The total size of the sessionAttributes and requestAttributes headers is
limited to 12 KB. For more information, see Setting Session Attributes.
"""
function post_content(
Content_Type,
botAlias,
botName,
inputStream,
userId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_service(
"POST",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/content",
Dict{String,Any}(
"inputStream" => inputStream,
"headers" => Dict{String,Any}("Content-Type" => Content_Type),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function post_content(
Content_Type,
botAlias,
botName,
inputStream,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_service(
"POST",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/content",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputStream" => inputStream,
"headers" => Dict{String,Any}("Content-Type" => Content_Type),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
post_text(bot_alias, bot_name, input_text, user_id)
post_text(bot_alias, bot_name, input_text, user_id, params::Dict{String,<:Any})
Sends user input to Amazon Lex. Client applications can use this API to send requests to
Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning
model it built for the bot. In response, Amazon Lex returns the next message to convey to
the user an optional responseCard to display. Consider the following example messages:
For a user input \"I would like a pizza\", Amazon Lex might return a response with a
message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\"
After the user provides all of the pizza order information, Amazon Lex might return a
response with a message to obtain user confirmation \"Proceed with the pizza order?\".
After the user replies to a confirmation prompt with a \"yes\", Amazon Lex might return a
conclusion statement: \"Thank you, your cheese pizza has been ordered.\". Not all
Amazon Lex messages require a user response. For example, a conclusion statement does not
require a response. Some messages require only a \"yes\" or \"no\" user response. In
addition to the message, Amazon Lex provides additional context about the message in the
response that you might use to enhance client behavior, for example, to display the
appropriate client user interface. These are the slotToElicit, dialogState, intentName, and
slots fields in the response. Consider the following examples: If the message is to
elicit slot data, Amazon Lex returns the following context information: dialogState set
to ElicitSlot intentName set to the intent name in the current context slotToElicit
set to the slot name for which the message is eliciting information slots set to a map
of slots, configured for the intent, with currently known values If the message is a
confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to
null. If the message is a clarification prompt (configured for the intent) that
indicates that user intent is not understood, the dialogState is set to ElicitIntent and
slotToElicit is set to null. In addition, Amazon Lex also returns your
application-specific sessionAttributes. For more information, see Managing Conversation
Context.
# Arguments
- `bot_alias`: The alias of the Amazon Lex bot.
- `bot_name`: The name of the Amazon Lex bot.
- `input_text`: The text that the user entered (Amazon Lex interprets this text).
- `user_id`: The ID of the client application user. Amazon Lex uses this to identify a
user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors. The
userID field must not contain any personally identifiable information of the user, for
example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device,
use a user-specific identifier. If you want the same user to be able to have two
independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same
bot. For example, a user can't have a conversation with the PROD and BETA versions of the
same bot. If you anticipate that a user will need to have conversation with two different
versions, for example, while testing, include the bot alias in the user ID to separate the
two conversations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"activeContexts"`: A list of contexts active for the request. A context can be activated
when a previous intent is fulfilled, or by including the context in the request, If you
don't specify a list of contexts, Amazon Lex will use the current list of contexts for the
session. If you specify an empty list, all contexts for the session are cleared.
- `"requestAttributes"`: Request-specific information passed between Amazon Lex and a
client application. The namespace x-amz-lex: is reserved for special attributes. Don't
create any request attributes with the prefix x-amz-lex:. For more information, see Setting
Request Attributes.
- `"sessionAttributes"`: Application-specific information passed between Amazon Lex and a
client application. For more information, see Setting Session Attributes.
"""
function post_text(
botAlias, botName, inputText, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_runtime_service(
"POST",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/text",
Dict{String,Any}("inputText" => inputText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function post_text(
botAlias,
botName,
inputText,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_service(
"POST",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/text",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("inputText" => inputText), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_session(bot_alias, bot_name, user_id)
put_session(bot_alias, bot_name, user_id, params::Dict{String,<:Any})
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this
operation to enable your application to set the state of the bot. For more information, see
Managing Sessions.
# Arguments
- `bot_alias`: The alias in use for the bot that contains the session data.
- `bot_name`: The name of the bot that contains the session data.
- `user_id`: The ID of the client application user. Amazon Lex uses this to identify a
user's conversation with your bot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept"`: The message that Amazon Lex returns in the response can be either text or
speech based depending on the value of this field. If the value is text/plain;
charset=utf-8, Amazon Lex returns text in the response. If the value begins with audio/,
Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the
speech in the configuration that you specify. For example, if you specify audio/mpeg as the
value, Amazon Lex returns speech in the MPEG format. If the value is audio/pcm, the
speech is returned as audio/pcm in 16-bit, little endian format. The following are the
accepted values: audio/mpeg audio/ogg audio/pcm audio/* (defaults to mpeg)
text/plain; charset=utf-8
- `"activeContexts"`: A list of contexts active for the request. A context can be activated
when a previous intent is fulfilled, or by including the context in the request, If you
don't specify a list of contexts, Amazon Lex will use the current list of contexts for the
session. If you specify an empty list, all contexts for the session are cleared.
- `"dialogAction"`: Sets the next action that the bot should take to fulfill the
conversation.
- `"recentIntentSummaryView"`: A summary of the recent intents for the bot. You can use the
intent summary view to set a checkpoint label on an intent and modify attributes of
intents. You can also use it to remove or add intent summary objects to the list. An intent
that you modify or add to the list must make sense for the bot. For example, the intent
name must be valid for the bot. You must provide valid values for: intentName slot
names slotToElict If you send the recentIntentSummaryView parameter in a PutSession
request, the contents of the new summary view replaces the old summary view. For example,
if a GetSession request returns three intents in the summary view and you call PutSession
with one intent in the summary view, the next call to GetSession will only return one
intent.
- `"sessionAttributes"`: Map of key/value pairs representing the session-specific context
information. It contains application information passed between Amazon Lex and a client
application.
"""
function put_session(
botAlias, botName, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lex_runtime_service(
"POST",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/session";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_session(
botAlias,
botName,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_service(
"POST",
"/bot/$(botName)/alias/$(botAlias)/user/$(userId)/session",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 14855 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lex_runtime_v2
using AWS.Compat
using AWS.UUIDs
"""
delete_session(bot_alias_id, bot_id, locale_id, session_id)
delete_session(bot_alias_id, bot_id, locale_id, session_id, params::Dict{String,<:Any})
Removes session information for a specified bot, alias, and user ID. You can use this
operation to restart a conversation with a bot. When you remove a session, the entire
history of the session is removed so that you can start again. You don't need to delete a
session. Sessions have a time limit and will expire. Set the session time limit when you
create the bot. The default is 5 minutes, but you can specify anything between 1 minute and
24 hours. If you specify a bot or alias ID that doesn't exist, you receive a
BadRequestException. If the locale doesn't exist in the bot, or if the locale hasn't been
enables for the alias, you receive a BadRequestException.
# Arguments
- `bot_alias_id`: The alias identifier in use for the bot that contains the session data.
- `bot_id`: The identifier of the bot that contains the session data.
- `locale_id`: The locale where the session is in use.
- `session_id`: The identifier of the session to delete.
"""
function delete_session(
botAliasId,
botId,
localeId,
sessionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"DELETE",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_session(
botAliasId,
botId,
localeId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"DELETE",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session(bot_alias_id, bot_id, locale_id, session_id)
get_session(bot_alias_id, bot_id, locale_id, session_id, params::Dict{String,<:Any})
Returns session information for a specified bot, alias, and user. For example, you can use
this operation to retrieve session information for a user that has left a long-running
session in use. If the bot, alias, or session identifier doesn't exist, Amazon Lex V2
returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias,
you receive a BadRequestException.
# Arguments
- `bot_alias_id`: The alias identifier in use for the bot that contains the session data.
- `bot_id`: The identifier of the bot that contains the session data.
- `locale_id`: The locale where the session is in use.
- `session_id`: The identifier of the session to return.
"""
function get_session(
botAliasId,
botId,
localeId,
sessionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"GET",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session(
botAliasId,
botId,
localeId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"GET",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_session(bot_alias_id, bot_id, locale_id, session_id, session_state)
put_session(bot_alias_id, bot_id, locale_id, session_id, session_state, params::Dict{String,<:Any})
Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this
operation to enable your application to set the state of the bot.
# Arguments
- `bot_alias_id`: The alias identifier of the bot that receives the session data.
- `bot_id`: The identifier of the bot that receives the session data.
- `locale_id`: The locale where the session is in use.
- `session_id`: The identifier of the session that receives the session data.
- `session_state`: Sets the state of the session with the user. You can use this to set the
current intent, attributes, context, and dialog action. Use the dialog action to determine
the next step that Amazon Lex V2 should use in the conversation with the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResponseContentType"`: The message that Amazon Lex V2 returns in the response can be
either text or speech depending on the value of this parameter. If the value is
text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.
- `"messages"`: A list of messages to send to the user. Messages are sent in the order that
they are defined in the list.
- `"requestAttributes"`: Request-specific information passed between Amazon Lex V2 and the
client application. The namespace x-amz-lex: is reserved for special attributes. Don't
create any request attributes with the prefix x-amz-lex:.
"""
function put_session(
botAliasId,
botId,
localeId,
sessionId,
sessionState;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"POST",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)",
Dict{String,Any}("sessionState" => sessionState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_session(
botAliasId,
botId,
localeId,
sessionId,
sessionState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"POST",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sessionState" => sessionState), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
recognize_text(bot_alias_id, bot_id, locale_id, session_id, text)
recognize_text(bot_alias_id, bot_id, locale_id, session_id, text, params::Dict{String,<:Any})
Sends user input to Amazon Lex V2. Client applications use this API to send requests to
Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine
learning model that it build for the bot. In response, Amazon Lex V2 returns the next
message to convey to the user and an optional response card to display. If the optional
post-fulfillment response is specified, the messages are returned as follows. For more
information, see PostFulfillmentStatusSpecification. Success message - Returned if the
Lambda function completes successfully and the intent state is fulfilled or ready
fulfillment if the message is present. Failed message - The failed message is returned
if the Lambda function throws an exception or if the Lambda function returns a failed
intent state without a message. Timeout message - If you don't configure a timeout
message and a timeout, and the Lambda function doesn't return within 30 seconds, the
timeout message is returned. If you configure a timeout, the timeout message is returned
when the period times out. For more information, see Completion message.
# Arguments
- `bot_alias_id`: The alias identifier in use for the bot that processes the request.
- `bot_id`: The identifier of the bot that processes the request.
- `locale_id`: The locale where the session is in use.
- `session_id`: The identifier of the user session that is having the conversation.
- `text`: The text that the user entered. Amazon Lex V2 interprets this text.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"requestAttributes"`: Request-specific information passed between the client application
and Amazon Lex V2 The namespace x-amz-lex: is reserved for special attributes. Don't
create any request attributes with the prefix x-amz-lex:.
- `"sessionState"`: The current state of the dialog between the user and the bot.
"""
function recognize_text(
botAliasId,
botId,
localeId,
sessionId,
text;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"POST",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)/text",
Dict{String,Any}("text" => text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function recognize_text(
botAliasId,
botId,
localeId,
sessionId,
text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"POST",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)/text",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("text" => text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
recognize_utterance(content-_type, bot_alias_id, bot_id, locale_id, session_id)
recognize_utterance(content-_type, bot_alias_id, bot_id, locale_id, session_id, params::Dict{String,<:Any})
Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to
send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user
input using the machine learning model built for the bot. The following request fields must
be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.
requestAttributes sessionState The following response fields are compressed using gzip
and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode
and decompress them. inputTranscript interpretations messages requestAttributes
sessionState The example contains a Java application that compresses and encodes a Java
object to send to Amazon Lex V2, and a second that decodes and decompresses a response from
Amazon Lex V2. If the optional post-fulfillment response is specified, the messages are
returned as follows. For more information, see PostFulfillmentStatusSpecification.
Success message - Returned if the Lambda function completes successfully and the intent
state is fulfilled or ready fulfillment if the message is present. Failed message - The
failed message is returned if the Lambda function throws an exception or if the Lambda
function returns a failed intent state without a message. Timeout message - If you don't
configure a timeout message and a timeout, and the Lambda function doesn't return within 30
seconds, the timeout message is returned. If you configure a timeout, the timeout message
is returned when the period times out. For more information, see Completion message.
# Arguments
- `content-_type`: Indicates the format for audio input or that the content is text. The
header must start with one of the following prefixes: PCM format, audio data must be in
little-endian byte order. audio/l16; rate=16000; channels=1 audio/x-l16;
sample-rate=16000; channel-count=1 audio/lpcm; sample-rate=8000; sample-size-bits=16;
channel-count=1; is-big-endian=false Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format text/plain; charset=utf-8
- `bot_alias_id`: The alias identifier in use for the bot that should receive the request.
- `bot_id`: The identifier of the bot that should receive the request.
- `locale_id`: The locale where the session is in use.
- `session_id`: The identifier of the session in use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Response-Content-Type"`: The message that Amazon Lex V2 returns in the response can be
either text or speech based on the responseContentType value. If the value is
text/plain;charset=utf-8, Amazon Lex V2 returns text in the response. If the value begins
with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly
to generate the speech using the configuration that you specified in the
responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon
Lex V2 returns speech in the MPEG format. If the value is audio/pcm, the speech returned
is audio/pcm at 16 KHz in 16-bit, little-endian format. The following are the accepted
values: audio/mpeg audio/ogg audio/pcm (16 KHz) audio/* (defaults to mpeg)
text/plain; charset=utf-8
- `"inputStream"`: User input in PCM or Opus audio format or text format as described in
the requestContentType parameter.
- `"x-amz-lex-request-attributes"`: Request-specific information passed between the client
application and Amazon Lex V2 The namespace x-amz-lex: is reserved for special attributes.
Don't create any request attributes for prefix x-amz-lex:. The requestAttributes field must
be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
- `"x-amz-lex-session-state"`: Sets the state of the session with the user. You can use
this to set the current intent, attributes, context, and dialog action. Use the dialog
action to determine the next step that Amazon Lex V2 should use in the conversation with
the user. The sessionState field must be compressed using gzip and then base64 encoded
before sending to Amazon Lex V2.
"""
function recognize_utterance(
Content_Type,
botAliasId,
botId,
localeId,
sessionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"POST",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)/utterance",
Dict{String,Any}("headers" => Dict{String,Any}("Content-Type" => Content_Type));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function recognize_utterance(
Content_Type,
botAliasId,
botId,
localeId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lex_runtime_v2(
"POST",
"/bots/$(botId)/botAliases/$(botAliasId)/botLocales/$(localeId)/sessions/$(sessionId)/utterance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("Content-Type" => Content_Type)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 75854 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: license_manager
using AWS.Compat
using AWS.UUIDs
"""
accept_grant(grant_arn)
accept_grant(grant_arn, params::Dict{String,<:Any})
Accepts the specified grant.
# Arguments
- `grant_arn`: Amazon Resource Name (ARN) of the grant.
"""
function accept_grant(GrantArn; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"AcceptGrant",
Dict{String,Any}("GrantArn" => GrantArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_grant(
GrantArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"AcceptGrant",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GrantArn" => GrantArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_in_license(license_consumption_token)
check_in_license(license_consumption_token, params::Dict{String,<:Any})
Checks in the specified license. Check in a license when it is no longer in use.
# Arguments
- `license_consumption_token`: License consumption token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Beneficiary"`: License beneficiary.
"""
function check_in_license(
LicenseConsumptionToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"CheckInLicense",
Dict{String,Any}("LicenseConsumptionToken" => LicenseConsumptionToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_in_license(
LicenseConsumptionToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CheckInLicense",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConsumptionToken" => LicenseConsumptionToken),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
checkout_borrow_license(client_token, digital_signature_method, entitlements, license_arn)
checkout_borrow_license(client_token, digital_signature_method, entitlements, license_arn, params::Dict{String,<:Any})
Checks out the specified license for offline use.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `digital_signature_method`: Digital signature method. The possible value is JSON Web
Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with
RSASSA-PSS.
- `entitlements`: License entitlements. Partial checkouts are not supported.
- `license_arn`: Amazon Resource Name (ARN) of the license. The license must use the borrow
consumption configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CheckoutMetadata"`: Information about constraints.
- `"NodeId"`: Node ID.
"""
function checkout_borrow_license(
ClientToken,
DigitalSignatureMethod,
Entitlements,
LicenseArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CheckoutBorrowLicense",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DigitalSignatureMethod" => DigitalSignatureMethod,
"Entitlements" => Entitlements,
"LicenseArn" => LicenseArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function checkout_borrow_license(
ClientToken,
DigitalSignatureMethod,
Entitlements,
LicenseArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CheckoutBorrowLicense",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DigitalSignatureMethod" => DigitalSignatureMethod,
"Entitlements" => Entitlements,
"LicenseArn" => LicenseArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
checkout_license(checkout_type, client_token, entitlements, key_fingerprint, product_sku)
checkout_license(checkout_type, client_token, entitlements, key_fingerprint, product_sku, params::Dict{String,<:Any})
Checks out the specified license. If the account that created the license is the same that
is performing the check out, you must specify the account as the beneficiary.
# Arguments
- `checkout_type`: Checkout type.
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `entitlements`: License entitlements.
- `key_fingerprint`: Key fingerprint identifying the license.
- `product_sku`: Product SKU.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Beneficiary"`: License beneficiary.
- `"NodeId"`: Node ID.
"""
function checkout_license(
CheckoutType,
ClientToken,
Entitlements,
KeyFingerprint,
ProductSKU;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CheckoutLicense",
Dict{String,Any}(
"CheckoutType" => CheckoutType,
"ClientToken" => ClientToken,
"Entitlements" => Entitlements,
"KeyFingerprint" => KeyFingerprint,
"ProductSKU" => ProductSKU,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function checkout_license(
CheckoutType,
ClientToken,
Entitlements,
KeyFingerprint,
ProductSKU,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CheckoutLicense",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CheckoutType" => CheckoutType,
"ClientToken" => ClientToken,
"Entitlements" => Entitlements,
"KeyFingerprint" => KeyFingerprint,
"ProductSKU" => ProductSKU,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_grant(allowed_operations, client_token, grant_name, home_region, license_arn, principals)
create_grant(allowed_operations, client_token, grant_name, home_region, license_arn, principals, params::Dict{String,<:Any})
Creates a grant for the specified license. A grant shares the use of license entitlements
with a specific Amazon Web Services account, an organization, or an organizational unit
(OU). For more information, see Granted licenses in License Manager in the License Manager
User Guide.
# Arguments
- `allowed_operations`: Allowed operations for the grant.
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `grant_name`: Grant name.
- `home_region`: Home Region of the grant.
- `license_arn`: Amazon Resource Name (ARN) of the license.
- `principals`: The grant principals. You can specify one of the following as an Amazon
Resource Name (ARN): An Amazon Web Services account, which includes only the account
specified. An organizational unit (OU), which includes all accounts in the OU. An
organization, which will include all accounts across your organization.
"""
function create_grant(
AllowedOperations,
ClientToken,
GrantName,
HomeRegion,
LicenseArn,
Principals;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateGrant",
Dict{String,Any}(
"AllowedOperations" => AllowedOperations,
"ClientToken" => ClientToken,
"GrantName" => GrantName,
"HomeRegion" => HomeRegion,
"LicenseArn" => LicenseArn,
"Principals" => Principals,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_grant(
AllowedOperations,
ClientToken,
GrantName,
HomeRegion,
LicenseArn,
Principals,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AllowedOperations" => AllowedOperations,
"ClientToken" => ClientToken,
"GrantName" => GrantName,
"HomeRegion" => HomeRegion,
"LicenseArn" => LicenseArn,
"Principals" => Principals,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_grant_version(client_token, grant_arn)
create_grant_version(client_token, grant_arn, params::Dict{String,<:Any})
Creates a new version of the specified grant. For more information, see Granted licenses in
License Manager in the License Manager User Guide.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `grant_arn`: Amazon Resource Name (ARN) of the grant.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedOperations"`: Allowed operations for the grant.
- `"GrantName"`: Grant name.
- `"Options"`: The options specified for the grant.
- `"SourceVersion"`: Current version of the grant.
- `"Status"`: Grant status.
- `"StatusReason"`: Grant status reason.
"""
function create_grant_version(
ClientToken, GrantArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"CreateGrantVersion",
Dict{String,Any}("ClientToken" => ClientToken, "GrantArn" => GrantArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_grant_version(
ClientToken,
GrantArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateGrantVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientToken" => ClientToken, "GrantArn" => GrantArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_license(beneficiary, client_token, consumption_configuration, entitlements, home_region, issuer, license_name, product_name, product_sku, validity)
create_license(beneficiary, client_token, consumption_configuration, entitlements, home_region, issuer, license_name, product_name, product_sku, validity, params::Dict{String,<:Any})
Creates a license.
# Arguments
- `beneficiary`: License beneficiary.
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `consumption_configuration`: Configuration for consumption of the license. Choose a
provisional configuration for workloads running with continuous connectivity. Choose a
borrow configuration for workloads with offline usage.
- `entitlements`: License entitlements.
- `home_region`: Home Region for the license.
- `issuer`: License issuer.
- `license_name`: License name.
- `product_name`: Product name.
- `product_sku`: Product SKU.
- `validity`: Date and time range during which the license is valid, in ISO8601-UTC format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LicenseMetadata"`: Information about the license.
"""
function create_license(
Beneficiary,
ClientToken,
ConsumptionConfiguration,
Entitlements,
HomeRegion,
Issuer,
LicenseName,
ProductName,
ProductSKU,
Validity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicense",
Dict{String,Any}(
"Beneficiary" => Beneficiary,
"ClientToken" => ClientToken,
"ConsumptionConfiguration" => ConsumptionConfiguration,
"Entitlements" => Entitlements,
"HomeRegion" => HomeRegion,
"Issuer" => Issuer,
"LicenseName" => LicenseName,
"ProductName" => ProductName,
"ProductSKU" => ProductSKU,
"Validity" => Validity,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_license(
Beneficiary,
ClientToken,
ConsumptionConfiguration,
Entitlements,
HomeRegion,
Issuer,
LicenseName,
ProductName,
ProductSKU,
Validity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicense",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Beneficiary" => Beneficiary,
"ClientToken" => ClientToken,
"ConsumptionConfiguration" => ConsumptionConfiguration,
"Entitlements" => Entitlements,
"HomeRegion" => HomeRegion,
"Issuer" => Issuer,
"LicenseName" => LicenseName,
"ProductName" => ProductName,
"ProductSKU" => ProductSKU,
"Validity" => Validity,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_license_configuration(license_counting_type, name)
create_license_configuration(license_counting_type, name, params::Dict{String,<:Any})
Creates a license configuration. A license configuration is an abstraction of a customer
license agreement that can be consumed and enforced by License Manager. Components include
specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed
tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license
affinity to host (how long a license must be associated with a host), and the number of
licenses purchased and used.
# Arguments
- `license_counting_type`: Dimension used to track the license inventory.
- `name`: Name of the license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Description of the license configuration.
- `"DisassociateWhenNotFound"`: When true, disassociates a resource when software is
uninstalled.
- `"LicenseCount"`: Number of licenses managed by the license configuration.
- `"LicenseCountHardLimit"`: Indicates whether hard or soft license enforcement is used.
Exceeding a hard limit blocks the launch of new instances.
- `"LicenseRules"`: License rules. The syntax is #name=value (for example,
#allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores
Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets |
minimumSockets | maximumVcpus | minimumVcpus Sockets dimension: allowedTenancy |
licenseAffinityToHost | maximumSockets | minimumSockets vCPUs dimension: allowedTenancy
| honorVcpuOptimization | maximumVcpus | minimumVcpus The unit for licenseAffinityToHost
is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default,
EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization
are True and False.
- `"ProductInformationList"`: Product information.
- `"Tags"`: Tags to add to the license configuration.
"""
function create_license_configuration(
LicenseCountingType, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"CreateLicenseConfiguration",
Dict{String,Any}("LicenseCountingType" => LicenseCountingType, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_license_configuration(
LicenseCountingType,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LicenseCountingType" => LicenseCountingType, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_license_conversion_task_for_resource(destination_license_context, resource_arn, source_license_context)
create_license_conversion_task_for_resource(destination_license_context, resource_arn, source_license_context, params::Dict{String,<:Any})
Creates a new license conversion task.
# Arguments
- `destination_license_context`: Information that identifies the license type you are
converting to. For the structure of the destination license, see Convert a license type
using the CLI in the License Manager User Guide.
- `resource_arn`: Amazon Resource Name (ARN) of the resource you are converting the license
type for.
- `source_license_context`: Information that identifies the license type you are converting
from. For the structure of the source license, see Convert a license type using the CLI in
the License Manager User Guide.
"""
function create_license_conversion_task_for_resource(
DestinationLicenseContext,
ResourceArn,
SourceLicenseContext;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseConversionTaskForResource",
Dict{String,Any}(
"DestinationLicenseContext" => DestinationLicenseContext,
"ResourceArn" => ResourceArn,
"SourceLicenseContext" => SourceLicenseContext,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_license_conversion_task_for_resource(
DestinationLicenseContext,
ResourceArn,
SourceLicenseContext,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseConversionTaskForResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationLicenseContext" => DestinationLicenseContext,
"ResourceArn" => ResourceArn,
"SourceLicenseContext" => SourceLicenseContext,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_license_manager_report_generator(client_token, report_context, report_frequency, report_generator_name, type)
create_license_manager_report_generator(client_token, report_context, report_frequency, report_generator_name, type, params::Dict{String,<:Any})
Creates a report generator.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `report_context`: Defines the type of license configuration the report generator tracks.
- `report_frequency`: Frequency by which reports are generated. Reports can be generated
daily, monthly, or weekly.
- `report_generator_name`: Name of the report generator.
- `type`: Type of reports to generate. The following report types an be generated:
License configuration report - Reports the number and details of consumed licenses for a
license configuration. Resource report - Reports the tracked licenses and resource
consumption for a license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Description of the report generator.
- `"Tags"`: Tags to add to the report generator.
"""
function create_license_manager_report_generator(
ClientToken,
ReportContext,
ReportFrequency,
ReportGeneratorName,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseManagerReportGenerator",
Dict{String,Any}(
"ClientToken" => ClientToken,
"ReportContext" => ReportContext,
"ReportFrequency" => ReportFrequency,
"ReportGeneratorName" => ReportGeneratorName,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_license_manager_report_generator(
ClientToken,
ReportContext,
ReportFrequency,
ReportGeneratorName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseManagerReportGenerator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"ReportContext" => ReportContext,
"ReportFrequency" => ReportFrequency,
"ReportGeneratorName" => ReportGeneratorName,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_license_version(client_token, consumption_configuration, entitlements, home_region, issuer, license_arn, license_name, product_name, status, validity)
create_license_version(client_token, consumption_configuration, entitlements, home_region, issuer, license_arn, license_name, product_name, status, validity, params::Dict{String,<:Any})
Creates a new version of the specified license.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `consumption_configuration`: Configuration for consumption of the license. Choose a
provisional configuration for workloads running with continuous connectivity. Choose a
borrow configuration for workloads with offline usage.
- `entitlements`: License entitlements.
- `home_region`: Home Region of the license.
- `issuer`: License issuer.
- `license_arn`: Amazon Resource Name (ARN) of the license.
- `license_name`: License name.
- `product_name`: Product name.
- `status`: License status.
- `validity`: Date and time range during which the license is valid, in ISO8601-UTC format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LicenseMetadata"`: Information about the license.
- `"SourceVersion"`: Current version of the license.
"""
function create_license_version(
ClientToken,
ConsumptionConfiguration,
Entitlements,
HomeRegion,
Issuer,
LicenseArn,
LicenseName,
ProductName,
Status,
Validity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseVersion",
Dict{String,Any}(
"ClientToken" => ClientToken,
"ConsumptionConfiguration" => ConsumptionConfiguration,
"Entitlements" => Entitlements,
"HomeRegion" => HomeRegion,
"Issuer" => Issuer,
"LicenseArn" => LicenseArn,
"LicenseName" => LicenseName,
"ProductName" => ProductName,
"Status" => Status,
"Validity" => Validity,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_license_version(
ClientToken,
ConsumptionConfiguration,
Entitlements,
HomeRegion,
Issuer,
LicenseArn,
LicenseName,
ProductName,
Status,
Validity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateLicenseVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"ConsumptionConfiguration" => ConsumptionConfiguration,
"Entitlements" => Entitlements,
"HomeRegion" => HomeRegion,
"Issuer" => Issuer,
"LicenseArn" => LicenseArn,
"LicenseName" => LicenseName,
"ProductName" => ProductName,
"Status" => Status,
"Validity" => Validity,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_token(client_token, license_arn)
create_token(client_token, license_arn, params::Dict{String,<:Any})
Creates a long-lived token. A refresh token is a JWT token used to get an access token.
With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that
you can use to call License Manager to manage the specified license.
# Arguments
- `client_token`: Idempotency token, valid for 10 minutes.
- `license_arn`: Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud
claim of the JWT token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpirationInDays"`: Token expiration, in days, counted from token creation. The default
is 365 days.
- `"RoleArns"`: Amazon Resource Name (ARN) of the IAM roles to embed in the token. License
Manager does not check whether the roles are in use.
- `"TokenProperties"`: Data specified by the caller to be included in the JWT token. The
data is mapped to the amr claim of the JWT token.
"""
function create_token(
ClientToken, LicenseArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"CreateToken",
Dict{String,Any}("ClientToken" => ClientToken, "LicenseArn" => LicenseArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_token(
ClientToken,
LicenseArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"CreateToken",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientToken" => ClientToken, "LicenseArn" => LicenseArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_grant(grant_arn, version)
delete_grant(grant_arn, version, params::Dict{String,<:Any})
Deletes the specified grant.
# Arguments
- `grant_arn`: Amazon Resource Name (ARN) of the grant.
- `version`: Current version of the grant.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StatusReason"`: The Status reason for the delete request.
"""
function delete_grant(GrantArn, Version; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"DeleteGrant",
Dict{String,Any}("GrantArn" => GrantArn, "Version" => Version);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_grant(
GrantArn,
Version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"DeleteGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GrantArn" => GrantArn, "Version" => Version),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_license(license_arn, source_version)
delete_license(license_arn, source_version, params::Dict{String,<:Any})
Deletes the specified license.
# Arguments
- `license_arn`: Amazon Resource Name (ARN) of the license.
- `source_version`: Current version of the license.
"""
function delete_license(
LicenseArn, SourceVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"DeleteLicense",
Dict{String,Any}("LicenseArn" => LicenseArn, "SourceVersion" => SourceVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_license(
LicenseArn,
SourceVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"DeleteLicense",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LicenseArn" => LicenseArn, "SourceVersion" => SourceVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_license_configuration(license_configuration_arn)
delete_license_configuration(license_configuration_arn, params::Dict{String,<:Any})
Deletes the specified license configuration. You cannot delete a license configuration that
is in use.
# Arguments
- `license_configuration_arn`: ID of the license configuration.
"""
function delete_license_configuration(
LicenseConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"DeleteLicenseConfiguration",
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_license_configuration(
LicenseConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"DeleteLicenseConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_license_manager_report_generator(license_manager_report_generator_arn)
delete_license_manager_report_generator(license_manager_report_generator_arn, params::Dict{String,<:Any})
Deletes the specified report generator. This action deletes the report generator, which
stops it from generating future reports. The action cannot be reversed. It has no effect on
the previous reports from this generator.
# Arguments
- `license_manager_report_generator_arn`: Amazon Resource Name (ARN) of the report
generator to be deleted.
"""
function delete_license_manager_report_generator(
LicenseManagerReportGeneratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"DeleteLicenseManagerReportGenerator",
Dict{String,Any}(
"LicenseManagerReportGeneratorArn" => LicenseManagerReportGeneratorArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_license_manager_report_generator(
LicenseManagerReportGeneratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"DeleteLicenseManagerReportGenerator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LicenseManagerReportGeneratorArn" => LicenseManagerReportGeneratorArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_token(token_id)
delete_token(token_id, params::Dict{String,<:Any})
Deletes the specified token. Must be called in the license home Region.
# Arguments
- `token_id`: Token ID.
"""
function delete_token(TokenId; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"DeleteToken",
Dict{String,Any}("TokenId" => TokenId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_token(
TokenId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"DeleteToken",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TokenId" => TokenId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
extend_license_consumption(license_consumption_token)
extend_license_consumption(license_consumption_token, params::Dict{String,<:Any})
Extends the expiration date for license consumption.
# Arguments
- `license_consumption_token`: License consumption token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks whether you have the required permissions for the action, without
actually making the request. Provides an error response if you do not have the required
permissions.
"""
function extend_license_consumption(
LicenseConsumptionToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ExtendLicenseConsumption",
Dict{String,Any}("LicenseConsumptionToken" => LicenseConsumptionToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function extend_license_consumption(
LicenseConsumptionToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ExtendLicenseConsumption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConsumptionToken" => LicenseConsumptionToken),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_token(token)
get_access_token(token, params::Dict{String,<:Any})
Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are
valid for one hour.
# Arguments
- `token`: Refresh token, encoded as a JWT token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TokenProperties"`: Token properties to validate against those present in the JWT token.
"""
function get_access_token(Token; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"GetAccessToken",
Dict{String,Any}("Token" => Token);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_token(
Token, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"GetAccessToken",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Token" => Token), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_grant(grant_arn)
get_grant(grant_arn, params::Dict{String,<:Any})
Gets detailed information about the specified grant.
# Arguments
- `grant_arn`: Amazon Resource Name (ARN) of the grant.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Version"`: Grant version.
"""
function get_grant(GrantArn; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"GetGrant",
Dict{String,Any}("GrantArn" => GrantArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_grant(
GrantArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"GetGrant",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GrantArn" => GrantArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license(license_arn)
get_license(license_arn, params::Dict{String,<:Any})
Gets detailed information about the specified license.
# Arguments
- `license_arn`: Amazon Resource Name (ARN) of the license.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Version"`: License version.
"""
function get_license(LicenseArn; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"GetLicense",
Dict{String,Any}("LicenseArn" => LicenseArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_license(
LicenseArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"GetLicense",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LicenseArn" => LicenseArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license_configuration(license_configuration_arn)
get_license_configuration(license_configuration_arn, params::Dict{String,<:Any})
Gets detailed information about the specified license configuration.
# Arguments
- `license_configuration_arn`: Amazon Resource Name (ARN) of the license configuration.
"""
function get_license_configuration(
LicenseConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"GetLicenseConfiguration",
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_license_configuration(
LicenseConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"GetLicenseConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license_conversion_task(license_conversion_task_id)
get_license_conversion_task(license_conversion_task_id, params::Dict{String,<:Any})
Gets information about the specified license type conversion task.
# Arguments
- `license_conversion_task_id`: ID of the license type conversion task to retrieve
information on.
"""
function get_license_conversion_task(
LicenseConversionTaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"GetLicenseConversionTask",
Dict{String,Any}("LicenseConversionTaskId" => LicenseConversionTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_license_conversion_task(
LicenseConversionTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"GetLicenseConversionTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConversionTaskId" => LicenseConversionTaskId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license_manager_report_generator(license_manager_report_generator_arn)
get_license_manager_report_generator(license_manager_report_generator_arn, params::Dict{String,<:Any})
Gets information about the specified report generator.
# Arguments
- `license_manager_report_generator_arn`: Amazon Resource Name (ARN) of the report
generator.
"""
function get_license_manager_report_generator(
LicenseManagerReportGeneratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"GetLicenseManagerReportGenerator",
Dict{String,Any}(
"LicenseManagerReportGeneratorArn" => LicenseManagerReportGeneratorArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_license_manager_report_generator(
LicenseManagerReportGeneratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"GetLicenseManagerReportGenerator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LicenseManagerReportGeneratorArn" => LicenseManagerReportGeneratorArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license_usage(license_arn)
get_license_usage(license_arn, params::Dict{String,<:Any})
Gets detailed information about the usage of the specified license.
# Arguments
- `license_arn`: Amazon Resource Name (ARN) of the license.
"""
function get_license_usage(LicenseArn; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"GetLicenseUsage",
Dict{String,Any}("LicenseArn" => LicenseArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_license_usage(
LicenseArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"GetLicenseUsage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LicenseArn" => LicenseArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_settings()
get_service_settings(params::Dict{String,<:Any})
Gets the License Manager settings for the current Region.
"""
function get_service_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"GetServiceSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_service_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"GetServiceSettings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_associations_for_license_configuration(license_configuration_arn)
list_associations_for_license_configuration(license_configuration_arn, params::Dict{String,<:Any})
Lists the resource associations for the specified license configuration. Resource
associations need not consume licenses from a license configuration. For example, an AMI or
a stopped instance might not consume a license (depending on the license rules).
# Arguments
- `license_configuration_arn`: Amazon Resource Name (ARN) of a license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_associations_for_license_configuration(
LicenseConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListAssociationsForLicenseConfiguration",
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associations_for_license_configuration(
LicenseConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListAssociationsForLicenseConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_distributed_grants()
list_distributed_grants(params::Dict{String,<:Any})
Lists the grants distributed for the specified license.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
LicenseArn GrantStatus GranteePrincipalARN ProductSKU LicenseIssuerName
- `"GrantArns"`: Amazon Resource Names (ARNs) of the grants.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_distributed_grants(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListDistributedGrants"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_distributed_grants(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListDistributedGrants",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_failures_for_license_configuration_operations(license_configuration_arn)
list_failures_for_license_configuration_operations(license_configuration_arn, params::Dict{String,<:Any})
Lists the license configuration operations that failed.
# Arguments
- `license_configuration_arn`: Amazon Resource Name of the license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_failures_for_license_configuration_operations(
LicenseConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListFailuresForLicenseConfigurationOperations",
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_failures_for_license_configuration_operations(
LicenseConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListFailuresForLicenseConfigurationOperations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_license_configurations()
list_license_configurations(params::Dict{String,<:Any})
Lists the license configurations for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters and logical operators
are supported: licenseCountingType - The dimension for which licenses are counted.
Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS |
NOT_EQUALS. enforceLicenseCount - A Boolean value that indicates whether hard license
enforcement is used. Logical operators are EQUALS | NOT_EQUALS. usagelimitExceeded - A
Boolean value that indicates whether the available licenses have been exceeded. Logical
operators are EQUALS | NOT_EQUALS.
- `"LicenseConfigurationArns"`: Amazon Resource Names (ARN) of the license configurations.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_license_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListLicenseConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_license_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenseConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_license_conversion_tasks()
list_license_conversion_tasks(params::Dict{String,<:Any})
Lists the license type conversion tasks for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. Valid filters are ResourceArns and Status.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_license_conversion_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListLicenseConversionTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_license_conversion_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenseConversionTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_license_manager_report_generators()
list_license_manager_report_generators(params::Dict{String,<:Any})
Lists the report generators for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
LicenseConfigurationArn
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_license_manager_report_generators(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenseManagerReportGenerators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_license_manager_report_generators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenseManagerReportGenerators",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_license_specifications_for_resource(resource_arn)
list_license_specifications_for_resource(resource_arn, params::Dict{String,<:Any})
Describes the license configurations for the specified resource.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of a resource that has an associated license
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_license_specifications_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenseSpecificationsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_license_specifications_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListLicenseSpecificationsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_license_versions(license_arn)
list_license_versions(license_arn, params::Dict{String,<:Any})
Lists all versions of the specified license.
# Arguments
- `license_arn`: Amazon Resource Name (ARN) of the license.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_license_versions(
LicenseArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenseVersions",
Dict{String,Any}("LicenseArn" => LicenseArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_license_versions(
LicenseArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListLicenseVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LicenseArn" => LicenseArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_licenses()
list_licenses(params::Dict{String,<:Any})
Lists the licenses for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
Beneficiary ProductSKU Fingerprint Status
- `"LicenseArns"`: Amazon Resource Names (ARNs) of the licenses.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_licenses(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListLicenses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_licenses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListLicenses", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_received_grants()
list_received_grants(params::Dict{String,<:Any})
Lists grants that are received. Received grants are grants created while specifying the
recipient as this Amazon Web Services account, your organization, or an organizational unit
(OU) to which this member account belongs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
ProductSKU LicenseIssuerName LicenseArn GrantStatus GranterAccountId
- `"GrantArns"`: Amazon Resource Names (ARNs) of the grants.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_received_grants(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListReceivedGrants"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_received_grants(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListReceivedGrants", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_received_grants_for_organization(license_arn)
list_received_grants_for_organization(license_arn, params::Dict{String,<:Any})
Lists the grants received for all accounts in the organization.
# Arguments
- `license_arn`: The Amazon Resource Name (ARN) of the received license.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
ParentArn GranteePrincipalArn
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_received_grants_for_organization(
LicenseArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListReceivedGrantsForOrganization",
Dict{String,Any}("LicenseArn" => LicenseArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_received_grants_for_organization(
LicenseArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListReceivedGrantsForOrganization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LicenseArn" => LicenseArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_received_licenses()
list_received_licenses(params::Dict{String,<:Any})
Lists received licenses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
ProductSKU Status Fingerprint IssuerName Beneficiary
- `"LicenseArns"`: Amazon Resource Names (ARNs) of the licenses.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_received_licenses(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListReceivedLicenses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_received_licenses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListReceivedLicenses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_received_licenses_for_organization()
list_received_licenses_for_organization(params::Dict{String,<:Any})
Lists the licenses received for all accounts in the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters are supported:
Beneficiary ProductSKU
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_received_licenses_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListReceivedLicensesForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_received_licenses_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListReceivedLicensesForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_inventory()
list_resource_inventory(params::Dict{String,<:Any})
Lists resources managed using Systems Manager inventory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters and logical operators
are supported: account_id - The ID of the Amazon Web Services account that owns the
resource. Logical operators are EQUALS | NOT_EQUALS. application_name - The name of the
application. Logical operators are EQUALS | BEGINS_WITH. license_included - The type of
license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are
sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.
resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.
tag:<key> - The key/value combination of a tag assigned to the resource. Logical
operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_resource_inventory(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListResourceInventory"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resource_inventory(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListResourceInventory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for the specified license configuration.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the license configuration.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tokens()
list_tokens(params::Dict{String,<:Any})
Lists your tokens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filter is supported:
LicenseArns
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
- `"TokenIds"`: Token IDs.
"""
function list_tokens(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"ListTokens"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tokens(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListTokens", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_usage_for_license_configuration(license_configuration_arn)
list_usage_for_license_configuration(license_configuration_arn, params::Dict{String,<:Any})
Lists all license usage records for a license configuration, displaying license consumption
details by resource at a selected point in time. Use this action to audit the current
license consumption for any license inventory and configuration.
# Arguments
- `license_configuration_arn`: Amazon Resource Name (ARN) of the license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to scope the results. The following filters and logical operators
are supported: resourceArn - The ARN of the license configuration resource. Logical
operators are EQUALS | NOT_EQUALS. resourceType - The resource type (EC2_INSTANCE |
EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS |
NOT_EQUALS. resourceAccount - The ID of the account that owns the resource. Logical
operators are EQUALS | NOT_EQUALS.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_usage_for_license_configuration(
LicenseConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"ListUsageForLicenseConfiguration",
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_usage_for_license_configuration(
LicenseConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"ListUsageForLicenseConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_grant(grant_arn)
reject_grant(grant_arn, params::Dict{String,<:Any})
Rejects the specified grant.
# Arguments
- `grant_arn`: Amazon Resource Name (ARN) of the grant.
"""
function reject_grant(GrantArn; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"RejectGrant",
Dict{String,Any}("GrantArn" => GrantArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_grant(
GrantArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"RejectGrant",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GrantArn" => GrantArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tags to the specified license configuration.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the license configuration.
- `tags`: One or more tags.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the specified license configuration.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the license configuration.
- `tag_keys`: Keys identifying the tags to remove.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_license_configuration(license_configuration_arn)
update_license_configuration(license_configuration_arn, params::Dict{String,<:Any})
Modifies the attributes of an existing license configuration.
# Arguments
- `license_configuration_arn`: Amazon Resource Name (ARN) of the license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: New description of the license configuration.
- `"DisassociateWhenNotFound"`: When true, disassociates a resource when software is
uninstalled.
- `"LicenseConfigurationStatus"`: New status of the license configuration.
- `"LicenseCount"`: New number of licenses managed by the license configuration.
- `"LicenseCountHardLimit"`: New hard limit of the number of available licenses.
- `"LicenseRules"`: New license rule. The only rule that you can add after you create a
license configuration is licenseAffinityToHost.
- `"Name"`: New name of the license configuration.
- `"ProductInformationList"`: New product information.
"""
function update_license_configuration(
LicenseConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"UpdateLicenseConfiguration",
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_license_configuration(
LicenseConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"UpdateLicenseConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LicenseConfigurationArn" => LicenseConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_license_manager_report_generator(client_token, license_manager_report_generator_arn, report_context, report_frequency, report_generator_name, type)
update_license_manager_report_generator(client_token, license_manager_report_generator_arn, report_context, report_frequency, report_generator_name, type, params::Dict{String,<:Any})
Updates a report generator. After you make changes to a report generator, it starts
generating new reports within 60 minutes of being updated.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `license_manager_report_generator_arn`: Amazon Resource Name (ARN) of the report
generator to update.
- `report_context`: The report context.
- `report_frequency`: Frequency by which reports are generated.
- `report_generator_name`: Name of the report generator.
- `type`: Type of reports to generate. The following report types are supported: License
configuration report - Reports the number and details of consumed licenses for a license
configuration. Resource report - Reports the tracked licenses and resource consumption
for a license configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Description of the report generator.
"""
function update_license_manager_report_generator(
ClientToken,
LicenseManagerReportGeneratorArn,
ReportContext,
ReportFrequency,
ReportGeneratorName,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"UpdateLicenseManagerReportGenerator",
Dict{String,Any}(
"ClientToken" => ClientToken,
"LicenseManagerReportGeneratorArn" => LicenseManagerReportGeneratorArn,
"ReportContext" => ReportContext,
"ReportFrequency" => ReportFrequency,
"ReportGeneratorName" => ReportGeneratorName,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_license_manager_report_generator(
ClientToken,
LicenseManagerReportGeneratorArn,
ReportContext,
ReportFrequency,
ReportGeneratorName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"UpdateLicenseManagerReportGenerator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"LicenseManagerReportGeneratorArn" => LicenseManagerReportGeneratorArn,
"ReportContext" => ReportContext,
"ReportFrequency" => ReportFrequency,
"ReportGeneratorName" => ReportGeneratorName,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_license_specifications_for_resource(resource_arn)
update_license_specifications_for_resource(resource_arn, params::Dict{String,<:Any})
Adds or removes the specified license configurations for the specified Amazon Web Services
resource. You can update the license specifications of AMIs, instances, and hosts. You
cannot update the license specifications for launch templates and CloudFormation templates,
as they send license configurations to the operation that creates the resource.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the Amazon Web Services resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddLicenseSpecifications"`: ARNs of the license configurations to add.
- `"RemoveLicenseSpecifications"`: ARNs of the license configurations to remove.
"""
function update_license_specifications_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"UpdateLicenseSpecificationsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_license_specifications_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager(
"UpdateLicenseSpecificationsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_settings()
update_service_settings(params::Dict{String,<:Any})
Updates License Manager settings for the current Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnableCrossAccountsDiscovery"`: Activates cross-account discovery.
- `"OrganizationConfiguration"`: Enables integration with Organizations for cross-account
discovery.
- `"S3BucketArn"`: Amazon Resource Name (ARN) of the Amazon S3 bucket where the License
Manager information is stored.
- `"SnsTopicArn"`: Amazon Resource Name (ARN) of the Amazon SNS topic used for License
Manager alerts.
"""
function update_service_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager(
"UpdateServiceSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_service_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager(
"UpdateServiceSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 6403 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: license_manager_linux_subscriptions
using AWS.Compat
using AWS.UUIDs
"""
get_service_settings()
get_service_settings(params::Dict{String,<:Any})
Lists the Linux subscriptions service settings.
"""
function get_service_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager_linux_subscriptions(
"POST",
"/subscription/GetServiceSettings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_linux_subscriptions(
"POST",
"/subscription/GetServiceSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_linux_subscription_instances()
list_linux_subscription_instances(params::Dict{String,<:Any})
Lists the running Amazon EC2 instances that were discovered with commercial Linux
subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of structures that you can use to filter the results to those that
match one or more sets of key-value pairs that you specify. For example, you can filter by
the name of AmiID with an optional operator to see subscriptions that match, partially
match, or don't match a certain Amazon Machine Image (AMI) ID. The valid names for this
filter are: AmiID InstanceID AccountID Status Region UsageOperation
ProductCode InstanceType The valid Operators for this filter are: contains
equals Notequal
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_linux_subscription_instances(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_linux_subscriptions(
"POST",
"/subscription/ListLinuxSubscriptionInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_linux_subscription_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_linux_subscriptions(
"POST",
"/subscription/ListLinuxSubscriptionInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_linux_subscriptions()
list_linux_subscriptions(params::Dict{String,<:Any})
Lists the Linux subscriptions that have been discovered. If you have linked your
organization, the returned results will include data aggregated across your accounts in
Organizations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of structures that you can use to filter the results to those that
match one or more sets of key-value pairs that you specify. For example, you can filter by
the name of Subscription with an optional operator to see subscriptions that match,
partially match, or don't match a certain subscription's name. The valid names for this
filter are: Subscription The valid Operators for this filter are: contains
equals Notequal
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_linux_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager_linux_subscriptions(
"POST",
"/subscription/ListLinuxSubscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_linux_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_linux_subscriptions(
"POST",
"/subscription/ListLinuxSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_settings(linux_subscriptions_discovery, linux_subscriptions_discovery_settings)
update_service_settings(linux_subscriptions_discovery, linux_subscriptions_discovery_settings, params::Dict{String,<:Any})
Updates the service settings for Linux subscriptions.
# Arguments
- `linux_subscriptions_discovery`: Describes if the discovery of Linux subscriptions is
enabled.
- `linux_subscriptions_discovery_settings`: The settings defined for Linux subscriptions
discovery. The settings include if Organizations integration has been enabled, and which
Regions data will be aggregated from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowUpdate"`: Describes if updates are allowed to the service settings for Linux
subscriptions. If you allow updates, you can aggregate Linux subscription data in more than
one home Region.
"""
function update_service_settings(
LinuxSubscriptionsDiscovery,
LinuxSubscriptionsDiscoverySettings;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_linux_subscriptions(
"POST",
"/subscription/UpdateServiceSettings",
Dict{String,Any}(
"LinuxSubscriptionsDiscovery" => LinuxSubscriptionsDiscovery,
"LinuxSubscriptionsDiscoverySettings" => LinuxSubscriptionsDiscoverySettings,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_settings(
LinuxSubscriptionsDiscovery,
LinuxSubscriptionsDiscoverySettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_linux_subscriptions(
"POST",
"/subscription/UpdateServiceSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LinuxSubscriptionsDiscovery" => LinuxSubscriptionsDiscovery,
"LinuxSubscriptionsDiscoverySettings" =>
LinuxSubscriptionsDiscoverySettings,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 18700 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: license_manager_user_subscriptions
using AWS.Compat
using AWS.UUIDs
"""
associate_user(identity_provider, instance_id, username)
associate_user(identity_provider, instance_id, username, params::Dict{String,<:Any})
Associates the user to an EC2 instance to utilize user-based subscriptions. Your estimated
bill for charges on the number of users and related costs will take 48 hours to appear for
billing periods that haven't closed (marked as Pending billing status) in Amazon Web
Services Billing. For more information, see Viewing your monthly charges in the Amazon Web
Services Billing User Guide.
# Arguments
- `identity_provider`: The identity provider of the user.
- `instance_id`: The ID of the EC2 instance, which provides user-based subscriptions.
- `username`: The user name from the identity provider for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: The domain name of the user.
"""
function associate_user(
IdentityProvider,
InstanceId,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/AssociateUser",
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"InstanceId" => InstanceId,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_user(
IdentityProvider,
InstanceId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/AssociateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"InstanceId" => InstanceId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_identity_provider(identity_provider, product)
deregister_identity_provider(identity_provider, product, params::Dict{String,<:Any})
Deregisters the identity provider from providing user-based subscriptions.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `product`: The name of the user-based subscription product.
"""
function deregister_identity_provider(
IdentityProvider, Product; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/DeregisterIdentityProvider",
Dict{String,Any}("IdentityProvider" => IdentityProvider, "Product" => Product);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_identity_provider(
IdentityProvider,
Product,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/DeregisterIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider, "Product" => Product
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_user(identity_provider, instance_id, username)
disassociate_user(identity_provider, instance_id, username, params::Dict{String,<:Any})
Disassociates the user from an EC2 instance providing user-based subscriptions.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `instance_id`: The ID of the EC2 instance, which provides user-based subscriptions.
- `username`: The user name from the identity provider for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: The domain name of the user.
"""
function disassociate_user(
IdentityProvider,
InstanceId,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/DisassociateUser",
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"InstanceId" => InstanceId,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_user(
IdentityProvider,
InstanceId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/DisassociateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"InstanceId" => InstanceId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_providers()
list_identity_providers(params::Dict{String,<:Any})
Lists the identity providers for user-based subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_identity_providers(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager_user_subscriptions(
"POST",
"/identity-provider/ListIdentityProviders";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/ListIdentityProviders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instances()
list_instances(params::Dict{String,<:Any})
Lists the EC2 instances providing user-based subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of structures that you can use to filter the results to those that
match one or more sets of key-value pairs that you specify.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return license_manager_user_subscriptions(
"POST",
"/instance/ListInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/instance/ListInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_product_subscriptions(identity_provider, product)
list_product_subscriptions(identity_provider, product, params::Dict{String,<:Any})
Lists the user-based subscription products available from an identity provider.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `product`: The name of the user-based subscription product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of structures that you can use to filter the results to those that
match one or more sets of key-value pairs that you specify.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_product_subscriptions(
IdentityProvider, Product; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/user/ListProductSubscriptions",
Dict{String,Any}("IdentityProvider" => IdentityProvider, "Product" => Product);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_product_subscriptions(
IdentityProvider,
Product,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/ListProductSubscriptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider, "Product" => Product
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_associations(identity_provider, instance_id)
list_user_associations(identity_provider, instance_id, params::Dict{String,<:Any})
Lists user associations for an identity provider.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `instance_id`: The ID of the EC2 instance, which provides user-based subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of structures that you can use to filter the results to those that
match one or more sets of key-value pairs that you specify.
- `"MaxResults"`: Maximum number of results to return in a single call.
- `"NextToken"`: Token for the next set of results.
"""
function list_user_associations(
IdentityProvider, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/user/ListUserAssociations",
Dict{String,Any}(
"IdentityProvider" => IdentityProvider, "InstanceId" => InstanceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_associations(
IdentityProvider,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/ListUserAssociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider, "InstanceId" => InstanceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_identity_provider(identity_provider, product)
register_identity_provider(identity_provider, product, params::Dict{String,<:Any})
Registers an identity provider for user-based subscriptions.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `product`: The name of the user-based subscription product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Settings"`: The registered identity provider’s product related configuration settings
such as the subnets to provision VPC endpoints.
"""
function register_identity_provider(
IdentityProvider, Product; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/RegisterIdentityProvider",
Dict{String,Any}("IdentityProvider" => IdentityProvider, "Product" => Product);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_identity_provider(
IdentityProvider,
Product,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/RegisterIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider, "Product" => Product
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_product_subscription(identity_provider, product, username)
start_product_subscription(identity_provider, product, username, params::Dict{String,<:Any})
Starts a product subscription for a user with the specified identity provider. Your
estimated bill for charges on the number of users and related costs will take 48 hours to
appear for billing periods that haven't closed (marked as Pending billing status) in Amazon
Web Services Billing. For more information, see Viewing your monthly charges in the Amazon
Web Services Billing User Guide.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `product`: The name of the user-based subscription product.
- `username`: The user name from the identity provider of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: The domain name of the user.
"""
function start_product_subscription(
IdentityProvider, Product, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/user/StartProductSubscription",
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"Product" => Product,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_product_subscription(
IdentityProvider,
Product,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/StartProductSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"Product" => Product,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_product_subscription(identity_provider, product, username)
stop_product_subscription(identity_provider, product, username, params::Dict{String,<:Any})
Stops a product subscription for a user with the specified identity provider.
# Arguments
- `identity_provider`: An object that specifies details for the identity provider.
- `product`: The name of the user-based subscription product.
- `username`: The user name from the identity provider for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: The domain name of the user.
"""
function stop_product_subscription(
IdentityProvider, Product, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return license_manager_user_subscriptions(
"POST",
"/user/StopProductSubscription",
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"Product" => Product,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_product_subscription(
IdentityProvider,
Product,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/user/StopProductSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"Product" => Product,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_identity_provider_settings(identity_provider, product, update_settings)
update_identity_provider_settings(identity_provider, product, update_settings, params::Dict{String,<:Any})
Updates additional product configuration settings for the registered identity provider.
# Arguments
- `identity_provider`:
- `product`: The name of the user-based subscription product.
- `update_settings`: Updates the registered identity provider’s product related
configuration settings. You can update any combination of settings in a single operation
such as the: Subnets which you want to add to provision VPC endpoints. Subnets which
you want to remove the VPC endpoints from. Security group ID which permits traffic to the
VPC endpoints.
"""
function update_identity_provider_settings(
IdentityProvider,
Product,
UpdateSettings;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/UpdateIdentityProviderSettings",
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"Product" => Product,
"UpdateSettings" => UpdateSettings,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_identity_provider_settings(
IdentityProvider,
Product,
UpdateSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return license_manager_user_subscriptions(
"POST",
"/identity-provider/UpdateIdentityProviderSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityProvider" => IdentityProvider,
"Product" => Product,
"UpdateSettings" => UpdateSettings,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 307832 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lightsail
using AWS.Compat
using AWS.UUIDs
"""
allocate_static_ip(static_ip_name)
allocate_static_ip(static_ip_name, params::Dict{String,<:Any})
Allocates a static IP address.
# Arguments
- `static_ip_name`: The name of the static IP address.
"""
function allocate_static_ip(staticIpName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"AllocateStaticIp",
Dict{String,Any}("staticIpName" => staticIpName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_static_ip(
staticIpName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"AllocateStaticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("staticIpName" => staticIpName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_certificate_to_distribution(certificate_name, distribution_name)
attach_certificate_to_distribution(certificate_name, distribution_name, params::Dict{String,<:Any})
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)
distribution. After the certificate is attached, your distribution accepts HTTPS traffic
for all of the domains that are associated with the certificate. Use the CreateCertificate
action to create a certificate that you can attach to your distribution. Only certificates
created in the us-east-1 Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in
any Amazon Web Services Region, and distribute its content globally. However, all
distributions are located in the us-east-1 Region.
# Arguments
- `certificate_name`: The name of the certificate to attach to a distribution. Only
certificates with a status of ISSUED can be attached to a distribution. Use the
GetCertificates action to get a list of certificate names that you can specify. This is
the name of the certificate resource type and is used only to reference the certificate in
other API actions. It can be different than the domain name of the certificate. For
example, your certificate name might be WordPress-Blog-Certificate and the domain name of
the certificate might be example.com.
- `distribution_name`: The name of the distribution that the certificate will be attached
to. Use the GetDistributions action to get a list of distribution names that you can
specify.
"""
function attach_certificate_to_distribution(
certificateName, distributionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"AttachCertificateToDistribution",
Dict{String,Any}(
"certificateName" => certificateName, "distributionName" => distributionName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_certificate_to_distribution(
certificateName,
distributionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"AttachCertificateToDistribution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateName" => certificateName,
"distributionName" => distributionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_disk(disk_name, disk_path, instance_name)
attach_disk(disk_name, disk_path, instance_name, params::Dict{String,<:Any})
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to
the instance with the specified disk name. The attach disk operation supports tag-based
access control via resource tags applied to the resource identified by disk name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `disk_name`: The unique Lightsail disk name (my-disk).
- `disk_path`: The disk path to expose to the instance (/dev/xvdf).
- `instance_name`: The name of the Lightsail instance where you want to utilize the storage
disk.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoMounting"`: A Boolean value used to determine the automatic mounting of a storage
volume to a virtual computer. The default value is False. This value only applies to
Lightsail for Research resources.
"""
function attach_disk(
diskName, diskPath, instanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"AttachDisk",
Dict{String,Any}(
"diskName" => diskName, "diskPath" => diskPath, "instanceName" => instanceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_disk(
diskName,
diskPath,
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"AttachDisk",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"diskName" => diskName,
"diskPath" => diskPath,
"instanceName" => instanceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_instances_to_load_balancer(instance_names, load_balancer_name)
attach_instances_to_load_balancer(instance_names, load_balancer_name, params::Dict{String,<:Any})
Attaches one or more Lightsail instances to a load balancer. After some time, the instances
are attached to the load balancer and the health check status is available. The attach
instances to load balancer operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the
Lightsail Developer Guide.
# Arguments
- `instance_names`: An array of strings representing the instance name(s) you want to
attach to your load balancer. An instance must be running before you can attach it to your
load balancer. There are no additional limits on the number of instances you can attach to
your load balancer, aside from the limit of Lightsail instances you can create in your
account (20).
- `load_balancer_name`: The name of the load balancer.
"""
function attach_instances_to_load_balancer(
instanceNames, loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"AttachInstancesToLoadBalancer",
Dict{String,Any}(
"instanceNames" => instanceNames, "loadBalancerName" => loadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_instances_to_load_balancer(
instanceNames,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"AttachInstancesToLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"instanceNames" => instanceNames, "loadBalancerName" => loadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_load_balancer_tls_certificate(certificate_name, load_balancer_name)
attach_load_balancer_tls_certificate(certificate_name, load_balancer_name, params::Dict{String,<:Any})
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an
updated, more secure version of Secure Socket Layer (SSL). Once you create and validate
your certificate, you can attach it to your load balancer. You can also use this API to
rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action
with the non-attached certificate, and it will replace the existing one and become the
attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based
access control via resource tags applied to the resource identified by load balancer name.
For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `certificate_name`: The name of your SSL/TLS certificate.
- `load_balancer_name`: The name of the load balancer to which you want to associate the
SSL/TLS certificate.
"""
function attach_load_balancer_tls_certificate(
certificateName, loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"AttachLoadBalancerTlsCertificate",
Dict{String,Any}(
"certificateName" => certificateName, "loadBalancerName" => loadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_load_balancer_tls_certificate(
certificateName,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"AttachLoadBalancerTlsCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateName" => certificateName,
"loadBalancerName" => loadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_static_ip(instance_name, static_ip_name)
attach_static_ip(instance_name, static_ip_name, params::Dict{String,<:Any})
Attaches a static IP address to a specific Amazon Lightsail instance.
# Arguments
- `instance_name`: The instance name to which you want to attach the static IP address.
- `static_ip_name`: The name of the static IP.
"""
function attach_static_ip(
instanceName, staticIpName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"AttachStaticIp",
Dict{String,Any}("instanceName" => instanceName, "staticIpName" => staticIpName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_static_ip(
instanceName,
staticIpName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"AttachStaticIp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"instanceName" => instanceName, "staticIpName" => staticIpName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
close_instance_public_ports(instance_name, port_info)
close_instance_public_ports(instance_name, port_info, params::Dict{String,<:Any})
Closes ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action
supports tag-based access control via resource tags applied to the resource identified by
instanceName. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The name of the instance for which to close ports.
- `port_info`: An object to describe the ports to close for the specified instance.
"""
function close_instance_public_ports(
instanceName, portInfo; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CloseInstancePublicPorts",
Dict{String,Any}("instanceName" => instanceName, "portInfo" => portInfo);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function close_instance_public_ports(
instanceName,
portInfo,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CloseInstancePublicPorts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("instanceName" => instanceName, "portInfo" => portInfo),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_snapshot(source_region, target_snapshot_name)
copy_snapshot(source_region, target_snapshot_name, params::Dict{String,<:Any})
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an
automatic snapshot of an instance or disk as a manual snapshot. This operation can also be
used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web
Services Region to another in Amazon Lightsail. When copying a manual snapshot, be sure to
define the source region, source snapshot name, and target snapshot name parameters. When
copying an automatic snapshot, be sure to define the source region, source resource name,
target snapshot name, and either the restore date or the use latest restorable auto
snapshot parameters.
# Arguments
- `source_region`: The Amazon Web Services Region where the source manual or automatic
snapshot is located.
- `target_snapshot_name`: The name of the new manual snapshot to be created as a copy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"restoreDate"`: The date of the source automatic snapshot to copy. Use the get auto
snapshots operation to identify the dates of the available automatic snapshots.
Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined
together with the use latest restorable auto snapshot parameter. The restore date and use
latest restorable auto snapshot parameters are mutually exclusive. Define this parameter
only when copying an automatic snapshot as a manual snapshot. For more information, see the
Amazon Lightsail Developer Guide.
- `"sourceResourceName"`: The name of the source instance or disk from which the source
automatic snapshot was created. Constraint: Define this parameter only when copying an
automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail
Developer Guide.
- `"sourceSnapshotName"`: The name of the source manual snapshot to copy. Constraint:
Define this parameter only when copying a manual snapshot as another manual snapshot.
- `"useLatestRestorableAutoSnapshot"`: A Boolean value to indicate whether to use the
latest available automatic snapshot of the specified source instance or disk. Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest
restorable auto snapshot and restore date parameters are mutually exclusive. Define this
parameter only when copying an automatic snapshot as a manual snapshot. For more
information, see the Amazon Lightsail Developer Guide.
"""
function copy_snapshot(
sourceRegion, targetSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CopySnapshot",
Dict{String,Any}(
"sourceRegion" => sourceRegion, "targetSnapshotName" => targetSnapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_snapshot(
sourceRegion,
targetSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CopySnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"sourceRegion" => sourceRegion,
"targetSnapshotName" => targetSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bucket(bucket_name, bundle_id)
create_bucket(bucket_name, bundle_id, params::Dict{String,<:Any})
Creates an Amazon Lightsail bucket. A bucket is a cloud storage resource available in the
Lightsail object storage service. Use buckets to store objects such as data and its
descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail
in the Amazon Lightsail Developer Guide.
# Arguments
- `bucket_name`: The name for the bucket. For more information about bucket names, see
Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.
- `bundle_id`: The ID of the bundle to use for the bucket. A bucket bundle specifies the
monthly cost, storage space, and data transfer quota for a bucket. Use the GetBucketBundles
action to get a list of bundle IDs that you can specify. Use the UpdateBucketBundle action
to change the bundle after the bucket is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enableObjectVersioning"`: A Boolean value that indicates whether to enable versioning
of objects in the bucket. For more information about versioning, see Enabling and
suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail
Developer Guide.
- `"tags"`: The tag keys and optional values to add to the bucket during creation. Use the
TagResource action to tag the bucket after it's created.
"""
function create_bucket(
bucketName, bundleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateBucket",
Dict{String,Any}("bucketName" => bucketName, "bundleId" => bundleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bucket(
bucketName,
bundleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateBucket",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("bucketName" => bucketName, "bundleId" => bundleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bucket_access_key(bucket_name)
create_bucket_access_key(bucket_name, params::Dict{String,<:Any})
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of
an access key ID and corresponding secret access key. Access keys grant full programmatic
access to the specified bucket and its objects. You can have a maximum of two access keys
per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a
specific bucket. For more information about access keys, see Creating access keys for a
bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. The secretAccessKey
value is returned only in response to the CreateBucketAccessKey action. You can get a
secret access key only when you first create an access key; you cannot get the secret
access key later. If you lose the secret access key, you must create a new access key.
# Arguments
- `bucket_name`: The name of the bucket that the new access key will belong to, and grant
access to.
"""
function create_bucket_access_key(
bucketName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateBucketAccessKey",
Dict{String,Any}("bucketName" => bucketName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bucket_access_key(
bucketName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateBucketAccessKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("bucketName" => bucketName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_certificate(certificate_name, domain_name)
create_certificate(certificate_name, domain_name, params::Dict{String,<:Any})
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)
distribution and a container service. After the certificate is valid, use the
AttachCertificateToDistribution action to use the certificate and its domains with your
distribution. Or use the UpdateContainerService action to use the certificate and its
domains with your container service. Only certificates created in the us-east-1 Amazon Web
Services Region can be attached to Lightsail distributions. Lightsail distributions are
global resources that can reference an origin in any Amazon Web Services Region, and
distribute its content globally. However, all distributions are located in the us-east-1
Region.
# Arguments
- `certificate_name`: The name for the certificate.
- `domain_name`: The domain name (example.com) for the certificate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"subjectAlternativeNames"`: An array of strings that specify the alternate domains
(example2.com) and subdomains (blog.example.com) for the certificate. You can specify a
maximum of nine alternate domains (in addition to the primary domain name). Wildcard domain
entries (*.example.com) are not supported.
- `"tags"`: The tag keys and optional values to add to the certificate during create. Use
the TagResource action to tag a resource after it's created.
"""
function create_certificate(
certificateName, domainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateCertificate",
Dict{String,Any}("certificateName" => certificateName, "domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_certificate(
certificateName,
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateName" => certificateName, "domainName" => domainName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cloud_formation_stack(instances)
create_cloud_formation_stack(instances, params::Dict{String,<:Any})
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an
exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record
that can be used to track the AWS CloudFormation stack created. Use the get cloud formation
stack records operation to get a list of the CloudFormation stacks created. Wait until
after your new Amazon EC2 instance is created before running the create cloud formation
stack operation again with the same export snapshot record.
# Arguments
- `instances`: An array of parameters that will be used to create the new Amazon EC2
instance. You can only pass one instance entry at a time in this array. You will get an
invalid parameter error if you pass more than one instance entry in this array.
"""
function create_cloud_formation_stack(
instances; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateCloudFormationStack",
Dict{String,Any}("instances" => instances);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cloud_formation_stack(
instances,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateCloudFormationStack",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instances" => instances), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact_method(contact_endpoint, protocol)
create_contact_method(contact_endpoint, protocol, params::Dict{String,<:Any})
Creates an email or SMS text message contact method. A contact method is used to send you
notifications about your Amazon Lightsail resources. You can add one email address and one
mobile phone number contact method in each Amazon Web Services Region. However, SMS text
messaging is not supported in some Amazon Web Services Regions, and SMS text messages
cannot be sent to some countries/regions. For more information, see Notifications in Amazon
Lightsail.
# Arguments
- `contact_endpoint`: The destination of the contact method, such as an email address or a
mobile phone number. Use the E.164 format when specifying a mobile phone number. E.164 is a
standard for the phone number structure used for international telecommunication. Phone
numbers that follow this format can have a maximum of 15 digits, and they are prefixed with
the plus character (+) and the country code. For example, a U.S. phone number in E.164
format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.
- `protocol`: The protocol of the contact method, such as Email or SMS (text messaging).
The SMS protocol is supported only in the following Amazon Web Services Regions. US East
(N. Virginia) (us-east-1) US West (Oregon) (us-west-2) Europe (Ireland) (eu-west-1)
Asia Pacific (Tokyo) (ap-northeast-1) Asia Pacific (Singapore) (ap-southeast-1) Asia
Pacific (Sydney) (ap-southeast-2) For a list of countries/regions where SMS text messages
can be sent, and the latest Amazon Web Services Regions where SMS text messaging is
supported, see Supported Regions and Countries in the Amazon SNS Developer Guide. For more
information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
"""
function create_contact_method(
contactEndpoint, protocol; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateContactMethod",
Dict{String,Any}("contactEndpoint" => contactEndpoint, "protocol" => protocol);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact_method(
contactEndpoint,
protocol,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateContactMethod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"contactEndpoint" => contactEndpoint, "protocol" => protocol
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_container_service(power, scale, service_name)
create_container_service(power, scale, service_name, params::Dict{String,<:Any})
Creates an Amazon Lightsail container service. A Lightsail container service is a compute
resource to which you can deploy containers. For more information, see Container services
in Amazon Lightsail in the Lightsail Dev Guide.
# Arguments
- `power`: The power specification for the container service. The power specifies the
amount of memory, vCPUs, and base monthly cost of each node of the container service. The
power and scale of a container service makes up its configured capacity. To determine the
monthly price of your container service, multiply the base price of the power with the
scale (the number of nodes) of the service. Use the GetContainerServicePowers action to get
a list of power options that you can specify using this parameter, and their base monthly
cost.
- `scale`: The scale specification for the container service. The scale specifies the
allocated compute nodes of the container service. The power and scale of a container
service makes up its configured capacity. To determine the monthly price of your container
service, multiply the base price of the power with the scale (the number of nodes) of the
service.
- `service_name`: The name for the container service. The name that you specify for your
container service will make up part of its default domain. The default domain of a
container service is typically
https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If
the name of your container service is container-service-1, and it's located in the US East
(Ohio) Amazon Web Services Region (us-east-2), then the domain for your container service
will be like the following example:
https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com The following
are the requirements for container service names: Must be unique within each Amazon Web
Services Region in your Lightsail account. Must contain 1 to 63 characters. Must
contain only alphanumeric characters and hyphens. A hyphen (-) can separate words but
cannot be at the start or end of the name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deployment"`: An object that describes a deployment for the container service. A
deployment specifies the containers that will be launched on the container service and
their settings, such as the ports to open, the environment variables to apply, and the
launch command to run. It also specifies the container that will serve as the public
endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the
health check configuration.
- `"privateRegistryAccess"`: An object to describe the configuration for the container
service to access private container image repositories, such as Amazon Elastic Container
Registry (Amazon ECR) private repositories. For more information, see Configuring access to
an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon
Lightsail Developer Guide.
- `"publicDomainNames"`: The public domain names to use with the container service, such as
example.com and www.example.com. You can specify up to four public domain names for a
container service. The domain names that you specify are used when you create a deployment
with a container configured as the public endpoint of your container service. If you don't
specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names
with your container service. Use the CreateCertificate action to create a certificate for
the public domain names you want to use with your container service. You can specify
public domain names using a string to array map as shown in the example later on this page.
- `"tags"`: The tag keys and optional values to add to the container service during create.
Use the TagResource action to tag a resource after it's created. For more information about
tags in Lightsail, see the Amazon Lightsail Developer Guide.
"""
function create_container_service(
power, scale, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateContainerService",
Dict{String,Any}("power" => power, "scale" => scale, "serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_container_service(
power,
scale,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateContainerService",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"power" => power, "scale" => scale, "serviceName" => serviceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_container_service_deployment(service_name)
create_container_service_deployment(service_name, params::Dict{String,<:Any})
Creates a deployment for your Amazon Lightsail container service. A deployment specifies
the containers that will be launched on the container service and their settings, such as
the ports to open, the environment variables to apply, and the launch command to run. It
also specifies the container that will serve as the public endpoint of the deployment and
its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public
registry such as Amazon ECR Public, or from your local machine. For more information, see
Creating container images for your Amazon Lightsail container services in the Amazon
Lightsail Developer Guide.
# Arguments
- `service_name`: The name of the container service for which to create the deployment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"containers"`: An object that describes the settings of the containers that will be
launched on the container service.
- `"publicEndpoint"`: An object that describes the settings of the public endpoint for the
container service.
"""
function create_container_service_deployment(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateContainerServiceDeployment",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_container_service_deployment(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateContainerServiceDeployment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_container_service_registry_login()
create_container_service_registry_login(params::Dict{String,<:Any})
Creates a temporary set of log in credentials that you can use to log in to the Docker
process on your local machine. After you're logged in, you can use the native Docker
commands to push your local container images to the container image registry of your Amazon
Lightsail account so that you can use them with your Lightsail container service. The log
in credentials expire 12 hours after they are created, at which point you will need to
create a new set of log in credentials. You can only push container images to the
container service registry of your Lightsail account. You cannot pull container images or
perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail
account, use the RegisterContainerImage action to register the pushed images to a specific
Lightsail container service. This action is not required if you install and use the
Lightsail Control (lightsailctl) plugin to push container images to your Lightsail
container service. For more information, see Pushing and managing container images on your
Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
"""
function create_container_service_registry_login(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateContainerServiceRegistryLogin";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_container_service_registry_login(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateContainerServiceRegistryLogin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_disk(availability_zone, disk_name, size_in_gb)
create_disk(availability_zone, disk_name, size_in_gb, params::Dict{String,<:Any})
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the
same Availability Zone (us-east-2a). The create disk operation supports tag-based access
control via request tags. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `availability_zone`: The Availability Zone where you want to create the disk
(us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to
attach the disk. Use the get regions operation to list the Availability Zones where
Lightsail is currently available.
- `disk_name`: The unique Lightsail disk name (my-disk).
- `size_in_gb`: The size of the disk in GB (32).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addOns"`: An array of objects that represent the add-ons to enable for the new disk.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_disk(
availabilityZone, diskName, sizeInGb; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateDisk",
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"diskName" => diskName,
"sizeInGb" => sizeInGb,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_disk(
availabilityZone,
diskName,
sizeInGb,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDisk",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"diskName" => diskName,
"sizeInGb" => sizeInGb,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_disk_from_snapshot(availability_zone, disk_name, size_in_gb)
create_disk_from_snapshot(availability_zone, disk_name, size_in_gb, params::Dict{String,<:Any})
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting
disk can be attached to an Amazon Lightsail instance in the same Availability Zone
(us-east-2a). The create disk from snapshot operation supports tag-based access control via
request tags and resource tags applied to the resource identified by disk snapshot name.
For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `availability_zone`: The Availability Zone where you want to create the disk
(us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to
create the disk. Use the GetRegions operation to list the Availability Zones where
Lightsail is currently available.
- `disk_name`: The unique Lightsail disk name (my-disk).
- `size_in_gb`: The size of the disk in GB (32).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addOns"`: An array of objects that represent the add-ons to enable for the new disk.
- `"diskSnapshotName"`: The name of the disk snapshot (my-snapshot) from which to create
the new storage disk. Constraint: This parameter cannot be defined together with the
source disk name parameter. The disk snapshot name and source disk name parameters are
mutually exclusive.
- `"restoreDate"`: The date of the automatic snapshot to use for the new disk. Use the get
auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined
together with the use latest restorable auto snapshot parameter. The restore date and use
latest restorable auto snapshot parameters are mutually exclusive. Define this parameter
only when creating a new disk from an automatic snapshot. For more information, see the
Amazon Lightsail Developer Guide.
- `"sourceDiskName"`: The name of the source disk from which the source automatic snapshot
was created. Constraints: This parameter cannot be defined together with the disk
snapshot name parameter. The source disk name and disk snapshot name parameters are
mutually exclusive. Define this parameter only when creating a new disk from an automatic
snapshot. For more information, see the Amazon Lightsail Developer Guide.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
- `"useLatestRestorableAutoSnapshot"`: A Boolean value to indicate whether to use the
latest available automatic snapshot. Constraints: This parameter cannot be defined
together with the restore date parameter. The use latest restorable auto snapshot and
restore date parameters are mutually exclusive. Define this parameter only when creating
a new disk from an automatic snapshot. For more information, see the Amazon Lightsail
Developer Guide.
"""
function create_disk_from_snapshot(
availabilityZone, diskName, sizeInGb; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateDiskFromSnapshot",
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"diskName" => diskName,
"sizeInGb" => sizeInGb,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_disk_from_snapshot(
availabilityZone,
diskName,
sizeInGb,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDiskFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"diskName" => diskName,
"sizeInGb" => sizeInGb,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_disk_snapshot(disk_snapshot_name)
create_disk_snapshot(disk_snapshot_name, params::Dict{String,<:Any})
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make
copies of disks, and to save data before shutting down a Lightsail instance. You can take a
snapshot of an attached disk that is in use; however, snapshots only capture data that has
been written to your disk at the time the snapshot command is issued. This may exclude any
data that has been cached by any applications or the operating system. If you can pause any
file systems on the disk long enough to take a snapshot, your snapshot should be complete.
Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk
from within the Lightsail instance, issue the create disk snapshot command, and then
remount the disk to ensure a consistent and complete snapshot. You may remount and use your
disk while the snapshot status is pending. You can also use this operation to create a
snapshot of an instance's system volume. You might want to do this, for example, to recover
data from the system volume of a botched instance or to create a backup of the system
volume like you would for a block storage disk. To create a snapshot of a system volume,
just define the instance name parameter when issuing the snapshot command, and a snapshot
of the defined instance's system volume will be created. After the snapshot is available,
you can create a block storage disk from the snapshot and attach it to a running instance
to access the data on the disk. The create disk snapshot operation supports tag-based
access control via request tags. For more information, see the Amazon Lightsail Developer
Guide.
# Arguments
- `disk_snapshot_name`: The name of the destination disk snapshot (my-disk-snapshot) based
on the source disk.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"diskName"`: The unique name of the source disk (Disk-Virginia-1). This parameter
cannot be defined together with the instance name parameter. The disk name and instance
name parameters are mutually exclusive.
- `"instanceName"`: The unique name of the source instance (Amazon_Linux-512MB-Virginia-1).
When this is defined, a snapshot of the instance's system volume is created. This
parameter cannot be defined together with the disk name parameter. The instance name and
disk name parameters are mutually exclusive.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_disk_snapshot(
diskSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateDiskSnapshot",
Dict{String,Any}("diskSnapshotName" => diskSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_disk_snapshot(
diskSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDiskSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("diskSnapshotName" => diskSnapshotName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_distribution(bundle_id, default_cache_behavior, distribution_name, origin)
create_distribution(bundle_id, default_cache_behavior, distribution_name, origin, params::Dict{String,<:Any})
Creates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is
a globally distributed network of caching servers that improve the performance of your
website or web application hosted on a Lightsail instance. For more information, see
Content delivery networks in Amazon Lightsail.
# Arguments
- `bundle_id`: The bundle ID to use for the distribution. A distribution bundle describes
the specifications of your distribution, such as the monthly cost and monthly network
transfer quota. Use the GetDistributionBundles action to get a list of distribution bundle
IDs that you can specify.
- `default_cache_behavior`: An object that describes the default cache behavior for the
distribution.
- `distribution_name`: The name for the distribution.
- `origin`: An object that describes the origin resource for the distribution, such as a
Lightsail instance, bucket, or load balancer. The distribution pulls, caches, and serves
content from the origin.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cacheBehaviorSettings"`: An object that describes the cache behavior settings for the
distribution.
- `"cacheBehaviors"`: An array of objects that describe the per-path cache behavior for the
distribution.
- `"certificateName"`: The name of the SSL/TLS certificate that you want to attach to the
distribution. Use the GetCertificates action to get a list of certificate names that you
can specify.
- `"ipAddressType"`: The IP address type for the distribution. The possible values are ipv4
for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
- `"tags"`: The tag keys and optional values to add to the distribution during create. Use
the TagResource action to tag a resource after it's created.
- `"viewerMinimumTlsProtocolVersion"`: The minimum TLS protocol version for the SSL/TLS
certificate.
"""
function create_distribution(
bundleId,
defaultCacheBehavior,
distributionName,
origin;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDistribution",
Dict{String,Any}(
"bundleId" => bundleId,
"defaultCacheBehavior" => defaultCacheBehavior,
"distributionName" => distributionName,
"origin" => origin,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_distribution(
bundleId,
defaultCacheBehavior,
distributionName,
origin,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDistribution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bundleId" => bundleId,
"defaultCacheBehavior" => defaultCacheBehavior,
"distributionName" => distributionName,
"origin" => origin,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(domain_name)
create_domain(domain_name, params::Dict{String,<:Any})
Creates a domain resource for the specified domain (example.com). The create domain
operation supports tag-based access control via request tags. For more information, see the
Amazon Lightsail Developer Guide.
# Arguments
- `domain_name`: The domain name to manage (example.com).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_domain(domainName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"CreateDomain",
Dict{String,Any}("domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("domainName" => domainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain_entry(domain_entry, domain_name)
create_domain_entry(domain_entry, domain_name, params::Dict{String,<:Any})
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address
(A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority
(SOA), service locator (SRV), or text (TXT). The create domain entry operation supports
tag-based access control via resource tags applied to the resource identified by domain
name. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `domain_entry`: An array of key-value pairs containing information about the domain entry
request.
- `domain_name`: The domain name (example.com) for which you want to create the domain
entry.
"""
function create_domain_entry(
domainEntry, domainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateDomainEntry",
Dict{String,Any}("domainEntry" => domainEntry, "domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain_entry(
domainEntry,
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateDomainEntry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domainEntry" => domainEntry, "domainName" => domainName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_guisession_access_details(resource_name)
create_guisession_access_details(resource_name, params::Dict{String,<:Any})
Creates two URLs that are used to access a virtual computer’s graphical user interface
(GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual
computer's application. The secondary URL initiates a web-based NICE DCV session to the
virtual computer's operating session. Use StartGUISession to open the session.
# Arguments
- `resource_name`: The resource name.
"""
function create_guisession_access_details(
resourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateGUISessionAccessDetails",
Dict{String,Any}("resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_guisession_access_details(
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateGUISessionAccessDetails",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceName" => resourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_snapshot(instance_name, instance_snapshot_name)
create_instance_snapshot(instance_name, instance_snapshot_name, params::Dict{String,<:Any})
Creates a snapshot of a specific virtual private server, or instance. You can use a
snapshot to create a new instance that is based on that snapshot. The create instance
snapshot operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The Lightsail instance on which to base your snapshot.
- `instance_snapshot_name`: The name for your new snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_instance_snapshot(
instanceName, instanceSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateInstanceSnapshot",
Dict{String,Any}(
"instanceName" => instanceName, "instanceSnapshotName" => instanceSnapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance_snapshot(
instanceName,
instanceSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateInstanceSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"instanceName" => instanceName,
"instanceSnapshotName" => instanceSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instances(availability_zone, blueprint_id, bundle_id, instance_names)
create_instances(availability_zone, blueprint_id, bundle_id, instance_names, params::Dict{String,<:Any})
Creates one or more Amazon Lightsail instances. The create instances operation supports
tag-based access control via request tags. For more information, see the Lightsail
Developer Guide.
# Arguments
- `availability_zone`: The Availability Zone in which to create your instance. Use the
following format: us-east-2a (case sensitive). You can get a list of Availability Zones by
using the get regions operation. Be sure to add the include Availability Zones parameter to
your request.
- `blueprint_id`: The ID for a virtual private server image (app_wordpress_x_x or
app_lamp_x_x). Use the get blueprints operation to return a list of available images (or
blueprints). Use active blueprints when creating new instances. Inactive blueprints are
listed to support customers with existing instances and are not necessarily available to
create new instances. Blueprints are marked inactive when they become outdated due to
operating system updates or new application releases.
- `bundle_id`: The bundle of specification information for your virtual private server (or
instance), including the pricing plan (medium_x_x).
- `instance_names`: The names to use for your new Lightsail instances. Separate multiple
values using quotation marks and commas, for example:
[\"MyFirstInstance\",\"MySecondInstance\"]
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addOns"`: An array of objects representing the add-ons to enable for the new instance.
- `"customImageName"`: (Discontinued) The name for your custom image. In releases prior to
June 12, 2017, this parameter was ignored by the API. It is now discontinued.
- `"ipAddressType"`: The IP address type for the instance. The possible values are ipv4 for
IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. The default value is
dualstack.
- `"keyPairName"`: The name of your key pair.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
- `"userData"`: A launch script you can create that configures a server with additional
user data. For example, you might want to run apt-get -y update. Depending on the machine
image you choose, the command to get software on your instance varies. Amazon Linux and
CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list,
see the Amazon Lightsail Developer Guide.
"""
function create_instances(
availabilityZone,
blueprintId,
bundleId,
instanceNames;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateInstances",
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"blueprintId" => blueprintId,
"bundleId" => bundleId,
"instanceNames" => instanceNames,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instances(
availabilityZone,
blueprintId,
bundleId,
instanceNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"blueprintId" => blueprintId,
"bundleId" => bundleId,
"instanceNames" => instanceNames,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instances_from_snapshot(availability_zone, bundle_id, instance_names)
create_instances_from_snapshot(availability_zone, bundle_id, instance_names, params::Dict{String,<:Any})
Creates one or more new instances from a manual or automatic snapshot of an instance. The
create instances from snapshot operation supports tag-based access control via request tags
and resource tags applied to the resource identified by instance snapshot name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `availability_zone`: The Availability Zone where you want to create your instances. Use
the following formatting: us-east-2a (case sensitive). You can get a list of Availability
Zones by using the get regions operation. Be sure to add the include Availability Zones
parameter to your request.
- `bundle_id`: The bundle of specification information for your virtual private server (or
instance), including the pricing plan (micro_x_x).
- `instance_names`: The names for your new instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addOns"`: An array of objects representing the add-ons to enable for the new instance.
- `"attachedDiskMapping"`: An object containing information about one or more disk mappings.
- `"instanceSnapshotName"`: The name of the instance snapshot on which you are basing your
new instances. Use the get instance snapshots operation to return information about your
existing snapshots. Constraint: This parameter cannot be defined together with the source
instance name parameter. The instance snapshot name and source instance name parameters are
mutually exclusive.
- `"ipAddressType"`: The IP address type for the instance. The possible values are ipv4 for
IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. The default value is
dualstack.
- `"keyPairName"`: The name for your key pair.
- `"restoreDate"`: The date of the automatic snapshot to use for the new instance. Use the
get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined
together with the use latest restorable auto snapshot parameter. The restore date and use
latest restorable auto snapshot parameters are mutually exclusive. Define this parameter
only when creating a new instance from an automatic snapshot. For more information, see the
Amazon Lightsail Developer Guide.
- `"sourceInstanceName"`: The name of the source instance from which the source automatic
snapshot was created. Constraints: This parameter cannot be defined together with the
instance snapshot name parameter. The source instance name and instance snapshot name
parameters are mutually exclusive. Define this parameter only when creating a new
instance from an automatic snapshot. For more information, see the Amazon Lightsail
Developer Guide.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
- `"useLatestRestorableAutoSnapshot"`: A Boolean value to indicate whether to use the
latest available automatic snapshot. Constraints: This parameter cannot be defined
together with the restore date parameter. The use latest restorable auto snapshot and
restore date parameters are mutually exclusive. Define this parameter only when creating
a new instance from an automatic snapshot. For more information, see the Amazon Lightsail
Developer Guide.
- `"userData"`: You can create a launch script that configures a server with additional
user data. For example, apt-get -y update. Depending on the machine image you choose, the
command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian
and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail
Developer Guide.
"""
function create_instances_from_snapshot(
availabilityZone,
bundleId,
instanceNames;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateInstancesFromSnapshot",
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"bundleId" => bundleId,
"instanceNames" => instanceNames,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instances_from_snapshot(
availabilityZone,
bundleId,
instanceNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateInstancesFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"bundleId" => bundleId,
"instanceNames" => instanceNames,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_key_pair(key_pair_name)
create_key_pair(key_pair_name, params::Dict{String,<:Any})
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance. Use the
DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web
Services Region where a default key pair does not currently exist. The create key pair
operation supports tag-based access control via request tags. For more information, see the
Amazon Lightsail Developer Guide.
# Arguments
- `key_pair_name`: The name for your new key pair.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_key_pair(keyPairName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"CreateKeyPair",
Dict{String,Any}("keyPairName" => keyPairName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_key_pair(
keyPairName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateKeyPair",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyPairName" => keyPairName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_load_balancer(instance_port, load_balancer_name)
create_load_balancer(instance_port, load_balancer_name, params::Dict{String,<:Any})
Creates a Lightsail load balancer. To learn more about deciding whether to load balance
your application, see Configure your Lightsail instances for load balancing. You can create
up to 5 load balancers per AWS Region in your account. When you create a load balancer, you
can specify a unique name and port settings. To change additional load balancer settings,
use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports
tag-based access control via request tags. For more information, see the Amazon Lightsail
Developer Guide.
# Arguments
- `instance_port`: The instance port where you're creating your load balancer.
- `load_balancer_name`: The name of your load balancer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"certificateAlternativeNames"`: The optional alternative domains and subdomains to use
with your SSL/TLS certificate (www.example.com, example.com, m.example.com,
blog.example.com).
- `"certificateDomainName"`: The domain name with which your certificate is associated
(example.com). If you specify certificateDomainName, then certificateName is required (and
vice-versa).
- `"certificateName"`: The name of the SSL/TLS certificate. If you specify certificateName,
then certificateDomainName is required (and vice-versa).
- `"healthCheckPath"`: The path you provided to perform the load balancer health check. If
you didn't specify a health check path, Lightsail uses the root path of your website
(\"/\"). You may want to specify a custom health check path other than the root of your
application if your home page loads slowly or has a lot of media or scripting on it.
- `"ipAddressType"`: The IP address type for the load balancer. The possible values are
ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. The default value
is dualstack.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
- `"tlsPolicyName"`: The name of the TLS policy to apply to the load balancer. Use the
GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security
policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
"""
function create_load_balancer(
instancePort, loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateLoadBalancer",
Dict{String,Any}(
"instancePort" => instancePort, "loadBalancerName" => loadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_load_balancer(
instancePort,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"instancePort" => instancePort, "loadBalancerName" => loadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_load_balancer_tls_certificate(certificate_domain_name, certificate_name, load_balancer_name)
create_load_balancer_tls_certificate(certificate_domain_name, certificate_name, load_balancer_name, params::Dict{String,<:Any})
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an
updated, more secure version of Secure Socket Layer (SSL). The
CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see
the Amazon Lightsail Developer Guide.
# Arguments
- `certificate_domain_name`: The domain name (example.com) for your SSL/TLS certificate.
- `certificate_name`: The SSL/TLS certificate name. You can have up to 10 certificates in
your account at one time. Each Lightsail load balancer can have up to 2 certificates
associated with it at one time. There is also an overall limit to the number of
certificates that can be issue in a 365-day period. For more information, see Limits.
- `load_balancer_name`: The load balancer name where you want to create the SSL/TLS
certificate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"certificateAlternativeNames"`: An array of strings listing alternative domains and
subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can
have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not
support wildcards (*.example.com).
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_load_balancer_tls_certificate(
certificateDomainName,
certificateName,
loadBalancerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateLoadBalancerTlsCertificate",
Dict{String,Any}(
"certificateDomainName" => certificateDomainName,
"certificateName" => certificateName,
"loadBalancerName" => loadBalancerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_load_balancer_tls_certificate(
certificateDomainName,
certificateName,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateLoadBalancerTlsCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateDomainName" => certificateDomainName,
"certificateName" => certificateName,
"loadBalancerName" => loadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_relational_database(master_database_name, master_username, relational_database_blueprint_id, relational_database_bundle_id, relational_database_name)
create_relational_database(master_database_name, master_username, relational_database_blueprint_id, relational_database_bundle_id, relational_database_name, params::Dict{String,<:Any})
Creates a new database in Amazon Lightsail. The create relational database operation
supports tag-based access control via request tags. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `master_database_name`: The meaning of this parameter differs according to the database
engine you use. MySQL The name of the database to create when the Lightsail database
resource is created. If this parameter isn't specified, no database is created in the
database resource. Constraints: Must contain 1 to 64 letters or numbers. Must begin
with a letter. Subsequent characters can be letters, underscores, or digits (0- 9). Can't
be a word reserved by the specified database engine. For more information about reserved
words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and
MySQL 8.0. PostgreSQL The name of the database to create when the Lightsail database
resource is created. If this parameter isn't specified, a database named postgres is
created in the database resource. Constraints: Must contain 1 to 63 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-
9). Can't be a word reserved by the specified database engine. For more information about
reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL
10, PostgreSQL 11, and PostgreSQL 12.
- `master_username`: The name for the master user. MySQL Constraints: Required for
MySQL. Must be 1 to 16 letters or numbers. Can contain underscores. First character
must be a letter. Can't be a reserved word for the chosen database engine. For more
information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words
articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0. PostgreSQL Constraints: Required for
PostgreSQL. Must be 1 to 63 letters or numbers. Can contain underscores. First
character must be a letter. Can't be a reserved word for the chosen database engine. For
more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved
Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
- `relational_database_blueprint_id`: The blueprint ID for your new database. A blueprint
describes the major engine version of a database. You can get a list of database blueprints
IDs by using the get relational database blueprints operation.
- `relational_database_bundle_id`: The bundle ID for your new database. A bundle describes
the performance specifications for your database. You can get a list of database bundle IDs
by using the get relational database bundles operation.
- `relational_database_name`: The name to use for your new Lightsail database resource.
Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first
and last character must be a letter or number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"availabilityZone"`: The Availability Zone in which to create your new database. Use the
us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get
regions operation. Be sure to add the include relational database Availability Zones
parameter to your request.
- `"masterUserPassword"`: The password for the master user. The password can include any
printable ASCII character except \"/\", \"\"\", or \"@\". It cannot contain spaces. MySQL
Constraints: Must contain from 8 to 41 characters. PostgreSQL Constraints: Must contain
from 8 to 128 characters.
- `"preferredBackupWindow"`: The daily time range during which automated backups are
created for your new database if automated backups are enabled. The default is a 30-minute
window selected at random from an 8-hour block of time for each AWS Region. For more
information about the preferred backup window time blocks for each region, see the Working
With Backups guide in the Amazon Relational Database Service documentation. Constraints:
Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Coordinated
Universal Time (UTC). Must not conflict with the preferred maintenance window. Must be
at least 30 minutes.
- `"preferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur on your new database. The default is a 30-minute window selected at random from an
8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed,
Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Coordinated Universal
Time (UTC). Example: Tue:17:00-Tue:17:30
- `"publiclyAccessible"`: Specifies the accessibility options for your new database. A
value of true specifies a database that is available to resources outside of your Lightsail
account. A value of false specifies a database that is available only to your Lightsail
resources in the same region as your database.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_relational_database(
masterDatabaseName,
masterUsername,
relationalDatabaseBlueprintId,
relationalDatabaseBundleId,
relationalDatabaseName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateRelationalDatabase",
Dict{String,Any}(
"masterDatabaseName" => masterDatabaseName,
"masterUsername" => masterUsername,
"relationalDatabaseBlueprintId" => relationalDatabaseBlueprintId,
"relationalDatabaseBundleId" => relationalDatabaseBundleId,
"relationalDatabaseName" => relationalDatabaseName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_relational_database(
masterDatabaseName,
masterUsername,
relationalDatabaseBlueprintId,
relationalDatabaseBundleId,
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"masterDatabaseName" => masterDatabaseName,
"masterUsername" => masterUsername,
"relationalDatabaseBlueprintId" => relationalDatabaseBlueprintId,
"relationalDatabaseBundleId" => relationalDatabaseBundleId,
"relationalDatabaseName" => relationalDatabaseName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_relational_database_from_snapshot(relational_database_name)
create_relational_database_from_snapshot(relational_database_name, params::Dict{String,<:Any})
Creates a new database from an existing database snapshot in Amazon Lightsail. You can
create a new database from a snapshot in if something goes wrong with your original
database, or to change it to a different plan, such as a high availability or standard
plan. The create relational database from snapshot operation supports tag-based access
control via request tags and resource tags applied to the resource identified by
relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer
Guide.
# Arguments
- `relational_database_name`: The name to use for your new Lightsail database resource.
Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first
and last character must be a letter or number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"availabilityZone"`: The Availability Zone in which to create your new database. Use the
us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get
regions operation. Be sure to add the include relational database Availability Zones
parameter to your request.
- `"publiclyAccessible"`: Specifies the accessibility options for your new database. A
value of true specifies a database that is available to resources outside of your Lightsail
account. A value of false specifies a database that is available only to your Lightsail
resources in the same region as your database.
- `"relationalDatabaseBundleId"`: The bundle ID for your new database. A bundle describes
the performance specifications for your database. You can get a list of database bundle IDs
by using the get relational database bundles operation. When creating a new database from a
snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
- `"relationalDatabaseSnapshotName"`: The name of the database snapshot from which to
create your new database.
- `"restoreTime"`: The date and time to restore your database from. Constraints: Must be
before the latest restorable time for the database. Cannot be specified if the use latest
restorable time parameter is true. Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format. For example, if you wish to use a restore time of
October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.
- `"sourceRelationalDatabaseName"`: The name of the source database.
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
- `"useLatestRestorableTime"`: Specifies whether your database is restored from the latest
backup time. A value of true restores from the latest backup time. Default: false
Constraints: Cannot be specified if the restore time parameter is provided.
"""
function create_relational_database_from_snapshot(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"CreateRelationalDatabaseFromSnapshot",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_relational_database_from_snapshot(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateRelationalDatabaseFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_relational_database_snapshot(relational_database_name, relational_database_snapshot_name)
create_relational_database_snapshot(relational_database_name, relational_database_snapshot_name, params::Dict{String,<:Any})
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups,
to make copies of a database, and to save data before deleting a database. The create
relational database snapshot operation supports tag-based access control via request tags.
For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `relational_database_name`: The name of the database on which to base your new snapshot.
- `relational_database_snapshot_name`: The name for your new database snapshot.
Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first
and last character must be a letter or number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tag keys and optional values to add to the resource during create. Use the
TagResource action to tag a resource after it's created.
"""
function create_relational_database_snapshot(
relationalDatabaseName,
relationalDatabaseSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateRelationalDatabaseSnapshot",
Dict{String,Any}(
"relationalDatabaseName" => relationalDatabaseName,
"relationalDatabaseSnapshotName" => relationalDatabaseSnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_relational_database_snapshot(
relationalDatabaseName,
relationalDatabaseSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"CreateRelationalDatabaseSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"relationalDatabaseName" => relationalDatabaseName,
"relationalDatabaseSnapshotName" => relationalDatabaseSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alarm(alarm_name)
delete_alarm(alarm_name, params::Dict{String,<:Any})
Deletes an alarm. An alarm is used to monitor a single metric for one of your resources.
When a metric condition is met, the alarm can notify you by email, SMS text message, and a
banner displayed on the Amazon Lightsail console. For more information, see Alarms in
Amazon Lightsail.
# Arguments
- `alarm_name`: The name of the alarm to delete.
"""
function delete_alarm(alarmName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteAlarm",
Dict{String,Any}("alarmName" => alarmName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alarm(
alarmName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteAlarm",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("alarmName" => alarmName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_auto_snapshot(date, resource_name)
delete_auto_snapshot(date, resource_name, params::Dict{String,<:Any})
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `date`: The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get
auto snapshots operation to get the available automatic snapshots for a resource.
- `resource_name`: The name of the source instance or disk from which to delete the
automatic snapshot.
"""
function delete_auto_snapshot(
date, resourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteAutoSnapshot",
Dict{String,Any}("date" => date, "resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_auto_snapshot(
date,
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteAutoSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("date" => date, "resourceName" => resourceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket(bucket_name)
delete_bucket(bucket_name, params::Dict{String,<:Any})
Deletes a Amazon Lightsail bucket. When you delete your bucket, the bucket name is
released and can be reused for a new bucket in your account or another Amazon Web Services
account.
# Arguments
- `bucket_name`: The name of the bucket to delete. Use the GetBuckets action to get a list
of bucket names that you can specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"forceDelete"`: A Boolean value that indicates whether to force delete the bucket. You
must force delete the bucket if it has one of the following conditions: The bucket is the
origin of a distribution. The bucket has instances that were granted access to it using
the SetResourceAccessForBucket action. The bucket has objects. The bucket has access
keys. Force deleting a bucket might impact other resources that rely on the bucket, such
as instances, distributions, or software that use the issued access keys.
"""
function delete_bucket(bucketName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteBucket",
Dict{String,Any}("bucketName" => bucketName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket(
bucketName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteBucket",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("bucketName" => bucketName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_access_key(access_key_id, bucket_name)
delete_bucket_access_key(access_key_id, bucket_name, params::Dict{String,<:Any})
Deletes an access key for the specified Amazon Lightsail bucket. We recommend that you
delete an access key if the secret access key is compromised. For more information about
access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon
Lightsail Developer Guide.
# Arguments
- `access_key_id`: The ID of the access key to delete. Use the GetBucketAccessKeys action
to get a list of access key IDs that you can specify.
- `bucket_name`: The name of the bucket that the access key belongs to.
"""
function delete_bucket_access_key(
accessKeyId, bucketName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteBucketAccessKey",
Dict{String,Any}("accessKeyId" => accessKeyId, "bucketName" => bucketName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_access_key(
accessKeyId,
bucketName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteBucketAccessKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("accessKeyId" => accessKeyId, "bucketName" => bucketName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_certificate(certificate_name)
delete_certificate(certificate_name, params::Dict{String,<:Any})
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN)
distribution. Certificates that are currently attached to a distribution cannot be deleted.
Use the DetachCertificateFromDistribution action to detach a certificate from a
distribution.
# Arguments
- `certificate_name`: The name of the certificate to delete. Use the GetCertificates action
to get a list of certificate names that you can specify.
"""
function delete_certificate(
certificateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteCertificate",
Dict{String,Any}("certificateName" => certificateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_certificate(
certificateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteCertificate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("certificateName" => certificateName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact_method(protocol)
delete_contact_method(protocol, params::Dict{String,<:Any})
Deletes a contact method. A contact method is used to send you notifications about your
Amazon Lightsail resources. You can add one email address and one mobile phone number
contact method in each Amazon Web Services Region. However, SMS text messaging is not
supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some
countries/regions. For more information, see Notifications in Amazon Lightsail.
# Arguments
- `protocol`: The protocol that will be deleted, such as Email or SMS (text messaging). To
delete an Email and an SMS contact method if you added both, you must run separate
DeleteContactMethod actions to delete each protocol.
"""
function delete_contact_method(protocol; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteContactMethod",
Dict{String,Any}("protocol" => protocol);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact_method(
protocol,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteContactMethod",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("protocol" => protocol), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_container_image(image, service_name)
delete_container_image(image, service_name, params::Dict{String,<:Any})
Deletes a container image that is registered to your Amazon Lightsail container service.
# Arguments
- `image`: The name of the container image to delete from the container service. Use the
GetContainerImages action to get the name of the container images that are registered to a
container service. Container images sourced from your Lightsail container service, that
are registered and stored on your service, start with a colon (:). For example,
:container-service-1.mystaticwebsite.1. Container images sourced from a public registry
like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
- `service_name`: The name of the container service for which to delete a registered
container image.
"""
function delete_container_image(
image, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteContainerImage",
Dict{String,Any}("image" => image, "serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_container_image(
image,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteContainerImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("image" => image, "serviceName" => serviceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_container_service(service_name)
delete_container_service(service_name, params::Dict{String,<:Any})
Deletes your Amazon Lightsail container service.
# Arguments
- `service_name`: The name of the container service to delete.
"""
function delete_container_service(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteContainerService",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_container_service(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteContainerService",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_disk(disk_name)
delete_disk(disk_name, params::Dict{String,<:Any})
Deletes the specified block storage disk. The disk must be in the available state (not
attached to a Lightsail instance). The disk may remain in the deleting state for several
minutes. The delete disk operation supports tag-based access control via resource tags
applied to the resource identified by disk name. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `disk_name`: The unique name of the disk you want to delete (my-disk).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"forceDeleteAddOns"`: A Boolean value to indicate whether to delete all add-ons for the
disk.
"""
function delete_disk(diskName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteDisk",
Dict{String,Any}("diskName" => diskName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_disk(
diskName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteDisk",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("diskName" => diskName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_disk_snapshot(disk_snapshot_name)
delete_disk_snapshot(disk_snapshot_name, params::Dict{String,<:Any})
Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the
snapshots are incremental, and only the blocks on the device that have changed since your
last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not
needed for any other snapshot is removed. So regardless of which prior snapshots have been
deleted, all active snapshots will have access to all the information needed to restore the
disk. The delete disk snapshot operation supports tag-based access control via resource
tags applied to the resource identified by disk snapshot name. For more information, see
the Amazon Lightsail Developer Guide.
# Arguments
- `disk_snapshot_name`: The name of the disk snapshot you want to delete (my-disk-snapshot).
"""
function delete_disk_snapshot(
diskSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteDiskSnapshot",
Dict{String,Any}("diskSnapshotName" => diskSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_disk_snapshot(
diskSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteDiskSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("diskSnapshotName" => diskSnapshotName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_distribution()
delete_distribution(params::Dict{String,<:Any})
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"distributionName"`: The name of the distribution to delete. Use the GetDistributions
action to get a list of distribution names that you can specify.
"""
function delete_distribution(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteDistribution"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_distribution(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteDistribution", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})
Deletes the specified domain recordset and all of its domain records. The delete domain
operation supports tag-based access control via resource tags applied to the resource
identified by domain name. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `domain_name`: The specific domain name to delete.
"""
function delete_domain(domainName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteDomain",
Dict{String,Any}("domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("domainName" => domainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain_entry(domain_entry, domain_name)
delete_domain_entry(domain_entry, domain_name, params::Dict{String,<:Any})
Deletes a specific domain entry. The delete domain entry operation supports tag-based
access control via resource tags applied to the resource identified by domain name. For
more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `domain_entry`: An array of key-value pairs containing information about your domain
entries.
- `domain_name`: The name of the domain entry to delete.
"""
function delete_domain_entry(
domainEntry, domainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteDomainEntry",
Dict{String,Any}("domainEntry" => domainEntry, "domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain_entry(
domainEntry,
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteDomainEntry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domainEntry" => domainEntry, "domainName" => domainName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance(instance_name)
delete_instance(instance_name, params::Dict{String,<:Any})
Deletes an Amazon Lightsail instance. The delete instance operation supports tag-based
access control via resource tags applied to the resource identified by instance name. For
more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The name of the instance to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"forceDeleteAddOns"`: A Boolean value to indicate whether to delete all add-ons for the
instance.
"""
function delete_instance(instanceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteInstance",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_snapshot(instance_snapshot_name)
delete_instance_snapshot(instance_snapshot_name, params::Dict{String,<:Any})
Deletes a specific snapshot of a virtual private server (or instance). The delete instance
snapshot operation supports tag-based access control via resource tags applied to the
resource identified by instance snapshot name. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `instance_snapshot_name`: The name of the snapshot to delete.
"""
function delete_instance_snapshot(
instanceSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteInstanceSnapshot",
Dict{String,Any}("instanceSnapshotName" => instanceSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_snapshot(
instanceSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteInstanceSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("instanceSnapshotName" => instanceSnapshotName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_key_pair(key_pair_name)
delete_key_pair(key_pair_name, params::Dict{String,<:Any})
Deletes the specified key pair by removing the public key from Amazon Lightsail. You can
delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as
well as the Lightsail default key pair. A new default key pair will not be created unless
you launch an instance without specifying a custom key pair, or you call the
DownloadDefaultKeyPair API. The delete key pair operation supports tag-based access
control via resource tags applied to the resource identified by key pair name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `key_pair_name`: The name of the key pair to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedFingerprint"`: The RSA fingerprint of the Lightsail default key pair to delete.
The expectedFingerprint parameter is required only when specifying to delete a Lightsail
default key pair.
"""
function delete_key_pair(keyPairName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DeleteKeyPair",
Dict{String,Any}("keyPairName" => keyPairName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_key_pair(
keyPairName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteKeyPair",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyPairName" => keyPairName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_known_host_keys(instance_name)
delete_known_host_keys(instance_name, params::Dict{String,<:Any})
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or
RDP clients to authenticate an instance. This operation enables the Lightsail browser-based
SSH or RDP clients to connect to the instance after a host key mismatch. Perform this
operation only if you were expecting the host key or certificate mismatch or if you are
familiar with the new host key or certificate on the instance. For more information, see
Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP
client.
# Arguments
- `instance_name`: The name of the instance for which you want to reset the host key or
certificate.
"""
function delete_known_host_keys(
instanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteKnownHostKeys",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_known_host_keys(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteKnownHostKeys",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_load_balancer(load_balancer_name)
delete_load_balancer(load_balancer_name, params::Dict{String,<:Any})
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the
load balancer is deleted, you will need to create a new load balancer, create a new
certificate, and verify domain ownership again. The delete load balancer operation supports
tag-based access control via resource tags applied to the resource identified by load
balancer name. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `load_balancer_name`: The name of the load balancer you want to delete.
"""
function delete_load_balancer(
loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteLoadBalancer",
Dict{String,Any}("loadBalancerName" => loadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_load_balancer(
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteLoadBalancer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("loadBalancerName" => loadBalancerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_load_balancer_tls_certificate(certificate_name, load_balancer_name)
delete_load_balancer_tls_certificate(certificate_name, load_balancer_name, params::Dict{String,<:Any})
Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The
DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see
the Amazon Lightsail Developer Guide.
# Arguments
- `certificate_name`: The SSL/TLS certificate name.
- `load_balancer_name`: The load balancer name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: When true, forces the deletion of an SSL/TLS certificate. There can be two
certificates associated with a Lightsail load balancer: the primary and the backup. The
force parameter is required when the primary SSL/TLS certificate is in use by an instance
attached to the load balancer.
"""
function delete_load_balancer_tls_certificate(
certificateName, loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteLoadBalancerTlsCertificate",
Dict{String,Any}(
"certificateName" => certificateName, "loadBalancerName" => loadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_load_balancer_tls_certificate(
certificateName,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteLoadBalancerTlsCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateName" => certificateName,
"loadBalancerName" => loadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_relational_database(relational_database_name)
delete_relational_database(relational_database_name, params::Dict{String,<:Any})
Deletes a database in Amazon Lightsail. The delete relational database operation supports
tag-based access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `relational_database_name`: The name of the database that you are deleting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"finalRelationalDatabaseSnapshotName"`: The name of the database snapshot created if
skip final snapshot is false, which is the default value for that parameter. Specifying
this parameter and also specifying the skip final snapshot parameter to true results in an
error. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
- `"skipFinalSnapshot"`: Determines whether a final database snapshot is created before
your database is deleted. If true is specified, no database snapshot is created. If false
is specified, a database snapshot is created before your database is deleted. You must
specify the final relational database snapshot name parameter if the skip final snapshot
parameter is false. Default: false
"""
function delete_relational_database(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteRelationalDatabase",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_relational_database(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_relational_database_snapshot(relational_database_snapshot_name)
delete_relational_database_snapshot(relational_database_snapshot_name, params::Dict{String,<:Any})
Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot
operation supports tag-based access control via resource tags applied to the resource
identified by relationalDatabaseName. For more information, see the Amazon Lightsail
Developer Guide.
# Arguments
- `relational_database_snapshot_name`: The name of the database snapshot that you are
deleting.
"""
function delete_relational_database_snapshot(
relationalDatabaseSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DeleteRelationalDatabaseSnapshot",
Dict{String,Any}(
"relationalDatabaseSnapshotName" => relationalDatabaseSnapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_relational_database_snapshot(
relationalDatabaseSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DeleteRelationalDatabaseSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"relationalDatabaseSnapshotName" => relationalDatabaseSnapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_certificate_from_distribution(distribution_name)
detach_certificate_from_distribution(distribution_name, params::Dict{String,<:Any})
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN)
distribution. After the certificate is detached, your distribution stops accepting traffic
for all of the domains that are associated with the certificate.
# Arguments
- `distribution_name`: The name of the distribution from which to detach the certificate.
Use the GetDistributions action to get a list of distribution names that you can specify.
"""
function detach_certificate_from_distribution(
distributionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DetachCertificateFromDistribution",
Dict{String,Any}("distributionName" => distributionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_certificate_from_distribution(
distributionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DetachCertificateFromDistribution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("distributionName" => distributionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_disk(disk_name)
detach_disk(disk_name, params::Dict{String,<:Any})
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any
file systems on the device within your operating system before stopping the instance and
detaching the disk. The detach disk operation supports tag-based access control via
resource tags applied to the resource identified by disk name. For more information, see
the Amazon Lightsail Developer Guide.
# Arguments
- `disk_name`: The unique name of the disk you want to detach from your instance (my-disk).
"""
function detach_disk(diskName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DetachDisk",
Dict{String,Any}("diskName" => diskName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_disk(
diskName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DetachDisk",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("diskName" => diskName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_instances_from_load_balancer(instance_names, load_balancer_name)
detach_instances_from_load_balancer(instance_names, load_balancer_name, params::Dict{String,<:Any})
Detaches the specified instances from a Lightsail load balancer. This operation waits until
the instances are no longer needed before they are detached from the load balancer. The
detach instances from load balancer operation supports tag-based access control via
resource tags applied to the resource identified by load balancer name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_names`: An array of strings containing the names of the instances you want to
detach from the load balancer.
- `load_balancer_name`: The name of the Lightsail load balancer.
"""
function detach_instances_from_load_balancer(
instanceNames, loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DetachInstancesFromLoadBalancer",
Dict{String,Any}(
"instanceNames" => instanceNames, "loadBalancerName" => loadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_instances_from_load_balancer(
instanceNames,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DetachInstancesFromLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"instanceNames" => instanceNames, "loadBalancerName" => loadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_static_ip(static_ip_name)
detach_static_ip(static_ip_name, params::Dict{String,<:Any})
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
# Arguments
- `static_ip_name`: The name of the static IP to detach from the instance.
"""
function detach_static_ip(staticIpName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DetachStaticIp",
Dict{String,Any}("staticIpName" => staticIpName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_static_ip(
staticIpName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DetachStaticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("staticIpName" => staticIpName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_add_on(add_on_type, resource_name)
disable_add_on(add_on_type, resource_name, params::Dict{String,<:Any})
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `add_on_type`: The add-on type to disable.
- `resource_name`: The name of the source resource for which to disable the add-on.
"""
function disable_add_on(
addOnType, resourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DisableAddOn",
Dict{String,Any}("addOnType" => addOnType, "resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_add_on(
addOnType,
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"DisableAddOn",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("addOnType" => addOnType, "resourceName" => resourceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
download_default_key_pair()
download_default_key_pair(params::Dict{String,<:Any})
Downloads the regional Amazon Lightsail default key pair. This action also creates a
Lightsail default key pair if a default key pair does not currently exist in the Amazon Web
Services Region.
"""
function download_default_key_pair(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"DownloadDefaultKeyPair"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function download_default_key_pair(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"DownloadDefaultKeyPair",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_add_on(add_on_request, resource_name)
enable_add_on(add_on_request, resource_name, params::Dict{String,<:Any})
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see
the Amazon Lightsail Developer Guide.
# Arguments
- `add_on_request`: An array of strings representing the add-on to enable or modify.
- `resource_name`: The name of the source resource for which to enable or modify the add-on.
"""
function enable_add_on(
addOnRequest, resourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"EnableAddOn",
Dict{String,Any}("addOnRequest" => addOnRequest, "resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_add_on(
addOnRequest,
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"EnableAddOn",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"addOnRequest" => addOnRequest, "resourceName" => resourceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_snapshot(source_snapshot_name)
export_snapshot(source_snapshot_name, params::Dict{String,<:Any})
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic
Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be
used with the create cloud formation stack operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the
instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported
disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the
same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export
snapshot operation supports tag-based access control via resource tags applied to the
resource identified by source snapshot name. For more information, see the Amazon Lightsail
Developer Guide. Use the get instance snapshots or get disk snapshots operations to get a
list of snapshots that you can export to Amazon EC2.
# Arguments
- `source_snapshot_name`: The name of the instance or disk snapshot to be exported to
Amazon EC2.
"""
function export_snapshot(
sourceSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"ExportSnapshot",
Dict{String,Any}("sourceSnapshotName" => sourceSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_snapshot(
sourceSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"ExportSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceSnapshotName" => sourceSnapshotName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_active_names()
get_active_names(params::Dict{String,<:Any})
Returns the names of all active (not deleted) resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetActiveNames request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_active_names(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetActiveNames"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_active_names(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetActiveNames", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_alarms()
get_alarms(params::Dict{String,<:Any})
Returns information about the configured alarms. Specify an alarm name in your request to
return information about a specific alarm, or specify a monitored resource name to return
information about all alarms for a specific resource. An alarm is used to monitor a single
metric for one of your resources. When a metric condition is met, the alarm can notify you
by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For
more information, see Alarms in Amazon Lightsail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alarmName"`: The name of the alarm. Specify an alarm name to return information about a
specific alarm.
- `"monitoredResourceName"`: The name of the Lightsail resource being monitored by the
alarm. Specify a monitored resource name to return information about all alarms for a
specific resource.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetAlarms request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_alarms(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetAlarms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_alarms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetAlarms", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_auto_snapshots(resource_name)
get_auto_snapshots(resource_name, params::Dict{String,<:Any})
Returns the available automatic snapshots for an instance or disk. For more information,
see the Amazon Lightsail Developer Guide.
# Arguments
- `resource_name`: The name of the source instance or disk from which to get automatic
snapshot information.
"""
function get_auto_snapshots(resourceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetAutoSnapshots",
Dict{String,Any}("resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_auto_snapshots(
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetAutoSnapshots",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceName" => resourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_blueprints()
get_blueprints(params::Dict{String,<:Any})
Returns the list of available instance images, or blueprints. You can use a blueprint to
create a new instance already running a specific operating system, as well as a
preinstalled app or development stack. The software each instance is running depends on the
blueprint image you choose. Use active blueprints when creating new instances. Inactive
blueprints are listed to support customers with existing instances and are not necessarily
available to create new instances. Blueprints are marked inactive when they become outdated
due to operating system updates or new application releases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appCategory"`: Returns a list of blueprints that are specific to Lightsail for
Research. You must use this parameter to view Lightsail for Research blueprints.
- `"includeInactive"`: A Boolean value that indicates whether to include inactive
(unavailable) blueprints in the response of your request.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetBlueprints request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_blueprints(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetBlueprints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_blueprints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetBlueprints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_bucket_access_keys(bucket_name)
get_bucket_access_keys(bucket_name, params::Dict{String,<:Any})
Returns the existing access key IDs for the specified Amazon Lightsail bucket. This action
does not return the secret access key value of an access key. You can get a secret access
key only when you create it from the response of the CreateBucketAccessKey action. If you
lose the secret access key, you must create a new access key.
# Arguments
- `bucket_name`: The name of the bucket for which to return access keys.
"""
function get_bucket_access_keys(
bucketName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetBucketAccessKeys",
Dict{String,Any}("bucketName" => bucketName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_access_keys(
bucketName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetBucketAccessKeys",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("bucketName" => bucketName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_bundles()
get_bucket_bundles(params::Dict{String,<:Any})
Returns the bundles that you can apply to a Amazon Lightsail bucket. The bucket bundle
specifies the monthly cost, storage quota, and data transfer quota for a bucket. Use the
UpdateBucketBundle action to update the bundle for a bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeInactive"`: A Boolean value that indicates whether to include inactive
(unavailable) bundles in the response of your request.
"""
function get_bucket_bundles(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetBucketBundles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_bundles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetBucketBundles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_bucket_metric_data(bucket_name, end_time, metric_name, period, start_time, statistics, unit)
get_bucket_metric_data(bucket_name, end_time, metric_name, period, start_time, statistics, unit, params::Dict{String,<:Any})
Returns the data points of a specific metric for an Amazon Lightsail bucket. Metrics report
the utilization of a bucket. View and collect metric data regularly to monitor the number
of objects stored in a bucket (including object versions) and the storage space used by
those objects.
# Arguments
- `bucket_name`: The name of the bucket for which to get metric data.
- `end_time`: The timestamp indicating the latest data to be returned.
- `metric_name`: The metric for which you want to return information. Valid bucket metric
names are listed below, along with the most useful statistics to include in your request,
and the published unit value. These bucket metrics are reported once per day.
BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated
by summing the size of all objects in the bucket (including object versions), including the
size of all parts for all incomplete multipart uploads to the bucket. Statistics: The most
useful statistic is Maximum. Unit: The published unit is Bytes. NumberOfObjects - The
total number of objects stored in a bucket. This value is calculated by counting all
objects in the bucket (including object versions) and the total number of parts for all
incomplete multipart uploads to the bucket. Statistics: The most useful statistic is
Average. Unit: The published unit is Count.
- `period`: The granularity, in seconds, of the returned data points. Bucket storage
metrics are reported once per day. Therefore, you should specify a period of 86400 seconds,
which is the number of seconds in a day.
- `start_time`: The timestamp indicating the earliest data to be returned.
- `statistics`: The statistic for the metric. The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to
determine low volumes of activity for your application. Maximum - The highest value
observed during the specified period. Use this value to determine high volumes of activity
for your application. Sum - The sum of all values submitted for the matching metric. You
can use this statistic to determine the total volume of a metric. Average - The value of
Sum / SampleCount during the specified period. By comparing this statistic with the Minimum
and Maximum values, you can determine the full scope of a metric and how close the average
use is to the Minimum and Maximum values. This comparison helps you to know when to
increase or decrease your resources. SampleCount - The count, or number, of data points
used for the statistical calculation.
- `unit`: The unit for the metric data request. Valid units depend on the metric data being
requested. For the valid units with each available metric, see the metricName parameter.
"""
function get_bucket_metric_data(
bucketName,
endTime,
metricName,
period,
startTime,
statistics,
unit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetBucketMetricData",
Dict{String,Any}(
"bucketName" => bucketName,
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_metric_data(
bucketName,
endTime,
metricName,
period,
startTime,
statistics,
unit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetBucketMetricData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bucketName" => bucketName,
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_buckets()
get_buckets(params::Dict{String,<:Any})
Returns information about one or more Amazon Lightsail buckets. The information returned
includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)
account-level block public access feature for your Lightsail buckets. For more information
about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bucketName"`: The name of the bucket for which to return information. When omitted, the
response includes all of your buckets in the Amazon Web Services Region where the request
is made.
- `"includeConnectedResources"`: A Boolean value that indicates whether to include
Lightsail instances that were given access to the bucket using the
SetResourceAccessForBucket action.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetBuckets request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_buckets(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetBuckets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_buckets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetBuckets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_bundles()
get_bundles(params::Dict{String,<:Any})
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of
memory, the number of vCPUs, amount of storage space, and monthly network data transfer
quota. Bundles are referred to as instance plans in the Lightsail console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appCategory"`: Returns a list of bundles that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research bundles.
- `"includeInactive"`: A Boolean value that indicates whether to include inactive
(unavailable) bundles in the response of your request.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetBundles request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_bundles(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetBundles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_bundles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetBundles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_certificates()
get_certificates(params::Dict{String,<:Any})
Returns information about one or more Amazon Lightsail SSL/TLS certificates. To get a
summary of a certificate, omit includeCertificateDetails from your request. The response
will include only the certificate Amazon Resource Name (ARN), certificate name, domain
name, and tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"certificateName"`: The name for the certificate for which to return information. When
omitted, the response includes all of your certificates in the Amazon Web Services Region
where the request is made.
- `"certificateStatuses"`: The status of the certificates for which to return information.
For example, specify ISSUED to return only certificates with an ISSUED status. When
omitted, the response includes all of your certificates in the Amazon Web Services Region
where the request is made, regardless of their current status.
- `"includeCertificateDetails"`: Indicates whether to include detailed information about
the certificates in the response. When omitted, the response includes only the certificate
names, Amazon Resource Names (ARNs), domain names, and tags.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetCertificates request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetCertificates", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_cloud_formation_stack_records()
get_cloud_formation_stack_records(params::Dict{String,<:Any})
Returns the CloudFormation stack record created as a result of the create cloud formation
stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance
from an exported Lightsail snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetClouFormationStackRecords request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_cloud_formation_stack_records(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetCloudFormationStackRecords";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cloud_formation_stack_records(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetCloudFormationStackRecords",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_methods()
get_contact_methods(params::Dict{String,<:Any})
Returns information about the configured contact methods. Specify a protocol in your
request to return information about a specific contact method. A contact method is used to
send you notifications about your Amazon Lightsail resources. You can add one email address
and one mobile phone number contact method in each Amazon Web Services Region. However, SMS
text messaging is not supported in some Amazon Web Services Regions, and SMS text messages
cannot be sent to some countries/regions. For more information, see Notifications in Amazon
Lightsail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"protocols"`: The protocols used to send notifications, such as Email, or SMS (text
messaging). Specify a protocol in your request to return information about a specific
contact method protocol.
"""
function get_contact_methods(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetContactMethods"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_contact_methods(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContactMethods", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_container_apimetadata()
get_container_apimetadata(params::Dict{String,<:Any})
Returns information about Amazon Lightsail containers, such as the current version of the
Lightsail Control (lightsailctl) plugin.
"""
function get_container_apimetadata(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetContainerAPIMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_container_apimetadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContainerAPIMetadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_images(service_name)
get_container_images(service_name, params::Dict{String,<:Any})
Returns the container images that are registered to your Amazon Lightsail container
service. If you created a deployment on your Lightsail container service that uses
container images from a public registry like Docker Hub, those images are not returned as
part of this action. Those images are not registered to your Lightsail container service.
# Arguments
- `service_name`: The name of the container service for which to return registered
container images.
"""
function get_container_images(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContainerImages",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_images(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetContainerImages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_log(container_name, service_name)
get_container_log(container_name, service_name, params::Dict{String,<:Any})
Returns the log events of a container of your Amazon Lightsail container service. If your
container service has more than one node (i.e., a scale greater than 1), then the log
events that are returned for the specified container are merged from all nodes on your
container service. Container logs are retained for a certain amount of time. For more
information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General
Reference.
# Arguments
- `container_name`: The name of the container that is either running or previously ran on
the container service for which to return a log.
- `service_name`: The name of the container service for which to get a container log.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The end of the time interval for which to get log data. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600
as the end time. You can convert a human-friendly time to Unix time format using a
converter like Epoch converter.
- `"filterPattern"`: The pattern to use to filter the returned log events to a specific
term. The following are a few examples of filter patterns that you can specify: To return
all log events, specify a filter pattern of \"\". To exclude log events that contain the
ERROR term, and return all other log events, specify a filter pattern of \"-ERROR\". To
return log events that contain the ERROR term, specify a filter pattern of \"ERROR\". To
return log events that contain both the ERROR and Exception terms, specify a filter pattern
of \"ERROR Exception\". To return log events that contain the ERROR or the Exception
term, specify a filter pattern of \"?ERROR ?Exception\".
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetContainerLog request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a
subsequent request.
- `"startTime"`: The start of the time interval for which to get log data. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
1538424000 as the start time. You can convert a human-friendly time to Unix time format
using a converter like Epoch converter.
"""
function get_container_log(
containerName, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContainerLog",
Dict{String,Any}("containerName" => containerName, "serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_log(
containerName,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetContainerLog",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"containerName" => containerName, "serviceName" => serviceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_service_deployments(service_name)
get_container_service_deployments(service_name, params::Dict{String,<:Any})
Returns the deployments for your Amazon Lightsail container service A deployment specifies
the settings, such as the ports and launch command, of containers that are deployed to your
container service. The deployments are ordered by version in ascending order. The newest
version is listed at the top of the response. A set number of deployments are kept before
the oldest one is replaced with the newest one. For more information, see Amazon Lightsail
endpoints and quotas in the Amazon Web Services General Reference.
# Arguments
- `service_name`: The name of the container service for which to return deployments.
"""
function get_container_service_deployments(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContainerServiceDeployments",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_service_deployments(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetContainerServiceDeployments",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_service_metric_data(end_time, metric_name, period, service_name, start_time, statistics)
get_container_service_metric_data(end_time, metric_name, period, service_name, start_time, statistics, params::Dict{String,<:Any})
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly
to maintain the reliability, availability, and performance of your resources.
# Arguments
- `end_time`: The end time of the time period.
- `metric_name`: The metric for which you want to return information. Valid container
service metric names are listed below, along with the most useful statistics to include in
your request, and the published unit value. CPUUtilization - The average percentage of
compute units that are currently in use across all nodes of the container service. This
metric identifies the processing power required to run containers on each node of the
container service. Statistics: The most useful statistics are Maximum and Average. Unit:
The published unit is Percent. MemoryUtilization - The average percentage of available
memory that is currently in use across all nodes of the container service. This metric
identifies the memory required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is
Percent.
- `period`: The granularity, in seconds, of the returned data points. All container service
metric data is available in 5-minute (300 seconds) granularity.
- `service_name`: The name of the container service for which to get metric data.
- `start_time`: The start time of the time period.
- `statistics`: The statistic for the metric. The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to
determine low volumes of activity for your application. Maximum - The highest value
observed during the specified period. Use this value to determine high volumes of activity
for your application. Sum - All values submitted for the matching metric added together.
You can use this statistic to determine the total volume of a metric. Average - The
value of Sum / SampleCount during the specified period. By comparing this statistic with
the Minimum and Maximum values, you can determine the full scope of a metric and how close
the average use is to the Minimum and Maximum values. This comparison helps you to know
when to increase or decrease your resources. SampleCount - The count, or number, of data
points used for the statistical calculation.
"""
function get_container_service_metric_data(
endTime,
metricName,
period,
serviceName,
startTime,
statistics;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetContainerServiceMetricData",
Dict{String,Any}(
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"serviceName" => serviceName,
"startTime" => startTime,
"statistics" => statistics,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_service_metric_data(
endTime,
metricName,
period,
serviceName,
startTime,
statistics,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetContainerServiceMetricData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"serviceName" => serviceName,
"startTime" => startTime,
"statistics" => statistics,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_service_powers()
get_container_service_powers(params::Dict{String,<:Any})
Returns the list of powers that can be specified for your Amazon Lightsail container
services. The power specifies the amount of memory, the number of vCPUs, and the base price
of the container service.
"""
function get_container_service_powers(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetContainerServicePowers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_container_service_powers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContainerServicePowers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_services()
get_container_services(params::Dict{String,<:Any})
Returns information about one or more of your Amazon Lightsail container services.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"serviceName"`: The name of the container service for which to return information. When
omitted, the response includes all of your container services in the Amazon Web Services
Region where the request is made.
"""
function get_container_services(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetContainerServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_container_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetContainerServices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cost_estimate(end_time, resource_name, start_time)
get_cost_estimate(end_time, resource_name, start_time, params::Dict{String,<:Any})
Retrieves information about the cost estimate for a specified resource. A cost estimate
will not generate for a resource that has been deleted.
# Arguments
- `end_time`: The cost estimate end time. Constraints: Specified in Coordinated Universal
Time (UTC). Specified in the Unix time format. For example, if you want to use an end
time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. You can convert
a human-friendly time to Unix time format using a converter like Epoch converter.
- `resource_name`: The resource name.
- `start_time`: The cost estimate start time. Constraints: Specified in Coordinated
Universal Time (UTC). Specified in the Unix time format. For example, if you want to use
a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. You
can convert a human-friendly time to Unix time format using a converter like Epoch
converter.
"""
function get_cost_estimate(
endTime, resourceName, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetCostEstimate",
Dict{String,Any}(
"endTime" => endTime, "resourceName" => resourceName, "startTime" => startTime
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cost_estimate(
endTime,
resourceName,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetCostEstimate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"resourceName" => resourceName,
"startTime" => startTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_disk(disk_name)
get_disk(disk_name, params::Dict{String,<:Any})
Returns information about a specific block storage disk.
# Arguments
- `disk_name`: The name of the disk (my-disk).
"""
function get_disk(diskName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetDisk",
Dict{String,Any}("diskName" => diskName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_disk(
diskName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetDisk",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("diskName" => diskName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_disk_snapshot(disk_snapshot_name)
get_disk_snapshot(disk_snapshot_name, params::Dict{String,<:Any})
Returns information about a specific block storage disk snapshot.
# Arguments
- `disk_snapshot_name`: The name of the disk snapshot (my-disk-snapshot).
"""
function get_disk_snapshot(
diskSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDiskSnapshot",
Dict{String,Any}("diskSnapshotName" => diskSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_disk_snapshot(
diskSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetDiskSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("diskSnapshotName" => diskSnapshotName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_disk_snapshots()
get_disk_snapshots(params::Dict{String,<:Any})
Returns information about all block storage disk snapshots in your AWS account and region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetDiskSnapshots request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_disk_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetDiskSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_disk_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDiskSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_disks()
get_disks(params::Dict{String,<:Any})
Returns information about all block storage disks in your AWS account and region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetDisks request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_disks(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetDisks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_disks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDisks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_distribution_bundles()
get_distribution_bundles(params::Dict{String,<:Any})
Returns the bundles that can be applied to your Amazon Lightsail content delivery network
(CDN) distributions. A distribution bundle specifies the monthly network transfer quota and
monthly cost of your distribution.
"""
function get_distribution_bundles(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetDistributionBundles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_distribution_bundles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDistributionBundles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_distribution_latest_cache_reset()
get_distribution_latest_cache_reset(params::Dict{String,<:Any})
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail
content delivery network (CDN) distribution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"distributionName"`: The name of the distribution for which to return the timestamp of
the last cache reset. Use the GetDistributions action to get a list of distribution names
that you can specify. When omitted, the response includes the latest cache reset timestamp
of all your distributions.
"""
function get_distribution_latest_cache_reset(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDistributionLatestCacheReset";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_distribution_latest_cache_reset(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDistributionLatestCacheReset",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_distribution_metric_data(distribution_name, end_time, metric_name, period, start_time, statistics, unit)
get_distribution_metric_data(distribution_name, end_time, metric_name, period, start_time, statistics, unit, params::Dict{String,<:Any})
Returns the data points of a specific metric for an Amazon Lightsail content delivery
network (CDN) distribution. Metrics report the utilization of your resources, and the error
counts generated by them. Monitor and collect metric data regularly to maintain the
reliability, availability, and performance of your resources.
# Arguments
- `distribution_name`: The name of the distribution for which to get metric data. Use the
GetDistributions action to get a list of distribution names that you can specify.
- `end_time`: The end of the time interval for which to get metric data. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600
as the end time. You can convert a human-friendly time to Unix time format using a
converter like Epoch converter.
- `metric_name`: The metric for which you want to return information. Valid distribution
metric names are listed below, along with the most useful statistics to include in your
request, and the published unit value. Requests - The total number of viewer requests
received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS
requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
distribution, using POST and PUT requests. Statistics: The most useful statistic is Sum.
Unit: The published unit is None. TotalErrorRate - The percentage of all viewer
requests for which the response's HTTP status code was 4xx or 5xx. Statistics: The most
useful statistic is Average. Unit: The published unit is Percent. 4xxErrorRate - The
percentage of all viewer requests for which the response's HTTP status cod was 4xx. In
these cases, the client or client viewer may have made an error. For example, a status code
of 404 (Not Found) means that the client requested an object that could not be found.
Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
code was 5xx. In these cases, the origin server did not satisfy the requests. For example,
a status code of 503 (Service Unavailable) means that the origin server is currently
unavailable. Statistics: The most useful statistic is Average. Unit: The published unit
is Percent.
- `period`: The granularity, in seconds, for the metric data points that will be returned.
- `start_time`: The start of the time interval for which to get metric data. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
1538424000 as the start time. You can convert a human-friendly time to Unix time format
using a converter like Epoch converter.
- `statistics`: The statistic for the metric. The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to
determine low volumes of activity for your application. Maximum - The highest value
observed during the specified period. Use this value to determine high volumes of activity
for your application. Sum - All values submitted for the matching metric added together.
You can use this statistic to determine the total volume of a metric. Average - The
value of Sum / SampleCount during the specified period. By comparing this statistic with
the Minimum and Maximum values, you can determine the full scope of a metric and how close
the average use is to the Minimum and Maximum values. This comparison helps you to know
when to increase or decrease your resources. SampleCount - The count, or number, of data
points used for the statistical calculation.
- `unit`: The unit for the metric data request. Valid units depend on the metric data being
requested. For the valid units with each available metric, see the metricName parameter.
"""
function get_distribution_metric_data(
distributionName,
endTime,
metricName,
period,
startTime,
statistics,
unit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetDistributionMetricData",
Dict{String,Any}(
"distributionName" => distributionName,
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_distribution_metric_data(
distributionName,
endTime,
metricName,
period,
startTime,
statistics,
unit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetDistributionMetricData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"distributionName" => distributionName,
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_distributions()
get_distributions(params::Dict{String,<:Any})
Returns information about one or more of your Amazon Lightsail content delivery network
(CDN) distributions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"distributionName"`: The name of the distribution for which to return information. When
omitted, the response includes all of your distributions in the Amazon Web Services Region
where the request is made.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetDistributions request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_distributions(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetDistributions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_distributions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDistributions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_domain(domain_name)
get_domain(domain_name, params::Dict{String,<:Any})
Returns information about a specific domain recordset.
# Arguments
- `domain_name`: The domain name for which your want to return information about.
"""
function get_domain(domainName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetDomain",
Dict{String,Any}("domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain(
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("domainName" => domainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domains()
get_domains(params::Dict{String,<:Any})
Returns a list of all domains in the user's account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetDomains request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetDomains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetDomains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_export_snapshot_records()
get_export_snapshot_records(params::Dict{String,<:Any})
Returns all export snapshot records created as a result of the export snapshot operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related
resources with the CreateCloudFormationStack action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetExportSnapshotRecords request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_export_snapshot_records(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetExportSnapshotRecords"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_export_snapshot_records(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetExportSnapshotRecords",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance(instance_name)
get_instance(instance_name, params::Dict{String,<:Any})
Returns information about a specific Amazon Lightsail instance, which is a virtual private
server.
# Arguments
- `instance_name`: The name of the instance.
"""
function get_instance(instanceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetInstance",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_access_details(instance_name)
get_instance_access_details(instance_name, params::Dict{String,<:Any})
Returns temporary SSH keys you can use to connect to a specific virtual private server, or
instance. The get instance access details operation supports tag-based access control via
resource tags applied to the resource identified by instance name. For more information,
see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The name of the instance to access.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"protocol"`: The protocol to use to connect to your instance. Defaults to ssh.
"""
function get_instance_access_details(
instanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetInstanceAccessDetails",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_access_details(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstanceAccessDetails",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_metric_data(end_time, instance_name, metric_name, period, start_time, statistics, unit)
get_instance_metric_data(end_time, instance_name, metric_name, period, start_time, statistics, unit, params::Dict{String,<:Any})
Returns the data points for the specified Amazon Lightsail instance metric, given an
instance name. Metrics report the utilization of your resources, and the error counts
generated by them. Monitor and collect metric data regularly to maintain the reliability,
availability, and performance of your resources.
# Arguments
- `end_time`: The end time of the time period.
- `instance_name`: The name of the instance for which you want to get metrics data.
- `metric_name`: The metric for which you want to return information. Valid instance metric
names are listed below, along with the most useful statistics to include in your request,
and the published unit value. BurstCapacityPercentage - The percentage of CPU
performance available for your instance to burst above its baseline. Your instance
continuously accrues and consumes burst capacity. Burst capacity stops accruing when your
instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance
burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and
Average. Unit: The published unit is Percent. BurstCapacityTime - The available
amount of time for your instance to burst at 100% CPU utilization. Your instance
continuously accrues and consumes burst capacity. Burst capacity time stops accruing when
your instance's BurstCapacityPercentage metric reaches 100%. Burst capacity time is
consumed at the full rate only when your instance operates at 100% CPU utilization. For
example, if your instance operates at 50% CPU utilization in the burstable zone for a
5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period.
Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the
5-minute period. For more information, see Viewing instance burst capacity in Amazon
Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The
published unit is Seconds. CPUUtilization - The percentage of allocated compute units
that are currently in use on the instance. This metric identifies the processing power to
run the applications on the instance. Tools in your operating system can show a lower
percentage than Lightsail when the instance is not allocated a full processor core.
Statistics: The most useful statistics are Maximum and Average. Unit: The published unit
is Percent. NetworkIn - The number of bytes received on all network interfaces by the
instance. This metric identifies the volume of incoming network traffic to the instance.
The number reported is the number of bytes received during the period. Because this metric
is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes.
NetworkOut - The number of bytes sent out on all network interfaces by the instance. This
metric identifies the volume of outgoing network traffic from the instance. The number
reported is the number of bytes sent during the period. Because this metric is reported in
5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics:
The most useful statistic is Sum. Unit: The published unit is Bytes. StatusCheckFailed
- Reports whether the instance passed or failed both the instance status check and the
system status check. This metric can be either 0 (passed) or 1 (failed). This metric data
is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic
is Sum. Unit: The published unit is Count. StatusCheckFailed_Instance - Reports
whether the instance passed or failed the instance status check. This metric can be either
0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is
Count. StatusCheckFailed_System - Reports whether the instance passed or failed the
system status check. This metric can be either 0 (passed) or 1 (failed). This metric data
is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic
is Sum. Unit: The published unit is Count. MetadataNoToken - Reports the number of
times that the instance metadata service was successfully accessed without a token. This
metric determines if there are any processes accessing instance metadata by using Instance
Metadata Service Version 1, which doesn't use a token. If all requests use token-backed
sessions, such as Instance Metadata Service Version 2, then the value is 0. Statistics:
The most useful statistic is Sum. Unit: The published unit is Count.
- `period`: The granularity, in seconds, of the returned data points. The
StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric
data is available in 1-minute (60 seconds) granularity. All other instance metric data is
available in 5-minute (300 seconds) granularity.
- `start_time`: The start time of the time period.
- `statistics`: The statistic for the metric. The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to
determine low volumes of activity for your application. Maximum - The highest value
observed during the specified period. Use this value to determine high volumes of activity
for your application. Sum - All values submitted for the matching metric added together.
You can use this statistic to determine the total volume of a metric. Average - The
value of Sum / SampleCount during the specified period. By comparing this statistic with
the Minimum and Maximum values, you can determine the full scope of a metric and how close
the average use is to the Minimum and Maximum values. This comparison helps you to know
when to increase or decrease your resources. SampleCount - The count, or number, of data
points used for the statistical calculation.
- `unit`: The unit for the metric data request. Valid units depend on the metric data being
requested. For the valid units to specify with each available metric, see the metricName
parameter.
"""
function get_instance_metric_data(
endTime,
instanceName,
metricName,
period,
startTime,
statistics,
unit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstanceMetricData",
Dict{String,Any}(
"endTime" => endTime,
"instanceName" => instanceName,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_metric_data(
endTime,
instanceName,
metricName,
period,
startTime,
statistics,
unit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstanceMetricData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"instanceName" => instanceName,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_port_states(instance_name)
get_instance_port_states(instance_name, params::Dict{String,<:Any})
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses
allowed to connect to the instance through the ports, and the protocol.
# Arguments
- `instance_name`: The name of the instance for which to return firewall port states.
"""
function get_instance_port_states(
instanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetInstancePortStates",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_port_states(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstancePortStates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_snapshot(instance_snapshot_name)
get_instance_snapshot(instance_snapshot_name, params::Dict{String,<:Any})
Returns information about a specific instance snapshot.
# Arguments
- `instance_snapshot_name`: The name of the snapshot for which you are requesting
information.
"""
function get_instance_snapshot(
instanceSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetInstanceSnapshot",
Dict{String,Any}("instanceSnapshotName" => instanceSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_snapshot(
instanceSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstanceSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("instanceSnapshotName" => instanceSnapshotName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_snapshots()
get_instance_snapshots(params::Dict{String,<:Any})
Returns all instance snapshots for the user's account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetInstanceSnapshots request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_instance_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetInstanceSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_instance_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetInstanceSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_state(instance_name)
get_instance_state(instance_name, params::Dict{String,<:Any})
Returns the state of a specific instance. Works on one instance at a time.
# Arguments
- `instance_name`: The name of the instance to get state information about.
"""
function get_instance_state(instanceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetInstanceState",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_state(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetInstanceState",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instances()
get_instances(params::Dict{String,<:Any})
Returns information about all Amazon Lightsail virtual private servers, or instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetInstances request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetInstances", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_key_pair(key_pair_name)
get_key_pair(key_pair_name, params::Dict{String,<:Any})
Returns information about a specific key pair.
# Arguments
- `key_pair_name`: The name of the key pair for which you are requesting information.
"""
function get_key_pair(keyPairName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetKeyPair",
Dict{String,Any}("keyPairName" => keyPairName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_key_pair(
keyPairName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetKeyPair",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keyPairName" => keyPairName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_key_pairs()
get_key_pairs(params::Dict{String,<:Any})
Returns information about all key pairs in the user's account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeDefaultKeyPair"`: A Boolean value that indicates whether to include the default
key pair in the response of your request.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetKeyPairs request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_key_pairs(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetKeyPairs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_key_pairs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetKeyPairs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_load_balancer(load_balancer_name)
get_load_balancer(load_balancer_name, params::Dict{String,<:Any})
Returns information about the specified Lightsail load balancer.
# Arguments
- `load_balancer_name`: The name of the load balancer.
"""
function get_load_balancer(
loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetLoadBalancer",
Dict{String,Any}("loadBalancerName" => loadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_load_balancer(
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetLoadBalancer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("loadBalancerName" => loadBalancerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_load_balancer_metric_data(end_time, load_balancer_name, metric_name, period, start_time, statistics, unit)
get_load_balancer_metric_data(end_time, load_balancer_name, metric_name, period, start_time, statistics, unit, params::Dict{String,<:Any})
Returns information about health metrics for your Lightsail load balancer. Metrics report
the utilization of your resources, and the error counts generated by them. Monitor and
collect metric data regularly to maintain the reliability, availability, and performance of
your resources.
# Arguments
- `end_time`: The end time of the period.
- `load_balancer_name`: The name of the load balancer.
- `metric_name`: The metric for which you want to return information. Valid load balancer
metric names are listed below, along with the most useful statistics to include in your
request, and the published unit value. ClientTLSNegotiationErrorCount - The number of
TLS connections initiated by the client that did not establish a session with the load
balancer due to a TLS error generated by the load balancer. Possible causes include a
mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. Unit: The
published unit is Count. HealthyHostCount - The number of target instances that are
considered healthy. Statistics: The most useful statistic are Average, Minimum, and
Maximum. Unit: The published unit is Count. HTTPCode_Instance_2XX_Count - The number
of HTTP 2XX response codes generated by the target instances. This does not include any
response codes generated by the load balancer. Statistics: The most useful statistic is
Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is
Count. HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated
by the target instances. This does not include any response codes generated by the load
balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and
Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_4XX_Count
- The number of HTTP 4XX response codes generated by the target instances. This does not
include any response codes generated by the load balancer. Statistics: The most useful
statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The
published unit is Count. HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response
codes generated by the target instances. This does not include any response codes generated
by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1. Unit: The published unit is Count.
HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the
load balancer. Client errors are generated when requests are malformed or incomplete. These
requests were not received by the target instance. This count does not include response
codes generated by the target instances. Statistics: The most useful statistic is Sum.
Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count.
HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from
the load balancer. This does not include any response codes generated by the target
instance. This metric is reported if there are no healthy instances attached to the load
balancer, or if the request rate exceeds the capacity of the instances (spillover) or the
load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum,
and Average all return 1. Unit: The published unit is Count. InstanceResponseTime -
The time elapsed, in seconds, after the request leaves the load balancer until a response
from the target instance is received. Statistics: The most useful statistic is Average.
Unit: The published unit is Seconds. RejectedConnectionCount - The number of
connections that were rejected because the load balancer had reached its maximum number of
connections. Statistics: The most useful statistic is Sum. Unit: The published unit is
Count. RequestCount - The number of requests processed over IPv4. This count includes
only the requests with a response generated by a target instance of the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all
return 1. Unit: The published unit is Count. UnhealthyHostCount - The number of
target instances that are considered unhealthy. Statistics: The most useful statistic are
Average, Minimum, and Maximum. Unit: The published unit is Count.
- `period`: The granularity, in seconds, of the returned data points.
- `start_time`: The start time of the period.
- `statistics`: The statistic for the metric. The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to
determine low volumes of activity for your application. Maximum - The highest value
observed during the specified period. Use this value to determine high volumes of activity
for your application. Sum - All values submitted for the matching metric added together.
You can use this statistic to determine the total volume of a metric. Average - The
value of Sum / SampleCount during the specified period. By comparing this statistic with
the Minimum and Maximum values, you can determine the full scope of a metric and how close
the average use is to the Minimum and Maximum values. This comparison helps you to know
when to increase or decrease your resources. SampleCount - The count, or number, of data
points used for the statistical calculation.
- `unit`: The unit for the metric data request. Valid units depend on the metric data being
requested. For the valid units with each available metric, see the metricName parameter.
"""
function get_load_balancer_metric_data(
endTime,
loadBalancerName,
metricName,
period,
startTime,
statistics,
unit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetLoadBalancerMetricData",
Dict{String,Any}(
"endTime" => endTime,
"loadBalancerName" => loadBalancerName,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_load_balancer_metric_data(
endTime,
loadBalancerName,
metricName,
period,
startTime,
statistics,
unit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetLoadBalancerMetricData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"loadBalancerName" => loadBalancerName,
"metricName" => metricName,
"period" => period,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_load_balancer_tls_certificates(load_balancer_name)
get_load_balancer_tls_certificates(load_balancer_name, params::Dict{String,<:Any})
Returns information about the TLS certificates that are associated with the specified
Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer
(SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer.
One is active and the other is inactive.
# Arguments
- `load_balancer_name`: The name of the load balancer you associated with your SSL/TLS
certificate.
"""
function get_load_balancer_tls_certificates(
loadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetLoadBalancerTlsCertificates",
Dict{String,Any}("loadBalancerName" => loadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_load_balancer_tls_certificates(
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetLoadBalancerTlsCertificates",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("loadBalancerName" => loadBalancerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_load_balancer_tls_policies()
get_load_balancer_tls_policies(params::Dict{String,<:Any})
Returns a list of TLS security policies that you can apply to Lightsail load balancers. For
more information about load balancer TLS security policies, see Configuring TLS security
policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetLoadBalancerTlsPolicies request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_load_balancer_tls_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetLoadBalancerTlsPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_load_balancer_tls_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetLoadBalancerTlsPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_load_balancers()
get_load_balancers(params::Dict{String,<:Any})
Returns information about all load balancers in an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetLoadBalancers request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_load_balancers(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetLoadBalancers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_load_balancers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetLoadBalancers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_operation(operation_id)
get_operation(operation_id, params::Dict{String,<:Any})
Returns information about a specific operation. Operations include events such as when you
create an instance, allocate a static IP, attach a static IP, and so on.
# Arguments
- `operation_id`: A GUID used to identify the operation.
"""
function get_operation(operationId; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetOperation",
Dict{String,Any}("operationId" => operationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_operation(
operationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetOperation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("operationId" => operationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_operations()
get_operations(params::Dict{String,<:Any})
Returns information about all operations. Results are returned from oldest to newest, up to
a maximum of 200. Results can be paged by making each subsequent call to GetOperations use
the maximum (last) statusChangedAt value from the previous request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetOperations request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_operations(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetOperations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_operations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetOperations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_operations_for_resource(resource_name)
get_operations_for_resource(resource_name, params::Dict{String,<:Any})
Gets operations for a specific resource (an instance or a static IP).
# Arguments
- `resource_name`: The name of the resource for which you are requesting information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetOperationsForResource request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_operations_for_resource(
resourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetOperationsForResource",
Dict{String,Any}("resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_operations_for_resource(
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetOperationsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceName" => resourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_regions()
get_regions(params::Dict{String,<:Any})
Returns a list of all valid regions for Amazon Lightsail. Use the include availability
zones parameter to also return the Availability Zones in a region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeAvailabilityZones"`: A Boolean value indicating whether to also include
Availability Zones in your get regions request. Availability Zones are indicated with a
letter: us-east-2a.
- `"includeRelationalDatabaseAvailabilityZones"`: A Boolean value indicating whether to
also include Availability Zones for databases in your get regions request. Availability
Zones are indicated with a letter (us-east-2a).
"""
function get_regions(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetRegions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_regions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRegions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_relational_database(relational_database_name)
get_relational_database(relational_database_name, params::Dict{String,<:Any})
Returns information about a specific database in Amazon Lightsail.
# Arguments
- `relational_database_name`: The name of the database that you are looking up.
"""
function get_relational_database(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabase",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_blueprints()
get_relational_database_blueprints(params::Dict{String,<:Any})
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes
the major engine version of a database. You can use a blueprint ID to create a new database
that runs a specific database engine.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetRelationalDatabaseBlueprints request. If your results
are paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_relational_database_blueprints(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseBlueprints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_blueprints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseBlueprints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_bundles()
get_relational_database_bundles(params::Dict{String,<:Any})
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the
performance specifications for a database. You can use a bundle ID to create a new database
with explicit performance specifications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeInactive"`: A Boolean value that indicates whether to include inactive
(unavailable) bundles in the response of your request.
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetRelationalDatabaseBundles request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_relational_database_bundles(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseBundles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_bundles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseBundles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_events(relational_database_name)
get_relational_database_events(relational_database_name, params::Dict{String,<:Any})
Returns a list of events for a specific database in Amazon Lightsail.
# Arguments
- `relational_database_name`: The name of the database from which to get events.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"durationInMinutes"`: The number of minutes in the past from which to retrieve events.
For example, to get all events from the past 2 hours, enter 120. Default: 60 The minimum
is 1 and the maximum is 14 days (20160 minutes).
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetRelationalDatabaseEvents request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_relational_database_events(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseEvents",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_events(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseEvents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_log_events(log_stream_name, relational_database_name)
get_relational_database_log_events(log_stream_name, relational_database_name, params::Dict{String,<:Any})
Returns a list of log events for a database in Amazon Lightsail.
# Arguments
- `log_stream_name`: The name of the log stream. Use the get relational database log
streams operation to get a list of available log streams.
- `relational_database_name`: The name of your database for which to get log events.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The end of the time interval from which to get log events. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the end time.
- `"pageToken"`: The token to advance to the next or previous page of results from your
request. To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If
your results are paginated, the response will return a next forward token and/or next
backward token that you can specify as the page token in a subsequent request.
- `"startFromHead"`: Parameter to specify if the log should start from head or tail. If
true is specified, the log event starts from the head of the log. If false is specified,
the log event starts from the tail of the log. For PostgreSQL, the default value of false
is the only option available.
- `"startTime"`: The start of the time interval from which to get log events. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the start time.
"""
function get_relational_database_log_events(
logStreamName, relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseLogEvents",
Dict{String,Any}(
"logStreamName" => logStreamName,
"relationalDatabaseName" => relationalDatabaseName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_log_events(
logStreamName,
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseLogEvents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"logStreamName" => logStreamName,
"relationalDatabaseName" => relationalDatabaseName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_log_streams(relational_database_name)
get_relational_database_log_streams(relational_database_name, params::Dict{String,<:Any})
Returns a list of available log streams for a specific database in Amazon Lightsail.
# Arguments
- `relational_database_name`: The name of your database for which to get log streams.
"""
function get_relational_database_log_streams(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseLogStreams",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_log_streams(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseLogStreams",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_master_user_password(relational_database_name)
get_relational_database_master_user_password(relational_database_name, params::Dict{String,<:Any})
Returns the current, previous, or pending versions of the master user password for a
Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports
tag-based access control via resource tags applied to the resource identified by
relationalDatabaseName.
# Arguments
- `relational_database_name`: The name of your database for which to get the master user
password.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"passwordVersion"`: The password version to return. Specifying CURRENT or PREVIOUS
returns the current or previous passwords respectively. Specifying PENDING returns the
newest version of the password that will rotate to CURRENT. After the PENDING password
rotates to CURRENT, the PENDING password is no longer available. Default: CURRENT
"""
function get_relational_database_master_user_password(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseMasterUserPassword",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_master_user_password(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseMasterUserPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_metric_data(end_time, metric_name, period, relational_database_name, start_time, statistics, unit)
get_relational_database_metric_data(end_time, metric_name, period, relational_database_name, start_time, statistics, unit, params::Dict{String,<:Any})
Returns the data points of the specified metric for a database in Amazon Lightsail. Metrics
report the utilization of your resources, and the error counts generated by them. Monitor
and collect metric data regularly to maintain the reliability, availability, and
performance of your resources.
# Arguments
- `end_time`: The end of the time interval from which to get metric data. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the end time.
- `metric_name`: The metric for which you want to return information. Valid relational
database metric names are listed below, along with the most useful statistics to include in
your request, and the published unit value. All relational database metric data is
available in 1-minute (60 seconds) granularity. CPUUtilization - The percentage of CPU
utilization currently in use on the database. Statistics: The most useful statistics are
Maximum and Average. Unit: The published unit is Percent. DatabaseConnections - The
number of database connections in use. Statistics: The most useful statistics are Maximum
and Sum. Unit: The published unit is Count. DiskQueueDepth - The number of
outstanding IOs (read/write requests) that are waiting to access the disk. Statistics: The
most useful statistic is Sum. Unit: The published unit is Count. FreeStorageSpace -
The amount of available storage space. Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes. NetworkReceiveThroughput - The incoming (Receive)
network traffic on the database, including both customer database traffic and AWS traffic
used for monitoring and replication. Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second. NetworkTransmitThroughput - The outgoing
(Transmit) network traffic on the database, including both customer database traffic and
AWS traffic used for monitoring and replication. Statistics: The most useful statistic is
Average. Unit: The published unit is Bytes/Second.
- `period`: The granularity, in seconds, of the returned data points. All relational
database metric data is available in 1-minute (60 seconds) granularity.
- `relational_database_name`: The name of your database from which to get metric data.
- `start_time`: The start of the time interval from which to get metric data. Constraints:
Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For
example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the start time.
- `statistics`: The statistic for the metric. The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to
determine low volumes of activity for your application. Maximum - The highest value
observed during the specified period. Use this value to determine high volumes of activity
for your application. Sum - All values submitted for the matching metric added together.
You can use this statistic to determine the total volume of a metric. Average - The
value of Sum / SampleCount during the specified period. By comparing this statistic with
the Minimum and Maximum values, you can determine the full scope of a metric and how close
the average use is to the Minimum and Maximum values. This comparison helps you to know
when to increase or decrease your resources. SampleCount - The count, or number, of data
points used for the statistical calculation.
- `unit`: The unit for the metric data request. Valid units depend on the metric data being
requested. For the valid units with each available metric, see the metricName parameter.
"""
function get_relational_database_metric_data(
endTime,
metricName,
period,
relationalDatabaseName,
startTime,
statistics,
unit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseMetricData",
Dict{String,Any}(
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"relationalDatabaseName" => relationalDatabaseName,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_metric_data(
endTime,
metricName,
period,
relationalDatabaseName,
startTime,
statistics,
unit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseMetricData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"metricName" => metricName,
"period" => period,
"relationalDatabaseName" => relationalDatabaseName,
"startTime" => startTime,
"statistics" => statistics,
"unit" => unit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_parameters(relational_database_name)
get_relational_database_parameters(relational_database_name, params::Dict{String,<:Any})
Returns all of the runtime parameters offered by the underlying database software, or
engine, for a specific database in Amazon Lightsail. In addition to the parameter names and
values, this operation returns other information about each parameter. This information
includes whether changes require a reboot, whether the parameter is modifiable, the allowed
values, and the data types.
# Arguments
- `relational_database_name`: The name of your database for which to get parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetRelationalDatabaseParameters request. If your results
are paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_relational_database_parameters(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseParameters",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_parameters(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_snapshot(relational_database_snapshot_name)
get_relational_database_snapshot(relational_database_snapshot_name, params::Dict{String,<:Any})
Returns information about a specific database snapshot in Amazon Lightsail.
# Arguments
- `relational_database_snapshot_name`: The name of the database snapshot for which to get
information.
"""
function get_relational_database_snapshot(
relationalDatabaseSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseSnapshot",
Dict{String,Any}(
"relationalDatabaseSnapshotName" => relationalDatabaseSnapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_snapshot(
relationalDatabaseSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetRelationalDatabaseSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"relationalDatabaseSnapshotName" => relationalDatabaseSnapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_database_snapshots()
get_relational_database_snapshots(params::Dict{String,<:Any})
Returns information about all of your database snapshots in Amazon Lightsail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results
are paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_relational_database_snapshots(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseSnapshots";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relational_database_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabaseSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relational_databases()
get_relational_databases(params::Dict{String,<:Any})
Returns information about all of your databases in Amazon Lightsail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetRelationalDatabases request. If your results are
paginated, the response will return a next page token that you can specify as the page
token in a subsequent request.
"""
function get_relational_databases(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetRelationalDatabases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_relational_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetRelationalDatabases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_setup_history(resource_name)
get_setup_history(resource_name, params::Dict{String,<:Any})
Returns detailed information for five of the most recent SetupInstanceHttps requests that
were ran on the target instance.
# Arguments
- `resource_name`: The name of the resource for which you are requesting information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetSetupHistory request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_setup_history(resourceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetSetupHistory",
Dict{String,Any}("resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_setup_history(
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetSetupHistory",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceName" => resourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_static_ip(static_ip_name)
get_static_ip(static_ip_name, params::Dict{String,<:Any})
Returns information about an Amazon Lightsail static IP.
# Arguments
- `static_ip_name`: The name of the static IP in Lightsail.
"""
function get_static_ip(staticIpName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"GetStaticIp",
Dict{String,Any}("staticIpName" => staticIpName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_static_ip(
staticIpName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"GetStaticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("staticIpName" => staticIpName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_static_ips()
get_static_ips(params::Dict{String,<:Any})
Returns information about all static IPs in the user's account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pageToken"`: The token to advance to the next page of results from your request. To get
a page token, perform an initial GetStaticIps request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a
subsequent request.
"""
function get_static_ips(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("GetStaticIps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_static_ips(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"GetStaticIps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
import_key_pair(key_pair_name, public_key_base64)
import_key_pair(key_pair_name, public_key_base64, params::Dict{String,<:Any})
Imports a public SSH key from a specific key pair.
# Arguments
- `key_pair_name`: The name of the key pair for which you want to import the public key.
- `public_key_base64`: A base64-encoded public key of the ssh-rsa type.
"""
function import_key_pair(
keyPairName, publicKeyBase64; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"ImportKeyPair",
Dict{String,Any}(
"keyPairName" => keyPairName, "publicKeyBase64" => publicKeyBase64
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_key_pair(
keyPairName,
publicKeyBase64,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"ImportKeyPair",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"keyPairName" => keyPairName, "publicKeyBase64" => publicKeyBase64
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
is_vpc_peered()
is_vpc_peered(params::Dict{String,<:Any})
Returns a Boolean value indicating whether your Lightsail VPC is peered.
"""
function is_vpc_peered(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("IsVpcPeered"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function is_vpc_peered(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"IsVpcPeered", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
open_instance_public_ports(instance_name, port_info)
open_instance_public_ports(instance_name, port_info, params::Dict{String,<:Any})
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses
allowed to connect to the instance through the ports, and the protocol. The
OpenInstancePublicPorts action supports tag-based access control via resource tags applied
to the resource identified by instanceName. For more information, see the Amazon Lightsail
Developer Guide.
# Arguments
- `instance_name`: The name of the instance for which to open ports.
- `port_info`: An object to describe the ports to open for the specified instance.
"""
function open_instance_public_ports(
instanceName, portInfo; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"OpenInstancePublicPorts",
Dict{String,Any}("instanceName" => instanceName, "portInfo" => portInfo);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function open_instance_public_ports(
instanceName,
portInfo,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"OpenInstancePublicPorts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("instanceName" => instanceName, "portInfo" => portInfo),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
peer_vpc()
peer_vpc(params::Dict{String,<:Any})
Peers the Lightsail VPC with the user's default VPC.
"""
function peer_vpc(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("PeerVpc"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function peer_vpc(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"PeerVpc", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_alarm(alarm_name, comparison_operator, evaluation_periods, metric_name, monitored_resource_name, threshold)
put_alarm(alarm_name, comparison_operator, evaluation_periods, metric_name, monitored_resource_name, threshold, params::Dict{String,<:Any})
Creates or updates an alarm, and associates it with the specified metric. An alarm is used
to monitor a single metric for one of your resources. When a metric condition is met, the
alarm can notify you by email, SMS text message, and a banner displayed on the Amazon
Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action
creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is
then evaluated and its state is set appropriately. Any actions associated with the new
state are then executed. When you update an existing alarm, its state is left unchanged,
but the update completely overwrites the previous configuration of the alarm. The alarm is
then evaluated with the updated configuration.
# Arguments
- `alarm_name`: The name for the alarm. Specify the name of an existing alarm to update,
and overwrite the previous configuration of the alarm.
- `comparison_operator`: The arithmetic operation to use when comparing the specified
statistic to the threshold. The specified statistic value is used as the first operand.
- `evaluation_periods`: The number of most recent periods over which data is compared to
the specified threshold. If you are setting an \"M out of N\" alarm, this value
(evaluationPeriods) is the N. If you are setting an alarm that requires that a number of
consecutive data points be breaching to trigger the alarm, this value specifies the rolling
period of time in which data points are evaluated. Each evaluation period is five minutes
long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling
period of two hours. You can specify a minimum valuation period of 1 (5 minutes), and a
maximum evaluation period of 288 (24 hours).
- `metric_name`: The name of the metric to associate with the alarm. You can configure up
to two alarms per metric. The following metrics are available for each resource type:
Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn,
NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.
Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount,
HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count,
HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count,
InstanceResponseTime, RejectedConnectionCount, and RequestCount. Relational databases:
CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace,
NetworkReceiveThroughput, and NetworkTransmitThroughput. For more information about these
metrics, see Metrics available in Lightsail.
- `monitored_resource_name`: The name of the Lightsail resource that will be monitored.
Instances, load balancers, and relational databases are the only Lightsail resources that
can currently be monitored by alarms.
- `threshold`: The value against which the specified statistic is compared.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contactProtocols"`: The contact protocols to use for the alarm, such as Email, SMS
(text messaging), or both. A notification is sent via the specified contact protocol if
notifications are enabled for the alarm, and when the alarm is triggered. A notification is
not sent if a contact protocol is not specified, if the specified contact protocol is not
configured in the Amazon Web Services Region, or if notifications are not enabled for the
alarm using the notificationEnabled paramater. Use the CreateContactMethod action to
configure a contact protocol in an Amazon Web Services Region.
- `"datapointsToAlarm"`: The number of data points that must be not within the specified
threshold to trigger the alarm. If you are setting an \"M out of N\" alarm, this value
(datapointsToAlarm) is the M.
- `"notificationEnabled"`: Indicates whether the alarm is enabled. Notifications are
enabled by default if you don't specify this parameter.
- `"notificationTriggers"`: The alarm states that trigger a notification. An alarm has the
following possible states: ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough
data is available for the metric to determine the alarm state. OK - The metric is within
the defined threshold. When you specify a notification trigger, the ALARM state must be
specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM
state. If you specify OK as an alarm trigger, a notification is sent when the alarm
switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought
of as an all clear alarm notification. If you specify INSUFFICIENT_DATA as the alarm
trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to
an INSUFFICIENT_DATA state. The notification trigger defaults to ALARM if you don't
specify this parameter.
- `"treatMissingData"`: Sets how this alarm will handle missing data points. An alarm can
treat missing data in the following ways: breaching - Assume the missing data is not
within the threshold. Missing data counts towards the number of times the metric is not
within the threshold. notBreaching - Assume the missing data is within the threshold.
Missing data does not count towards the number of times the metric is not within the
threshold. ignore - Ignore the missing data. Maintains the current alarm state.
missing - Missing data is treated as missing. If treatMissingData is not specified, the
default behavior of missing is used.
"""
function put_alarm(
alarmName,
comparisonOperator,
evaluationPeriods,
metricName,
monitoredResourceName,
threshold;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"PutAlarm",
Dict{String,Any}(
"alarmName" => alarmName,
"comparisonOperator" => comparisonOperator,
"evaluationPeriods" => evaluationPeriods,
"metricName" => metricName,
"monitoredResourceName" => monitoredResourceName,
"threshold" => threshold,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_alarm(
alarmName,
comparisonOperator,
evaluationPeriods,
metricName,
monitoredResourceName,
threshold,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"PutAlarm",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"alarmName" => alarmName,
"comparisonOperator" => comparisonOperator,
"evaluationPeriods" => evaluationPeriods,
"metricName" => metricName,
"monitoredResourceName" => monitoredResourceName,
"threshold" => threshold,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_instance_public_ports(instance_name, port_infos)
put_instance_public_ports(instance_name, port_infos, params::Dict{String,<:Any})
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses
allowed to connect to the instance through the ports, and the protocol. This action also
closes all currently open ports that are not included in the request. Include all of the
ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the
OpenInstancePublicPorts action to open ports without closing currently open ports. The
PutInstancePublicPorts action supports tag-based access control via resource tags applied
to the resource identified by instanceName. For more information, see the Amazon Lightsail
Developer Guide.
# Arguments
- `instance_name`: The name of the instance for which to open ports.
- `port_infos`: An array of objects to describe the ports to open for the specified
instance.
"""
function put_instance_public_ports(
instanceName, portInfos; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"PutInstancePublicPorts",
Dict{String,Any}("instanceName" => instanceName, "portInfos" => portInfos);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_instance_public_ports(
instanceName,
portInfos,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"PutInstancePublicPorts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("instanceName" => instanceName, "portInfos" => portInfos),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_instance(instance_name)
reboot_instance(instance_name, params::Dict{String,<:Any})
Restarts a specific instance. The reboot instance operation supports tag-based access
control via resource tags applied to the resource identified by instance name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The name of the instance to reboot.
"""
function reboot_instance(instanceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"RebootInstance",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_instance(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"RebootInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_relational_database(relational_database_name)
reboot_relational_database(relational_database_name, params::Dict{String,<:Any})
Restarts a specific database in Amazon Lightsail. The reboot relational database operation
supports tag-based access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `relational_database_name`: The name of your database to reboot.
"""
function reboot_relational_database(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"RebootRelationalDatabase",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_relational_database(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"RebootRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_container_image(digest, label, service_name)
register_container_image(digest, label, service_name, params::Dict{String,<:Any})
Registers a container image to your Amazon Lightsail container service. This action is not
required if you install and use the Lightsail Control (lightsailctl) plugin to push
container images to your Lightsail container service. For more information, see Pushing and
managing container images on your Amazon Lightsail container services in the Amazon
Lightsail Developer Guide.
# Arguments
- `digest`: The digest of the container image to be registered.
- `label`: The label for the container image when it's registered to the container service.
Use a descriptive label that you can use to track the different versions of your registered
container images. Use the GetContainerImages action to return the container images
registered to a Lightsail container service. The label is the <imagelabel> portion of
the following image name example: :container-service-1.<imagelabel>.1 If the
name of your container service is mycontainerservice, and the label that you specify is
mystaticwebsite, then the name of the registered container image will be
:mycontainerservice.mystaticwebsite.1. The number at the end of these image name examples
represents the version of the registered container image. If you push and register another
container image to the same Lightsail container service, with the same label, then the
version number for the new registered container image will be 2. If you push and register
another container image, the version number will be 3, and so on.
- `service_name`: The name of the container service for which to register a container image.
"""
function register_container_image(
digest, label, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"RegisterContainerImage",
Dict{String,Any}(
"digest" => digest, "label" => label, "serviceName" => serviceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_container_image(
digest,
label,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"RegisterContainerImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"digest" => digest, "label" => label, "serviceName" => serviceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
release_static_ip(static_ip_name)
release_static_ip(static_ip_name, params::Dict{String,<:Any})
Deletes a specific static IP from your account.
# Arguments
- `static_ip_name`: The name of the static IP to delete.
"""
function release_static_ip(staticIpName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"ReleaseStaticIp",
Dict{String,Any}("staticIpName" => staticIpName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function release_static_ip(
staticIpName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"ReleaseStaticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("staticIpName" => staticIpName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_distribution_cache()
reset_distribution_cache(params::Dict{String,<:Any})
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN)
distribution. After resetting the cache, the next time a content request is made, your
distribution pulls, serves, and caches it from the origin.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"distributionName"`: The name of the distribution for which to reset cache. Use the
GetDistributions action to get a list of distribution names that you can specify.
"""
function reset_distribution_cache(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"ResetDistributionCache"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function reset_distribution_cache(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"ResetDistributionCache",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_contact_method_verification(protocol)
send_contact_method_verification(protocol, params::Dict{String,<:Any})
Sends a verification request to an email contact method to ensure it's owned by the
requester. SMS contact methods don't need to be verified. A contact method is used to send
you notifications about your Amazon Lightsail resources. You can add one email address and
one mobile phone number contact method in each Amazon Web Services Region. However, SMS
text messaging is not supported in some Amazon Web Services Regions, and SMS text messages
cannot be sent to some countries/regions. For more information, see Notifications in Amazon
Lightsail. A verification request is sent to the contact method when you initially create
it. Use this action to send another verification request if a previous verification request
was deleted, or has expired. Notifications are not sent to an email contact method until
after it is verified, and confirmed as valid.
# Arguments
- `protocol`: The protocol to verify, such as Email or SMS (text messaging).
"""
function send_contact_method_verification(
protocol; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"SendContactMethodVerification",
Dict{String,Any}("protocol" => protocol);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_contact_method_verification(
protocol,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"SendContactMethodVerification",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("protocol" => protocol), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_ip_address_type(ip_address_type, resource_name, resource_type)
set_ip_address_type(ip_address_type, resource_name, resource_type, params::Dict{String,<:Any})
Sets the IP address type for an Amazon Lightsail resource. Use this action to enable
dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource.
Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
# Arguments
- `ip_address_type`: The IP address type to set for the specified resource. The possible
values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
- `resource_name`: The name of the resource for which to set the IP address type.
- `resource_type`: The resource type. The resource values are Distribution, Instance, and
LoadBalancer. Distribution-related APIs are available only in the N. Virginia (us-east-1)
Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1
to create, view, or edit distributions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"acceptBundleUpdate"`: Required parameter to accept the instance bundle update when
changing to, and from, IPv6-only. An instance bundle will change when switching from
dual-stack or ipv4, to ipv6. It also changes when switching from ipv6, to dual-stack or
ipv4. You must include this parameter in the command to update the bundle. For example, if
you switch from dual-stack to ipv6, the bundle will be updated, and billing for the
IPv6-only instance bundle begins immediately.
"""
function set_ip_address_type(
ipAddressType,
resourceName,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"SetIpAddressType",
Dict{String,Any}(
"ipAddressType" => ipAddressType,
"resourceName" => resourceName,
"resourceType" => resourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_ip_address_type(
ipAddressType,
resourceName,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"SetIpAddressType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ipAddressType" => ipAddressType,
"resourceName" => resourceName,
"resourceType" => resourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_resource_access_for_bucket(access, bucket_name, resource_name)
set_resource_access_for_bucket(access, bucket_name, resource_name, params::Dict{String,<:Any})
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same
Amazon Web Services Region.
# Arguments
- `access`: The access setting. The following access settings are available: allow -
Allows access to the bucket and its objects. deny - Denies access to the bucket and its
objects. Use this setting to remove access for a resource previously set to allow.
- `bucket_name`: The name of the bucket for which to set access to another Lightsail
resource.
- `resource_name`: The name of the Lightsail instance for which to set bucket access. The
instance must be in a running or stopped state.
"""
function set_resource_access_for_bucket(
access, bucketName, resourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"SetResourceAccessForBucket",
Dict{String,Any}(
"access" => access, "bucketName" => bucketName, "resourceName" => resourceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_resource_access_for_bucket(
access,
bucketName,
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"SetResourceAccessForBucket",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"access" => access,
"bucketName" => bucketName,
"resourceName" => resourceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
setup_instance_https(certificate_provider, domain_names, email_address, instance_name)
setup_instance_https(certificate_provider, domain_names, email_address, instance_name, params::Dict{String,<:Any})
Creates an SSL/TLS certificate that secures traffic for your website. After the certificate
is created, it is installed on the specified Lightsail instance. If you provide more than
one domain name in the request, at least one name must be less than or equal to 63
characters in length.
# Arguments
- `certificate_provider`: The certificate authority that issues the SSL/TLS certificate.
- `domain_names`: The name of the domain and subdomains that were specified for the SSL/TLS
certificate.
- `email_address`: The contact method for SSL/TLS certificate renewal alerts. You can enter
one email address.
- `instance_name`: The name of the Lightsail instance.
"""
function setup_instance_https(
certificateProvider,
domainNames,
emailAddress,
instanceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"SetupInstanceHttps",
Dict{String,Any}(
"certificateProvider" => certificateProvider,
"domainNames" => domainNames,
"emailAddress" => emailAddress,
"instanceName" => instanceName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function setup_instance_https(
certificateProvider,
domainNames,
emailAddress,
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"SetupInstanceHttps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateProvider" => certificateProvider,
"domainNames" => domainNames,
"emailAddress" => emailAddress,
"instanceName" => instanceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_guisession(resource_name)
start_guisession(resource_name, params::Dict{String,<:Any})
Initiates a graphical user interface (GUI) session that’s used to access a virtual
computer’s operating system and application. The session will be active for 1 hour. Use
this action to resume the session after it expires.
# Arguments
- `resource_name`: The resource name.
"""
function start_guisession(resourceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"StartGUISession",
Dict{String,Any}("resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_guisession(
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"StartGUISession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceName" => resourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_instance(instance_name)
start_instance(instance_name, params::Dict{String,<:Any})
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance,
use the reboot instance operation. When you start a stopped instance, Lightsail assigns a
new public IP address to the instance. To use the same IP address after stopping and
starting an instance, create a static IP address and attach it to the instance. For more
information, see the Amazon Lightsail Developer Guide. The start instance operation
supports tag-based access control via resource tags applied to the resource identified by
instance name. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The name of the instance (a virtual private server) to start.
"""
function start_instance(instanceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"StartInstance",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_instance(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"StartInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_relational_database(relational_database_name)
start_relational_database(relational_database_name, params::Dict{String,<:Any})
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database,
use the reboot relational database operation. The start relational database operation
supports tag-based access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `relational_database_name`: The name of your database to start.
"""
function start_relational_database(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"StartRelationalDatabase",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_relational_database(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"StartRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_guisession(resource_name)
stop_guisession(resource_name, params::Dict{String,<:Any})
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s
operating system or application. The session will close and any unsaved data will be lost.
# Arguments
- `resource_name`: The resource name.
"""
function stop_guisession(resourceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"StopGUISession",
Dict{String,Any}("resourceName" => resourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_guisession(
resourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"StopGUISession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceName" => resourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_instance(instance_name)
stop_instance(instance_name, params::Dict{String,<:Any})
Stops a specific Amazon Lightsail instance that is currently running. When you start a
stopped instance, Lightsail assigns a new public IP address to the instance. To use the
same IP address after stopping and starting an instance, create a static IP address and
attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance operation supports tag-based access control via resource tags applied to
the resource identified by instance name. For more information, see the Amazon Lightsail
Developer Guide.
# Arguments
- `instance_name`: The name of the instance (a virtual private server) to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: When set to True, forces a Lightsail instance that is stuck in a stopping
state to stop. Only use the force parameter if your instance is stuck in the stopping
state. In any other state, your instance should stop normally without adding this parameter
to your API request.
"""
function stop_instance(instanceName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"StopInstance",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_instance(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"StopInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_relational_database(relational_database_name)
stop_relational_database(relational_database_name, params::Dict{String,<:Any})
Stops a specific database that is currently running in Amazon Lightsail. The stop
relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `relational_database_name`: The name of your database to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"relationalDatabaseSnapshotName"`: The name of your new database snapshot to be created
before stopping your database.
"""
function stop_relational_database(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"StopRelationalDatabase",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_relational_database(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"StopRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_name, tags)
tag_resource(resource_name, tags, params::Dict{String,<:Any})
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a
maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be
unique per resource. For more information about tags, see the Amazon Lightsail Developer
Guide. The tag resource operation supports tag-based access control via request tags and
resource tags applied to the resource identified by resource name. For more information,
see the Amazon Lightsail Developer Guide.
# Arguments
- `resource_name`: The name of the resource to which you are adding tags.
- `tags`: The tag key and optional value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceArn"`: The Amazon Resource Name (ARN) of the resource to which you want to add
a tag.
"""
function tag_resource(resourceName, tags; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"TagResource",
Dict{String,Any}("resourceName" => resourceName, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceName,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceName" => resourceName, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_alarm(alarm_name, state)
test_alarm(alarm_name, state, params::Dict{String,<:Any})
Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification
trigger is configured for the specified alarm, the test also sends a notification to the
notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to
monitor a single metric for one of your resources. When a metric condition is met, the
alarm can notify you by email, SMS text message, and a banner displayed on the Amazon
Lightsail console. For more information, see Alarms in Amazon Lightsail.
# Arguments
- `alarm_name`: The name of the alarm to test.
- `state`: The alarm state to test. An alarm has the following possible states that can be
tested: ALARM - The metric is outside of the defined threshold. INSUFFICIENT_DATA -
The alarm has just started, the metric is not available, or not enough data is available
for the metric to determine the alarm state. OK - The metric is within the defined
threshold.
"""
function test_alarm(alarmName, state; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"TestAlarm",
Dict{String,Any}("alarmName" => alarmName, "state" => state);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_alarm(
alarmName,
state,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"TestAlarm",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("alarmName" => alarmName, "state" => state), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unpeer_vpc()
unpeer_vpc(params::Dict{String,<:Any})
Unpeers the Lightsail VPC from the user's default VPC.
"""
function unpeer_vpc(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail("UnpeerVpc"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function unpeer_vpc(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UnpeerVpc", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
untag_resource(resource_name, tag_keys)
untag_resource(resource_name, tag_keys, params::Dict{String,<:Any})
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail
resource. The untag resource operation supports tag-based access control via request tags
and resource tags applied to the resource identified by resource name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `resource_name`: The name of the resource from which you are removing a tag.
- `tag_keys`: The tag keys to delete from the specified resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceArn"`: The Amazon Resource Name (ARN) of the resource from which you want to
remove a tag.
"""
function untag_resource(
resourceName, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UntagResource",
Dict{String,Any}("resourceName" => resourceName, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceName,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceName" => resourceName, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bucket(bucket_name)
update_bucket(bucket_name, params::Dict{String,<:Any})
Updates an existing Amazon Lightsail bucket. Use this action to update the configuration of
an existing bucket, such as versioning, public accessibility, and the Amazon Web Services
accounts that can access the bucket.
# Arguments
- `bucket_name`: The name of the bucket to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accessLogConfig"`: An object that describes the access log configuration for the bucket.
- `"accessRules"`: An object that sets the public accessibility of objects in the specified
bucket.
- `"readonlyAccessAccounts"`: An array of strings to specify the Amazon Web Services
account IDs that can access the bucket. You can give a maximum of 10 Amazon Web Services
accounts access to a bucket.
- `"versioning"`: Specifies whether to enable or suspend versioning of objects in the
bucket. The following options can be specified: Enabled - Enables versioning of objects
in the specified bucket. Suspended - Suspends versioning of objects in the specified
bucket. Existing object versions are retained.
"""
function update_bucket(bucketName; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"UpdateBucket",
Dict{String,Any}("bucketName" => bucketName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bucket(
bucketName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateBucket",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("bucketName" => bucketName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bucket_bundle(bucket_name, bundle_id)
update_bucket_bundle(bucket_name, bundle_id, params::Dict{String,<:Any})
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A bucket
bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You
can update a bucket's bundle only one time within a monthly Amazon Web Services billing
cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The
ableToUpdateBundle parameter in the response will indicate whether you can currently update
a bucket's bundle. Update a bucket's bundle if it's consistently going over its storage
space or data transfer quota, or if a bucket's usage is consistently in the lower range of
its storage space or data transfer quota. Due to the unpredictable usage fluctuations that
a bucket might experience, we strongly recommend that you update a bucket's bundle only as
a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a
bucket bundle that will provide the bucket with ample storage space and data transfer for a
long time to come.
# Arguments
- `bucket_name`: The name of the bucket for which to update the bundle.
- `bundle_id`: The ID of the new bundle to apply to the bucket. Use the GetBucketBundles
action to get a list of bundle IDs that you can specify.
"""
function update_bucket_bundle(
bucketName, bundleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateBucketBundle",
Dict{String,Any}("bucketName" => bucketName, "bundleId" => bundleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bucket_bundle(
bucketName,
bundleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateBucketBundle",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("bucketName" => bucketName, "bundleId" => bundleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_container_service(service_name)
update_container_service(service_name, params::Dict{String,<:Any})
Updates the configuration of your Amazon Lightsail container service, such as its power,
scale, and public domain names.
# Arguments
- `service_name`: The name of the container service to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isDisabled"`: A Boolean value to indicate whether the container service is disabled.
- `"power"`: The power for the container service. The power specifies the amount of memory,
vCPUs, and base monthly cost of each node of the container service. The power and scale of
a container service makes up its configured capacity. To determine the monthly price of
your container service, multiply the base price of the power with the scale (the number of
nodes) of the service. Use the GetContainerServicePowers action to view the specifications
of each power option.
- `"privateRegistryAccess"`: An object to describe the configuration for the container
service to access private container image repositories, such as Amazon Elastic Container
Registry (Amazon ECR) private repositories. For more information, see Configuring access to
an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon
Lightsail Developer Guide.
- `"publicDomainNames"`: The public domain names to use with the container service, such as
example.com and www.example.com. You can specify up to four public domain names for a
container service. The domain names that you specify are used when you create a deployment
with a container configured as the public endpoint of your container service. If you don't
specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names
with your container service. Use the CreateCertificate action to create a certificate for
the public domain names you want to use with your container service. You can specify
public domain names using a string to array map as shown in the example later on this page.
- `"scale"`: The scale for the container service. The scale specifies the allocated compute
nodes of the container service. The power and scale of a container service makes up its
configured capacity. To determine the monthly price of your container service, multiply the
base price of the power with the scale (the number of nodes) of the service.
"""
function update_container_service(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateContainerService",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_container_service(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateContainerService",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_distribution(distribution_name)
update_distribution(distribution_name, params::Dict{String,<:Any})
Updates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this
action to update the configuration of your existing distribution.
# Arguments
- `distribution_name`: The name of the distribution to update. Use the GetDistributions
action to get a list of distribution names that you can specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cacheBehaviorSettings"`: An object that describes the cache behavior settings for the
distribution. The cacheBehaviorSettings specified in your UpdateDistributionRequest will
replace your distribution's existing settings.
- `"cacheBehaviors"`: An array of objects that describe the per-path cache behavior for the
distribution.
- `"certificateName"`: The name of the SSL/TLS certificate that you want to attach to the
distribution. Only certificates with a status of ISSUED can be attached to a distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
- `"defaultCacheBehavior"`: An object that describes the default cache behavior for the
distribution.
- `"isEnabled"`: Indicates whether to enable the distribution.
- `"origin"`: An object that describes the origin resource for the distribution, such as a
Lightsail instance, bucket, or load balancer. The distribution pulls, caches, and serves
content from the origin.
- `"useDefaultCertificate"`: Indicates whether the default SSL/TLS certificate is attached
to the distribution. The default value is true. When true, the distribution uses the
default domain name such as d111111abcdef8.cloudfront.net. Set this value to false to
attach a new certificate to the distribution.
- `"viewerMinimumTlsProtocolVersion"`: Use this parameter to update the minimum TLS
protocol version for the SSL/TLS certificate that's attached to the distribution.
"""
function update_distribution(
distributionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateDistribution",
Dict{String,Any}("distributionName" => distributionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_distribution(
distributionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateDistribution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("distributionName" => distributionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_distribution_bundle()
update_distribution_bundle(params::Dict{String,<:Any})
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A
distribution bundle specifies the monthly network transfer quota and monthly cost of your
distribution. Update your distribution's bundle if your distribution is going over its
monthly network transfer quota and is incurring an overage fee. You can update your
distribution's bundle only one time within your monthly Amazon Web Services billing cycle.
To determine if you can update your distribution's bundle, use the GetDistributions action.
The ableToUpdateBundle parameter in the result will indicate whether you can currently
update your distribution's bundle.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bundleId"`: The bundle ID of the new bundle to apply to your distribution. Use the
GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
- `"distributionName"`: The name of the distribution for which to update the bundle. Use
the GetDistributions action to get a list of distribution names that you can specify.
"""
function update_distribution_bundle(; aws_config::AbstractAWSConfig=global_aws_config())
return lightsail(
"UpdateDistributionBundle"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_distribution_bundle(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateDistributionBundle",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain_entry(domain_entry, domain_name)
update_domain_entry(domain_entry, domain_name, params::Dict{String,<:Any})
Updates a domain recordset after it is created. The update domain entry operation supports
tag-based access control via resource tags applied to the resource identified by domain
name. For more information, see the Amazon Lightsail Developer Guide.
# Arguments
- `domain_entry`: An array of key-value pairs containing information about the domain entry.
- `domain_name`: The name of the domain recordset to update.
"""
function update_domain_entry(
domainEntry, domainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateDomainEntry",
Dict{String,Any}("domainEntry" => domainEntry, "domainName" => domainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain_entry(
domainEntry,
domainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateDomainEntry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domainEntry" => domainEntry, "domainName" => domainName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance_metadata_options(instance_name)
update_instance_metadata_options(instance_name, params::Dict{String,<:Any})
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped
instance. When you modify the parameters on a running instance, the GetInstance or
GetInstances API operation initially responds with a state of pending. After the parameter
modifications are successfully applied, the state changes to applied in subsequent
GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon
Lightsail instance in the Amazon Lightsail Developer Guide.
# Arguments
- `instance_name`: The name of the instance for which to update metadata parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"httpEndpoint"`: Enables or disables the HTTP metadata endpoint on your instances. If
this parameter is not specified, the existing state is maintained. If you specify a value
of disabled, you cannot access your instance metadata.
- `"httpProtocolIpv6"`: Enables or disables the IPv6 endpoint for the instance metadata
service. This setting applies only when the HTTP metadata endpoint is enabled. This
parameter is available only for instances in the Europe (Stockholm) Amazon Web Services
Region (eu-north-1).
- `"httpPutResponseHopLimit"`: The desired HTTP PUT response hop limit for instance
metadata requests. A larger number means that the instance metadata requests can travel
farther. If no parameter is specified, the existing state is maintained.
- `"httpTokens"`: The state of token usage for your instance metadata requests. If the
parameter is not specified in the request, the default state is optional. If the state is
optional, you can choose whether to retrieve instance metadata with a signed token header
on your request. If you retrieve the IAM role credentials without a token, the version 1.0
role credentials are returned. If you retrieve the IAM role credentials by using a valid
signed token, the version 2.0 role credentials are returned. If the state is required, you
must send a signed token header with all instance metadata retrieval requests. In this
state, retrieving the IAM role credential always returns the version 2.0 credentials. The
version 1.0 credentials are not available.
"""
function update_instance_metadata_options(
instanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateInstanceMetadataOptions",
Dict{String,Any}("instanceName" => instanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance_metadata_options(
instanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateInstanceMetadataOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceName" => instanceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_load_balancer_attribute(attribute_name, attribute_value, load_balancer_name)
update_load_balancer_attribute(attribute_name, attribute_value, load_balancer_name, params::Dict{String,<:Any})
Updates the specified attribute for a load balancer. You can only update one attribute at a
time. The update load balancer attribute operation supports tag-based access control via
resource tags applied to the resource identified by load balancer name. For more
information, see the Amazon Lightsail Developer Guide.
# Arguments
- `attribute_name`: The name of the attribute you want to update.
- `attribute_value`: The value that you want to specify for the attribute name. The
following values are supported depending on what you specify for the attributeName request
parameter: If you specify HealthCheckPath for the attributeName request parameter, then
the attributeValue request parameter must be the path to ping on the target (for example,
/weather/us/wa/seattle). If you specify SessionStickinessEnabled for the attributeName
request parameter, then the attributeValue request parameter must be true to activate
session stickiness or false to deactivate session stickiness. If you specify
SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then
the attributeValue request parameter must be an interger that represents the cookie
duration in seconds. If you specify HttpsRedirectionEnabled for the attributeName request
parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS
redirection or false to deactivate HTTP to HTTPS redirection. If you specify
TlsPolicyName for the attributeName request parameter, then the attributeValue request
parameter must be the name of the TLS policy. Use the GetLoadBalancerTlsPolicies action to
get a list of TLS policy names that you can specify.
- `load_balancer_name`: The name of the load balancer that you want to modify
(my-load-balancer.
"""
function update_load_balancer_attribute(
attributeName,
attributeValue,
loadBalancerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateLoadBalancerAttribute",
Dict{String,Any}(
"attributeName" => attributeName,
"attributeValue" => attributeValue,
"loadBalancerName" => loadBalancerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_load_balancer_attribute(
attributeName,
attributeValue,
loadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateLoadBalancerAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"attributeName" => attributeName,
"attributeValue" => attributeValue,
"loadBalancerName" => loadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_relational_database(relational_database_name)
update_relational_database(relational_database_name, params::Dict{String,<:Any})
Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are
applied immediately, or in cases where the updates could result in an outage, are applied
during the database's predefined maintenance window. The update relational database
operation supports tag-based access control via resource tags applied to the resource
identified by relationalDatabaseName. For more information, see the Amazon Lightsail
Developer Guide.
# Arguments
- `relational_database_name`: The name of your Lightsail database resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applyImmediately"`: When true, applies changes immediately. When false, applies changes
during the preferred maintenance window. Some changes may cause an outage. Default: false
- `"caCertificateIdentifier"`: Indicates the certificate that needs to be associated with
the database.
- `"disableBackupRetention"`: When true, disables automated backup retention for your
database. Disabling backup retention deletes all automated database backups. Before
disabling this, you may want to create a snapshot of your database using the create
relational database snapshot operation. Updates are applied during the next maintenance
window because this can result in an outage.
- `"enableBackupRetention"`: When true, enables automated backup retention for your
database. Updates are applied during the next maintenance window because this can result in
an outage.
- `"masterUserPassword"`: The password for the master user. The password can include any
printable ASCII character except \"/\", \"\"\", or \"@\". MySQL Constraints: Must contain
from 8 to 41 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters.
- `"preferredBackupWindow"`: The daily time range during which automated backups are
created for your database if automated backups are enabled. Constraints: Must be in the
hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Coordinated Universal Time
(UTC). Must not conflict with the preferred maintenance window. Must be at least 30
minutes.
- `"preferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur on your database. The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed,
Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Coordinated Universal
Time (UTC). Example: Tue:17:00-Tue:17:30
- `"publiclyAccessible"`: Specifies the accessibility options for your database. A value of
true specifies a database that is available to resources outside of your Lightsail account.
A value of false specifies a database that is available only to your Lightsail resources in
the same region as your database.
- `"relationalDatabaseBlueprintId"`: This parameter is used to update the major version of
the database. Enter the blueprintId for the major version that you want to update to. Use
the GetRelationalDatabaseBlueprints action to get a list of available blueprint IDs.
- `"rotateMasterUserPassword"`: When true, the master user password is changed to a new
strong password generated by Lightsail. Use the get relational database master user
password operation to get the new password.
"""
function update_relational_database(
relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateRelationalDatabase",
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_relational_database(
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateRelationalDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("relationalDatabaseName" => relationalDatabaseName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_relational_database_parameters(parameters, relational_database_name)
update_relational_database_parameters(parameters, relational_database_name, params::Dict{String,<:Any})
Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter
updates don't cause outages; therefore, their application is not subject to the preferred
maintenance window. However, there are two ways in which parameter updates are applied:
dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied
immediately. Parameters marked with a pending-reboot apply type are applied only after the
database is rebooted using the reboot relational database operation. The update relational
database parameters operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon
Lightsail Developer Guide.
# Arguments
- `parameters`: The database parameters to update.
- `relational_database_name`: The name of your database for which to update parameters.
"""
function update_relational_database_parameters(
parameters, relationalDatabaseName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lightsail(
"UpdateRelationalDatabaseParameters",
Dict{String,Any}(
"parameters" => parameters, "relationalDatabaseName" => relationalDatabaseName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_relational_database_parameters(
parameters,
relationalDatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lightsail(
"UpdateRelationalDatabaseParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"parameters" => parameters,
"relationalDatabaseName" => relationalDatabaseName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 113628 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: location
using AWS.Compat
using AWS.UUIDs
"""
associate_tracker_consumer(consumer_arn, tracker_name)
associate_tracker_consumer(consumer_arn, tracker_name, params::Dict{String,<:Any})
Creates an association between a geofence collection and a tracker resource. This allows
the tracker resource to communicate location data to the linked geofence collection. You
can associate up to five geofence collections to each tracker resource. Currently not
supported — Cross-account configurations, such as creating associations between a tracker
resource in one account and a geofence collection in another account.
# Arguments
- `consumer_arn`: The Amazon Resource Name (ARN) for the geofence collection to be
associated to tracker resource. Used when you need to specify a resource across all Amazon
Web Services. Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
- `tracker_name`: The name of the tracker resource to be associated with a geofence
collection.
"""
function associate_tracker_consumer(
ConsumerArn, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/consumers",
Dict{String,Any}("ConsumerArn" => ConsumerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_tracker_consumer(
ConsumerArn,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/consumers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConsumerArn" => ConsumerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_device_position_history(device_ids, tracker_name)
batch_delete_device_position_history(device_ids, tracker_name, params::Dict{String,<:Any})
Deletes the position history of one or more devices from a tracker resource.
# Arguments
- `device_ids`: Devices whose position history you want to delete. For example, for two
devices: “DeviceIds” : [DeviceId1,DeviceId2]
- `tracker_name`: The name of the tracker resource to delete the device position history
from.
"""
function batch_delete_device_position_history(
DeviceIds, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/delete-positions",
Dict{String,Any}("DeviceIds" => DeviceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_device_position_history(
DeviceIds,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/delete-positions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeviceIds" => DeviceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_geofence(collection_name, geofence_ids)
batch_delete_geofence(collection_name, geofence_ids, params::Dict{String,<:Any})
Deletes a batch of geofences from a geofence collection. This operation deletes the
resource permanently.
# Arguments
- `collection_name`: The geofence collection storing the geofences to be deleted.
- `geofence_ids`: The batch of geofences to be deleted.
"""
function batch_delete_geofence(
CollectionName, GeofenceIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/delete-geofences",
Dict{String,Any}("GeofenceIds" => GeofenceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_geofence(
CollectionName,
GeofenceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/delete-geofences",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GeofenceIds" => GeofenceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_evaluate_geofences(collection_name, device_position_updates)
batch_evaluate_geofences(collection_name, device_position_updates, params::Dict{String,<:Any})
Evaluates device positions against the geofence geometries from a given geofence
collection. This operation always returns an empty response because geofences are
asynchronously evaluated. The evaluation determines if the device has entered or exited a
geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
The last geofence that a device was observed within is tracked for 30 days after the most
recent device position update. Geofence evaluation uses the given device position. It
does not account for the optional Accuracy of a DevicePositionUpdate. The DeviceID is
used as a string to represent the device. You do not need to have a Tracker associated with
the DeviceID.
# Arguments
- `collection_name`: The geofence collection used in evaluating the position of devices
against its geofences.
- `device_position_updates`: Contains device details for each device to be evaluated
against the given geofence collection.
"""
function batch_evaluate_geofences(
CollectionName, DevicePositionUpdates; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/positions",
Dict{String,Any}("DevicePositionUpdates" => DevicePositionUpdates);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_evaluate_geofences(
CollectionName,
DevicePositionUpdates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/positions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DevicePositionUpdates" => DevicePositionUpdates),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_device_position(device_ids, tracker_name)
batch_get_device_position(device_ids, tracker_name, params::Dict{String,<:Any})
Lists the latest device positions for requested devices.
# Arguments
- `device_ids`: Devices whose position you want to retrieve. For example, for two
devices: device-ids=DeviceId1&device-ids=DeviceId2
- `tracker_name`: The tracker resource retrieving the device position.
"""
function batch_get_device_position(
DeviceIds, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/get-positions",
Dict{String,Any}("DeviceIds" => DeviceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_device_position(
DeviceIds,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/get-positions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeviceIds" => DeviceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_geofence(collection_name, entries)
batch_put_geofence(collection_name, entries, params::Dict{String,<:Any})
A batch request for storing geofence geometries into a given geofence collection, or
updates the geometry of an existing geofence if a geofence ID is included in the request.
# Arguments
- `collection_name`: The geofence collection storing the geofences.
- `entries`: The batch of geofences to be stored in a geofence collection.
"""
function batch_put_geofence(
CollectionName, Entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/put-geofences",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_geofence(
CollectionName,
Entries,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/put-geofences",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_device_position(tracker_name, updates)
batch_update_device_position(tracker_name, updates, params::Dict{String,<:Any})
Uploads position update data for one or more devices to a tracker resource (up to 10
devices per batch). Amazon Location uses the data when it reports the last known device
position and position history. Amazon Location retains location data for 30 days. Position
updates are handled based on the PositionFiltering property of the tracker. When
PositionFiltering is set to TimeBased, updates are evaluated against linked geofence
collections, and location data is stored at a maximum of one position per 30 second
interval. If your update frequency is more often than every 30 seconds, only one update per
30 seconds is stored for each unique device ID. When PositionFiltering is set to
DistanceBased filtering, location data is stored and evaluated against linked geofence
collections only if the device has moved more than 30 m (98.4 ft). When PositionFiltering
is set to AccuracyBased filtering, location data is stored and evaluated against linked
geofence collections only if the device has moved more than the measured accuracy. For
example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10
m, the second update is neither stored or evaluated if the device has moved less than 15 m.
If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default
value { \"Horizontal\": 0} when accuracy is not provided on a DevicePositionUpdate.
# Arguments
- `tracker_name`: The name of the tracker resource to update.
- `updates`: Contains the position update details for each device, up to 10 devices.
"""
function batch_update_device_position(
TrackerName, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/positions",
Dict{String,Any}("Updates" => Updates);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_device_position(
TrackerName,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/positions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Updates" => Updates), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
calculate_route(calculator_name, departure_position, destination_position)
calculate_route(calculator_name, departure_position, destination_position, params::Dict{String,<:Any})
Calculates a route given the following required parameters: DeparturePosition and
DestinationPosition. Requires that you first create a route calculator resource. By
default, a request that doesn't specify a departure time uses the best time of day to
travel with the best traffic conditions when calculating the route. Additional options
include: Specifying a departure time using either DepartureTime or DepartNow. This
calculates a route based on predictive traffic data at the given time. You can't specify
both DepartureTime and DepartNow in a single request. Specifying both parameters returns a
validation error. Specifying a travel mode using TravelMode sets the transportation
mode used to calculate the routes. This also lets you specify additional route preferences
in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck. If you
specify walking for the travel mode and your data provider is Esri, the start and
destination must be within 40km.
# Arguments
- `calculator_name`: The name of the route calculator resource that you want to use to
calculate the route.
- `departure_position`: The start position for the route. Defined in World Geodetic System
(WGS 84) format: [longitude, latitude]. For example, [-123.115, 49.285] If you
specify a departure that's not located on a road, Amazon Location moves the position to the
nearest road. If Esri is the provider for your route calculator, specifying a route that is
longer than 400 km returns a 400 RoutesValidationException error. Valid Values: [-180 to
180,-90 to 90]
- `destination_position`: The finish position for the route. Defined in World Geodetic
System (WGS 84) format: [longitude, latitude]. For example, [-122.339, 47.615] If
you specify a destination that's not located on a road, Amazon Location moves the position
to the nearest road. Valid Values: [-180 to 180,-90 to 90]
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArrivalTime"`: Specifies the desired time of arrival. Uses the given time to calculate
the route. Otherwise, the best time of day to travel with the best traffic conditions is
used to calculate the route. ArrivalTime is not supported Esri.
- `"CarModeOptions"`: Specifies route preferences when traveling by Car, such as avoiding
routes that use ferries or tolls. Requirements: TravelMode must be specified as Car.
- `"DepartNow"`: Sets the time of departure as the current time. Uses the current time to
calculate a route. Otherwise, the best time of day to travel with the best traffic
conditions is used to calculate the route. Default Value: false Valid Values: false | true
- `"DepartureTime"`: Specifies the desired time of departure. Uses the given time to
calculate the route. Otherwise, the best time of day to travel with the best traffic
conditions is used to calculate the route. In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
- `"DistanceUnit"`: Set the unit system to specify the distance. Default Value: Kilometers
- `"IncludeLegGeometry"`: Set to include the geometry details in the result for each path
between a pair of positions. Default Value: false Valid Values: false | true
- `"OptimizeFor"`: Specifies the distance to optimize for when calculating a route.
- `"TravelMode"`: Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking,
Bicycle or Motorcycle as options for the TravelMode. Bicycle and Motorcycle are only
valid when using Grab as a data provider, and only within Southeast Asia. Truck is not
available for Grab. For more details on the using Grab for routing, including areas of
coverage, see GrabMaps in the Amazon Location Service Developer Guide. The TravelMode you
specify also determines how you specify route preferences: If traveling by Car use the
CarModeOptions parameter. If traveling by Truck use the TruckModeOptions parameter.
Default Value: Car
- `"TruckModeOptions"`: Specifies route preferences when traveling by Truck, such as
avoiding routes that use ferries or tolls, and truck specifications to consider when
choosing an optimal road. Requirements: TravelMode must be specified as Truck.
- `"WaypointPositions"`: Specifies an ordered list of up to 23 intermediate positions to
include along a route between the departure position and destination position. For
example, from the DeparturePosition [-123.115, 49.285], the route follows the order that
the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]] If you
specify a waypoint position that's not located on a road, Amazon Location moves the
position to the nearest road. Specifying more than 23 waypoints returns a 400
ValidationException error. If Esri is the provider for your route calculator, specifying a
route that is longer than 400 km returns a 400 RoutesValidationException error. Valid
Values: [-180 to 180,-90 to 90]
- `"key"`: The optional API key to authorize the request.
"""
function calculate_route(
CalculatorName,
DeparturePosition,
DestinationPosition;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/routes/v0/calculators/$(CalculatorName)/calculate/route",
Dict{String,Any}(
"DeparturePosition" => DeparturePosition,
"DestinationPosition" => DestinationPosition,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function calculate_route(
CalculatorName,
DeparturePosition,
DestinationPosition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/routes/v0/calculators/$(CalculatorName)/calculate/route",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeparturePosition" => DeparturePosition,
"DestinationPosition" => DestinationPosition,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
calculate_route_matrix(calculator_name, departure_positions, destination_positions)
calculate_route_matrix(calculator_name, departure_positions, destination_positions, params::Dict{String,<:Any})
Calculates a route matrix given the following required parameters: DeparturePositions and
DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel time
and travel distance from each departure position to each destination position in the
request. For example, given departure positions A and B, and destination positions X and Y,
CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X,
and B to Y (in that order). The number of results returned (and routes calculated) will be
the number of DeparturePositions times the number of DestinationPositions. Your account is
charged for each route calculated, not the number of requests. Requires that you first
create a route calculator resource. By default, a request that doesn't specify a departure
time uses the best time of day to travel with the best traffic conditions when calculating
routes. Additional options include: Specifying a departure time using either
DepartureTime or DepartNow. This calculates routes based on predictive traffic data at the
given time. You can't specify both DepartureTime and DepartNow in a single request.
Specifying both parameters returns a validation error. Specifying a travel mode using
TravelMode sets the transportation mode used to calculate the routes. This also lets you
specify additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
# Arguments
- `calculator_name`: The name of the route calculator resource that you want to use to
calculate the route matrix.
- `departure_positions`: The list of departure (origin) positions for the route matrix. An
array of points, each of which is itself a 2-value array defined in WGS 84 format:
[longitude, latitude]. For example, [-123.115, 49.285]. Depending on the data provider
selected in the route calculator resource there may be additional restrictions on the
inputs you can choose. See Position restrictions in the Amazon Location Service Developer
Guide. For route calculators that use Esri as the data provider, if you specify a
departure that's not located on a road, Amazon Location moves the position to the nearest
road. The snapped value is available in the result in SnappedDeparturePositions. Valid
Values: [-180 to 180,-90 to 90]
- `destination_positions`: The list of destination positions for the route matrix. An array
of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude,
latitude]. For example, [-122.339, 47.615] Depending on the data provider selected in the
route calculator resource there may be additional restrictions on the inputs you can
choose. See Position restrictions in the Amazon Location Service Developer Guide. For
route calculators that use Esri as the data provider, if you specify a destination that's
not located on a road, Amazon Location moves the position to the nearest road. The snapped
value is available in the result in SnappedDestinationPositions. Valid Values: [-180 to
180,-90 to 90]
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CarModeOptions"`: Specifies route preferences when traveling by Car, such as avoiding
routes that use ferries or tolls. Requirements: TravelMode must be specified as Car.
- `"DepartNow"`: Sets the time of departure as the current time. Uses the current time to
calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is
set, the best time of day to travel with the best traffic conditions is used to calculate
the route matrix. Default Value: false Valid Values: false | true
- `"DepartureTime"`: Specifies the desired time of departure. Uses the given time to
calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is
set, the best time of day to travel with the best traffic conditions is used to calculate
the route matrix. Setting a departure time in the past returns a 400 ValidationException
error. In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example,
2020–07-2T12:15:20.000Z+01:00
- `"DistanceUnit"`: Set the unit system to specify the distance. Default Value: Kilometers
- `"TravelMode"`: Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility. The TravelMode you specify also
determines how you specify route preferences: If traveling by Car use the CarModeOptions
parameter. If traveling by Truck use the TruckModeOptions parameter. Bicycle or
Motorcycle are only valid when using Grab as a data provider, and only within Southeast
Asia. Truck is not available for Grab. For more information about using Grab as a data
provider, see GrabMaps in the Amazon Location Service Developer Guide. Default Value: Car
- `"TruckModeOptions"`: Specifies route preferences when traveling by Truck, such as
avoiding routes that use ferries or tolls, and truck specifications to consider when
choosing an optimal road. Requirements: TravelMode must be specified as Truck.
- `"key"`: The optional API key to authorize the request.
"""
function calculate_route_matrix(
CalculatorName,
DeparturePositions,
DestinationPositions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/routes/v0/calculators/$(CalculatorName)/calculate/route-matrix",
Dict{String,Any}(
"DeparturePositions" => DeparturePositions,
"DestinationPositions" => DestinationPositions,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function calculate_route_matrix(
CalculatorName,
DeparturePositions,
DestinationPositions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/routes/v0/calculators/$(CalculatorName)/calculate/route-matrix",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeparturePositions" => DeparturePositions,
"DestinationPositions" => DestinationPositions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_geofence_collection(collection_name)
create_geofence_collection(collection_name, params::Dict{String,<:Any})
Creates a geofence collection, which manages and stores geofences.
# Arguments
- `collection_name`: A custom name for the geofence collection. Requirements: Contain
only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and
underscores (_). Must be a unique geofence collection name. No spaces allowed. For
example, ExampleGeofenceCollection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for the geofence collection.
- `"KmsKeyId"`: A key identifier for an Amazon Web Services KMS customer managed key. Enter
a key ID, key ARN, alias name, or alias ARN.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"PricingPlanDataSource"`: This parameter is no longer used.
- `"Tags"`: Applies one or more tags to the geofence collection. A tag is a key-value pair
helps manage, identify, search, and filter your resources by labelling them. Format:
\"key\" : \"value\" Restrictions: Maximum 50 tags per resource Each resource tag must
be unique with a maximum of one value. Maximum key length: 128 Unicode characters in
UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric
characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot
use \"aws:\" as a prefix for a key.
"""
function create_geofence_collection(
CollectionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/geofencing/v0/collections",
Dict{String,Any}("CollectionName" => CollectionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_geofence_collection(
CollectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/geofencing/v0/collections",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionName" => CollectionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_key(key_name, restrictions)
create_key(key_name, restrictions, params::Dict{String,<:Any})
Creates an API key resource in your Amazon Web Services account, which lets you grant
actions for Amazon Location resources to the API key bearer. For more information, see
Using API keys.
# Arguments
- `key_name`: A custom name for the API key resource. Requirements: Contain only
alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores
(_). Must be a unique API key name. No spaces allowed. For example, ExampleAPIKey.
- `restrictions`: The API key restrictions for the API key resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for the API key resource.
- `"ExpireTime"`: The optional timestamp for when the API key resource will expire in ISO
8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.
- `"NoExpiry"`: Optionally set to true to set no expiration time for the API key. One of
NoExpiry or ExpireTime must be set.
- `"Tags"`: Applies one or more tags to the map resource. A tag is a key-value pair that
helps manage, identify, search, and filter your resources by labelling them. Format:
\"key\" : \"value\" Restrictions: Maximum 50 tags per resource Each resource tag must
be unique with a maximum of one value. Maximum key length: 128 Unicode characters in
UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric
characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot
use \"aws:\" as a prefix for a key.
"""
function create_key(
KeyName, Restrictions; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/metadata/v0/keys",
Dict{String,Any}("KeyName" => KeyName, "Restrictions" => Restrictions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_key(
KeyName,
Restrictions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/metadata/v0/keys",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("KeyName" => KeyName, "Restrictions" => Restrictions),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_map(configuration, map_name)
create_map(configuration, map_name, params::Dict{String,<:Any})
Creates a map resource in your Amazon Web Services account, which provides map tiles of
different styles sourced from global location data providers. If your application is
tracking or routing assets you use in your business, such as delivery vehicles or
employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon
Web Services service terms for more details.
# Arguments
- `configuration`: Specifies the MapConfiguration, including the map style, for the map
resource that you create. The map style defines the look of maps and the data provider for
your map resource.
- `map_name`: The name for the map resource. Requirements: Must contain only alphanumeric
characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be
a unique map resource name. No spaces allowed. For example, ExampleMap.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for the map resource.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"Tags"`: Applies one or more tags to the map resource. A tag is a key-value pair helps
manage, identify, search, and filter your resources by labelling them. Format: \"key\" :
\"value\" Restrictions: Maximum 50 tags per resource Each resource tag must be unique
with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters
(A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use
\"aws:\" as a prefix for a key.
"""
function create_map(
Configuration, MapName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/maps/v0/maps",
Dict{String,Any}("Configuration" => Configuration, "MapName" => MapName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_map(
Configuration,
MapName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/maps/v0/maps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Configuration" => Configuration, "MapName" => MapName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_place_index(data_source, index_name)
create_place_index(data_source, index_name, params::Dict{String,<:Any})
Creates a place index resource in your Amazon Web Services account. Use a place index
resource to geocode addresses and other text queries by using the SearchPlaceIndexForText
operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition
operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions
operation. If your application is tracking or routing assets you use in your business,
such as delivery vehicles or employees, you must not use Esri as your geolocation provider.
See section 82 of the Amazon Web Services service terms for more details.
# Arguments
- `data_source`: Specifies the geospatial data provider for the new place index. This
field is case-sensitive. Enter the valid values as shown. For example, entering HERE
returns an error. Valid values include: Esri – For additional information about
Esri's coverage in your region of interest, see Esri details on geocoding coverage. Grab
– Grab provides place index functionality for Southeast Asia. For additional information
about GrabMaps' coverage, see GrabMaps countries and areas covered. Here – For
additional information about HERE Technologies' coverage in your region of interest, see
HERE details on goecoding coverage. If you specify HERE Technologies (Here) as the data
provider, you may not store results for locations in Japan. For more information, see the
Amazon Web Services Service Terms for Amazon Location Service. For additional
information , see Data providers on the Amazon Location Service Developer Guide.
- `index_name`: The name of the place index resource. Requirements: Contain only
alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores
(_). Must be a unique place index resource name. No spaces allowed. For example,
ExamplePlaceIndex.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceConfiguration"`: Specifies the data storage option requesting Places.
- `"Description"`: The optional description for the place index resource.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"Tags"`: Applies one or more tags to the place index resource. A tag is a key-value pair
that helps you manage, identify, search, and filter your resources. Format: \"key\" :
\"value\" Restrictions: Maximum 50 tags per resource. Each tag key must be unique and
must have exactly one associated value. Maximum key length: 128 Unicode characters in
UTF-8. Maximum value length: 256 Unicode characters in UTF-8. Can use alphanumeric
characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @ Cannot
use \"aws:\" as a prefix for a key.
"""
function create_place_index(
DataSource, IndexName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/places/v0/indexes",
Dict{String,Any}("DataSource" => DataSource, "IndexName" => IndexName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_place_index(
DataSource,
IndexName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/places/v0/indexes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataSource" => DataSource, "IndexName" => IndexName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_route_calculator(calculator_name, data_source)
create_route_calculator(calculator_name, data_source, params::Dict{String,<:Any})
Creates a route calculator resource in your Amazon Web Services account. You can send
requests to a route calculator resource to estimate travel time, distance, and get
directions. A route calculator sources traffic and road network data from your chosen data
provider. If your application is tracking or routing assets you use in your business, such
as delivery vehicles or employees, you must not use Esri as your geolocation provider. See
section 82 of the Amazon Web Services service terms for more details.
# Arguments
- `calculator_name`: The name of the route calculator resource. Requirements: Can use
alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores
(_). Must be a unique Route calculator resource name. No spaces allowed. For example,
ExampleRouteCalculator.
- `data_source`: Specifies the data provider of traffic and road network data. This field
is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an
error. Valid values include: Esri – For additional information about Esri's coverage
in your region of interest, see Esri details on street networks and traffic coverage. Route
calculators that use Esri as a data source only calculate routes that are shorter than 400
km. Grab – Grab provides routing functionality for Southeast Asia. For additional
information about GrabMaps' coverage, see GrabMaps countries and areas covered. Here –
For additional information about HERE Technologies' coverage in your region of interest,
see HERE car routing coverage and HERE truck routing coverage. For additional information
, see Data providers on the Amazon Location Service Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The optional description for the route calculator resource.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"Tags"`: Applies one or more tags to the route calculator resource. A tag is a key-value
pair helps manage, identify, search, and filter your resources by labelling them. For
example: { \"tag1\" : \"value1\", \"tag2\" : \"value2\"} Format: \"key\" : \"value\"
Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a
maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value
length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z,
0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix
for a key.
"""
function create_route_calculator(
CalculatorName, DataSource; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/routes/v0/calculators",
Dict{String,Any}("CalculatorName" => CalculatorName, "DataSource" => DataSource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_route_calculator(
CalculatorName,
DataSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/routes/v0/calculators",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CalculatorName" => CalculatorName, "DataSource" => DataSource
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tracker(tracker_name)
create_tracker(tracker_name, params::Dict{String,<:Any})
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve
current and historical location of devices.
# Arguments
- `tracker_name`: The name for the tracker resource. Requirements: Contain only
alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
Must be a unique tracker resource name. No spaces allowed. For example, ExampleTracker.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for the tracker resource.
- `"EventBridgeEnabled"`: Whether to enable position UPDATE events from this tracker to be
sent to EventBridge. You do not need enable this feature to get ENTER and EXIT events for
geofences with this tracker. Those events are always sent to EventBridge.
- `"KmsKeyEnableGeospatialQueries"`: Enables GeospatialQueries for a tracker that uses a
Amazon Web Services KMS customer managed key. This parameter is only used if you are using
a KMS customer managed key. If you wish to encrypt your data using your own KMS customer
managed key, then the Bounding Polygon Queries feature will be disabled by default. This is
because by using this feature, a representation of your device positions will not be
encrypted using the your KMS managed key. The exact device position, however; is still
encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries
feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when
creating or updating a Tracker.
- `"KmsKeyId"`: A key identifier for an Amazon Web Services KMS customer managed key. Enter
a key ID, key ARN, alias name, or alias ARN.
- `"PositionFiltering"`: Specifies the position filtering for the tracker resource. Valid
values: TimeBased - Location updates are evaluated against linked geofence collections,
but not every location update is stored. If your update frequency is more often than 30
seconds, only one update per 30 seconds is stored for each unique device ID.
DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are
ignored. Location updates within this area are neither evaluated against linked geofence
collections, nor stored. This helps control costs by reducing the number of geofence
evaluations and historical device positions to paginate through. Distance-based filtering
can also reduce the effects of GPS noise when displaying device trajectories on a map.
AccuracyBased - If the device has moved less than the measured accuracy, location updates
are ignored. For example, if two consecutive updates from a device have a horizontal
accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15
m. Ignored location updates are neither evaluated against linked geofence collections, nor
stored. This can reduce the effects of GPS noise when displaying device trajectories on a
map, and can help control your costs by reducing the number of geofence evaluations.
This field is optional. If not specified, the default value is TimeBased.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"PricingPlanDataSource"`: This parameter is no longer used.
- `"Tags"`: Applies one or more tags to the tracker resource. A tag is a key-value pair
helps manage, identify, search, and filter your resources by labelling them. Format:
\"key\" : \"value\" Restrictions: Maximum 50 tags per resource Each resource tag must
be unique with a maximum of one value. Maximum key length: 128 Unicode characters in
UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric
characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot
use \"aws:\" as a prefix for a key.
"""
function create_tracker(TrackerName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/tracking/v0/trackers",
Dict{String,Any}("TrackerName" => TrackerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tracker(
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrackerName" => TrackerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_geofence_collection(collection_name)
delete_geofence_collection(collection_name, params::Dict{String,<:Any})
Deletes a geofence collection from your Amazon Web Services account. This operation
deletes the resource permanently. If the geofence collection is the target of a tracker
resource, the devices will no longer be monitored.
# Arguments
- `collection_name`: The name of the geofence collection to be deleted.
"""
function delete_geofence_collection(
CollectionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"DELETE",
"/geofencing/v0/collections/$(CollectionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_geofence_collection(
CollectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"DELETE",
"/geofencing/v0/collections/$(CollectionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_key(key_name)
delete_key(key_name, params::Dict{String,<:Any})
Deletes the specified API key. The API key must have been deactivated more than 90 days
previously.
# Arguments
- `key_name`: The name of the API key to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"forceDelete"`: ForceDelete bypasses an API key's expiry conditions and deletes the key.
Set the parameter true to delete the key or to false to not preemptively delete the API
key. Valid values: true, or false. Required: No This action is irreversible. Only use
ForceDelete if you are certain the key is no longer in use.
"""
function delete_key(KeyName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"DELETE",
"/metadata/v0/keys/$(KeyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_key(
KeyName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"DELETE",
"/metadata/v0/keys/$(KeyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_map(map_name)
delete_map(map_name, params::Dict{String,<:Any})
Deletes a map resource from your Amazon Web Services account. This operation deletes the
resource permanently. If the map is being used in an application, the map may not render.
# Arguments
- `map_name`: The name of the map resource to be deleted.
"""
function delete_map(MapName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"DELETE",
"/maps/v0/maps/$(MapName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_map(
MapName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"DELETE",
"/maps/v0/maps/$(MapName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_place_index(index_name)
delete_place_index(index_name, params::Dict{String,<:Any})
Deletes a place index resource from your Amazon Web Services account. This operation
deletes the resource permanently.
# Arguments
- `index_name`: The name of the place index resource to be deleted.
"""
function delete_place_index(IndexName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"DELETE",
"/places/v0/indexes/$(IndexName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_place_index(
IndexName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"DELETE",
"/places/v0/indexes/$(IndexName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_route_calculator(calculator_name)
delete_route_calculator(calculator_name, params::Dict{String,<:Any})
Deletes a route calculator resource from your Amazon Web Services account. This operation
deletes the resource permanently.
# Arguments
- `calculator_name`: The name of the route calculator resource to be deleted.
"""
function delete_route_calculator(
CalculatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"DELETE",
"/routes/v0/calculators/$(CalculatorName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_route_calculator(
CalculatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"DELETE",
"/routes/v0/calculators/$(CalculatorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tracker(tracker_name)
delete_tracker(tracker_name, params::Dict{String,<:Any})
Deletes a tracker resource from your Amazon Web Services account. This operation deletes
the resource permanently. If the tracker resource is in use, you may encounter an error.
Make sure that the target resource isn't a dependency for your applications.
# Arguments
- `tracker_name`: The name of the tracker resource to be deleted.
"""
function delete_tracker(TrackerName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"DELETE",
"/tracking/v0/trackers/$(TrackerName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tracker(
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"DELETE",
"/tracking/v0/trackers/$(TrackerName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_geofence_collection(collection_name)
describe_geofence_collection(collection_name, params::Dict{String,<:Any})
Retrieves the geofence collection details.
# Arguments
- `collection_name`: The name of the geofence collection.
"""
function describe_geofence_collection(
CollectionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/geofencing/v0/collections/$(CollectionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_geofence_collection(
CollectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/geofencing/v0/collections/$(CollectionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_key(key_name)
describe_key(key_name, params::Dict{String,<:Any})
Retrieves the API key resource details.
# Arguments
- `key_name`: The name of the API key resource.
"""
function describe_key(KeyName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"GET",
"/metadata/v0/keys/$(KeyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_key(
KeyName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/metadata/v0/keys/$(KeyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_map(map_name)
describe_map(map_name, params::Dict{String,<:Any})
Retrieves the map resource details.
# Arguments
- `map_name`: The name of the map resource.
"""
function describe_map(MapName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"GET",
"/maps/v0/maps/$(MapName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_map(
MapName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/maps/v0/maps/$(MapName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_place_index(index_name)
describe_place_index(index_name, params::Dict{String,<:Any})
Retrieves the place index resource details.
# Arguments
- `index_name`: The name of the place index resource.
"""
function describe_place_index(IndexName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"GET",
"/places/v0/indexes/$(IndexName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_place_index(
IndexName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/places/v0/indexes/$(IndexName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_route_calculator(calculator_name)
describe_route_calculator(calculator_name, params::Dict{String,<:Any})
Retrieves the route calculator resource details.
# Arguments
- `calculator_name`: The name of the route calculator resource.
"""
function describe_route_calculator(
CalculatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/routes/v0/calculators/$(CalculatorName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_route_calculator(
CalculatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/routes/v0/calculators/$(CalculatorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tracker(tracker_name)
describe_tracker(tracker_name, params::Dict{String,<:Any})
Retrieves the tracker resource details.
# Arguments
- `tracker_name`: The name of the tracker resource.
"""
function describe_tracker(TrackerName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"GET",
"/tracking/v0/trackers/$(TrackerName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tracker(
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/tracking/v0/trackers/$(TrackerName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_tracker_consumer(consumer_arn, tracker_name)
disassociate_tracker_consumer(consumer_arn, tracker_name, params::Dict{String,<:Any})
Removes the association between a tracker resource and a geofence collection. Once you
unlink a tracker resource from a geofence collection, the tracker positions will no longer
be automatically evaluated against geofences.
# Arguments
- `consumer_arn`: The Amazon Resource Name (ARN) for the geofence collection to be
disassociated from the tracker resource. Used when you need to specify a resource across
all Amazon Web Services. Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
- `tracker_name`: The name of the tracker resource to be dissociated from the consumer.
"""
function disassociate_tracker_consumer(
ConsumerArn, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"DELETE",
"/tracking/v0/trackers/$(TrackerName)/consumers/$(ConsumerArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_tracker_consumer(
ConsumerArn,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"DELETE",
"/tracking/v0/trackers/$(TrackerName)/consumers/$(ConsumerArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
forecast_geofence_events(collection_name, device_state)
forecast_geofence_events(collection_name, device_state, params::Dict{String,<:Any})
Evaluates device positions against geofence geometries from a given geofence collection.
The event forecasts three states for which a device can be in relative to a geofence:
ENTER: If a device is outside of a geofence, but would breach the fence if the device is
moving at its current speed within time horizon window. EXIT: If a device is inside of a
geofence, but would breach the fence if the device is moving at its current speed within
time horizon window. IDLE: If a device is inside of a geofence, and the device is not
moving.
# Arguments
- `collection_name`: The name of the geofence collection.
- `device_state`: The device's state, including current position and speed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DistanceUnit"`: The distance unit used for the NearestDistance property returned in a
forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if
Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.
Default Value: Kilometers
- `"MaxResults"`: An optional limit for the number of resources returned in a single call.
Default value: 20
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
- `"SpeedUnit"`: The speed unit for the device captured by the device state. The
measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified
for DistanceUnit, then SpeedUnit must be KilometersPerHour. Default Value:
KilometersPerHour.
- `"TimeHorizonMinutes"`: Specifies the time horizon in minutes for the forecasted events.
"""
function forecast_geofence_events(
CollectionName, DeviceState; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/forecast-geofence-events",
Dict{String,Any}("DeviceState" => DeviceState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function forecast_geofence_events(
CollectionName,
DeviceState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/forecast-geofence-events",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeviceState" => DeviceState), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_position(device_id, tracker_name)
get_device_position(device_id, tracker_name, params::Dict{String,<:Any})
Retrieves a device's most recent position according to its sample time. Device positions
are deleted after 30 days.
# Arguments
- `device_id`: The device whose position you want to retrieve.
- `tracker_name`: The tracker resource receiving the position update.
"""
function get_device_position(
DeviceId, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/tracking/v0/trackers/$(TrackerName)/devices/$(DeviceId)/positions/latest";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_position(
DeviceId,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/tracking/v0/trackers/$(TrackerName)/devices/$(DeviceId)/positions/latest",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_position_history(device_id, tracker_name)
get_device_position_history(device_id, tracker_name, params::Dict{String,<:Any})
Retrieves the device position history from a tracker resource within a specified range of
time. Device positions are deleted after 30 days.
# Arguments
- `device_id`: The device whose position history you want to retrieve.
- `tracker_name`: The tracker resource receiving the request for the device position
history.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTimeExclusive"`: Specify the end time for the position history in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.
Requirement: The time specified for EndTimeExclusive must be after the time for
StartTimeInclusive.
- `"MaxResults"`: An optional limit for the number of device positions returned in a single
call. Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
- `"StartTimeInclusive"`: Specify the start time for the position history in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time
that the request is made. Requirement: The time specified for StartTimeInclusive must be
before EndTimeExclusive.
"""
function get_device_position_history(
DeviceId, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/devices/$(DeviceId)/list-positions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_position_history(
DeviceId,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/devices/$(DeviceId)/list-positions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_geofence(collection_name, geofence_id)
get_geofence(collection_name, geofence_id, params::Dict{String,<:Any})
Retrieves the geofence details from a geofence collection. The returned geometry will
always match the geometry format used when the geofence was created.
# Arguments
- `collection_name`: The geofence collection storing the target geofence.
- `geofence_id`: The geofence you're retrieving details for.
"""
function get_geofence(
CollectionName, GeofenceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/geofencing/v0/collections/$(CollectionName)/geofences/$(GeofenceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_geofence(
CollectionName,
GeofenceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/geofencing/v0/collections/$(CollectionName)/geofences/$(GeofenceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_map_glyphs(font_stack, font_unicode_range, map_name)
get_map_glyphs(font_stack, font_unicode_range, map_name, params::Dict{String,<:Any})
Retrieves glyphs used to display labels on a map.
# Arguments
- `font_stack`: A comma-separated list of fonts to load glyphs from in order of preference.
For example, Noto Sans Regular, Arial Unicode. Valid font stacks for Esri styles:
VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu
Regular | Ubuntu Bold VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular |
Ubuntu Light | Ubuntu Bold VectorEsriTopographic – Noto Sans Italic | Noto Sans
Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold VectorEsriNavigation –
Arial Regular | Arial Italic | Arial Bold Valid font stacks for HERE Technologies
styles: VectorHereContrast – Fira GO Regular | Fira GO Bold VectorHereExplore,
VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira
GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular
Valid font stacks for GrabMaps styles: VectorGrabStandardLight, VectorGrabStandardDark
– Noto Sans Regular | Noto Sans Medium | Noto Sans Bold Valid font stacks for Open
Data styles: VectorOpenDataStandardLight, VectorOpenDataStandardDark,
VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember
Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto
Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC
Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember
Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto
Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans
Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular |
Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular |
Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium The fonts used by the Open
Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for
glyphs unsupported by Amazon Ember.
- `font_unicode_range`: A Unicode range of characters to download glyphs for. Each response
will contain 256 characters. For example, 0–255 includes all characters from range U+0000
to 00FF. Must be aligned to multiples of 256.
- `map_name`: The map resource associated with the glyph file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"key"`: The optional API key to authorize the request.
"""
function get_map_glyphs(
FontStack, FontUnicodeRange, MapName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/glyphs/$(FontStack)/$(FontUnicodeRange)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_map_glyphs(
FontStack,
FontUnicodeRange,
MapName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/glyphs/$(FontStack)/$(FontUnicodeRange)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_map_sprites(file_name, map_name)
get_map_sprites(file_name, map_name, params::Dict{String,<:Any})
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image
paired with a JSON document describing the offsets of individual icons that will be
displayed on a rendered map.
# Arguments
- `file_name`: The name of the sprite file. Use the following file names for the sprite
sheet: sprites.png [email protected] for high pixel density displays For the JSON
document containing image offsets. Use the following file names: sprites.json
[email protected] for high pixel density displays
- `map_name`: The map resource associated with the sprite file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"key"`: The optional API key to authorize the request.
"""
function get_map_sprites(
FileName, MapName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/sprites/$(FileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_map_sprites(
FileName,
MapName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/sprites/$(FileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_map_style_descriptor(map_name)
get_map_style_descriptor(map_name, params::Dict{String,<:Any})
Retrieves the map style descriptor from a map resource. The style descriptor contains
specifications on how features render on a map. For example, what data to display, what
order to display the data in, and the style for the data. Style descriptors follow the
Mapbox Style Specification.
# Arguments
- `map_name`: The map resource to retrieve the style descriptor from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"key"`: The optional API key to authorize the request.
"""
function get_map_style_descriptor(
MapName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/style-descriptor";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_map_style_descriptor(
MapName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/style-descriptor",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_map_tile(map_name, x, y, z)
get_map_tile(map_name, x, y, z, params::Dict{String,<:Any})
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render
a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z
(zoom) level. The origin (0, 0) is the top left of the map. Increasing the zoom level by 1
doubles both the X and Y dimensions, so a tile containing data for the entire world at
(0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
# Arguments
- `map_name`: The map resource to retrieve the map tiles from.
- `x`: The X axis value for the map tile.
- `y`: The Y axis value for the map tile.
- `z`: The zoom value for the map tile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"key"`: The optional API key to authorize the request.
"""
function get_map_tile(MapName, X, Y, Z; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"GET",
"/maps/v0/maps/$(MapName)/tiles/$(Z)/$(X)/$(Y)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_map_tile(
MapName,
X,
Y,
Z,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/maps/v0/maps/$(MapName)/tiles/$(Z)/$(X)/$(Y)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_place(index_name, place_id)
get_place(index_name, place_id, params::Dict{String,<:Any})
Finds a place by its unique ID. A PlaceId is returned by other search operations. A
PlaceId is valid only if all of the following are the same in the original search request
and the call to GetPlace. Customer Amazon Web Services account Amazon Web Services
Region Data provider specified in the place index resource
# Arguments
- `index_name`: The name of the place index resource that you want to use for the search.
- `place_id`: The identifier of the place to find.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"key"`: The optional API key to authorize the request.
- `"language"`: The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example, en for English. This setting affects the languages used
in the results, but not the results themselves. If no language is specified, or not
supported for a particular result, the partner automatically chooses a language for the
result. For an example, we'll use the Greek language. You search for a location around
Athens, Greece, with the language parameter set to en. The city in the results will most
likely be returned as Athens. If you set the language parameter to el, for Greek, then the
city in the results will more likely be returned as Αθήνα. If the data provider does
not have a value for Greek, the result will be in a language that the provider does support.
"""
function get_place(IndexName, PlaceId; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"GET",
"/places/v0/indexes/$(IndexName)/places/$(PlaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_place(
IndexName,
PlaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/places/v0/indexes/$(IndexName)/places/$(PlaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_positions(tracker_name)
list_device_positions(tracker_name, params::Dict{String,<:Any})
A batch request to retrieve all device positions.
# Arguments
- `tracker_name`: The tracker resource containing the requested devices.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterGeometry"`: The geometry used to filter device positions.
- `"MaxResults"`: An optional limit for the number of entries returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_device_positions(
TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/list-positions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_positions(
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/list-positions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_geofence_collections()
list_geofence_collections(params::Dict{String,<:Any})
Lists geofence collections in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional limit for the number of resources returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_geofence_collections(; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/geofencing/v0/list-collections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_geofence_collections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/geofencing/v0/list-collections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_geofences(collection_name)
list_geofences(collection_name, params::Dict{String,<:Any})
Lists geofences stored in a given geofence collection.
# Arguments
- `collection_name`: The name of the geofence collection storing the list of geofences.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional limit for the number of geofences returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_geofences(CollectionName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/list-geofences";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_geofences(
CollectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/geofencing/v0/collections/$(CollectionName)/list-geofences",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_keys()
list_keys(params::Dict{String,<:Any})
Lists API key resources in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Optionally filter the list to only Active or Expired API keys.
- `"MaxResults"`: An optional limit for the number of resources returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_keys(; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/metadata/v0/list-keys";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_keys(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/metadata/v0/list-keys",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_maps()
list_maps(params::Dict{String,<:Any})
Lists map resources in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional limit for the number of resources returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_maps(; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST", "/maps/v0/list-maps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_maps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/maps/v0/list-maps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_place_indexes()
list_place_indexes(params::Dict{String,<:Any})
Lists place index resources in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional limit for the maximum number of results returned in a single
call. Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_place_indexes(; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/places/v0/list-indexes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_place_indexes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/places/v0/list-indexes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_route_calculators()
list_route_calculators(params::Dict{String,<:Any})
Lists route calculator resources in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional maximum number of results returned in a single call. Default
Value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default Value: null
"""
function list_route_calculators(; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/routes/v0/list-calculators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_route_calculators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/routes/v0/list-calculators",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of tags that are applied to the specified Amazon Location resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags you want to
retrieve. Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tracker_consumers(tracker_name)
list_tracker_consumers(tracker_name, params::Dict{String,<:Any})
Lists geofence collections currently associated to the given tracker resource.
# Arguments
- `tracker_name`: The tracker resource whose associated geofence collections you want to
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional limit for the number of resources returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_tracker_consumers(
TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/list-consumers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tracker_consumers(
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/list-consumers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_trackers()
list_trackers(params::Dict{String,<:Any})
Lists tracker resources in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional limit for the number of resources returned in a single call.
Default value: 100
- `"NextToken"`: The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page. Default value: null
"""
function list_trackers(; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/tracking/v0/list-trackers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_trackers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/list-trackers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_geofence(collection_name, geofence_id, geometry)
put_geofence(collection_name, geofence_id, geometry, params::Dict{String,<:Any})
Stores a geofence geometry in a given geofence collection, or updates the geometry of an
existing geofence if a geofence ID is included in the request.
# Arguments
- `collection_name`: The geofence collection to store the geofence in.
- `geofence_id`: An identifier for the geofence. For example, ExampleGeofence-1.
- `geometry`: Contains the details to specify the position of the geofence. Can be a
polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will
return a validation error. The geofence polygon format supports a maximum of 1,000
vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GeofenceProperties"`: Associates one of more properties with the geofence. A property
is a key-value pair stored with the geofence and added to any geofence event triggered with
that geofence. Format: \"key\" : \"value\"
"""
function put_geofence(
CollectionName, GeofenceId, Geometry; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"PUT",
"/geofencing/v0/collections/$(CollectionName)/geofences/$(GeofenceId)",
Dict{String,Any}("Geometry" => Geometry);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_geofence(
CollectionName,
GeofenceId,
Geometry,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"PUT",
"/geofencing/v0/collections/$(CollectionName)/geofences/$(GeofenceId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Geometry" => Geometry), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_place_index_for_position(index_name, position)
search_place_index_for_position(index_name, position, params::Dict{String,<:Any})
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for
Places or points of interest near a given position.
# Arguments
- `index_name`: The name of the place index resource you want to use for the search.
- `position`: Specifies the longitude and latitude of the position to query. This
parameter must contain a pair of numbers. The first number represents the X coordinate, or
longitude; the second number represents the Y coordinate, or latitude. For example,
[-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Language"`: The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example, en for English. This setting affects the languages used
in the results, but not the results themselves. If no language is specified, or not
supported for a particular result, the partner automatically chooses a language for the
result. For an example, we'll use the Greek language. You search for a location around
Athens, Greece, with the language parameter set to en. The city in the results will most
likely be returned as Athens. If you set the language parameter to el, for Greek, then the
city in the results will more likely be returned as Αθήνα. If the data provider does
not have a value for Greek, the result will be in a language that the provider does support.
- `"MaxResults"`: An optional parameter. The maximum number of results returned per
request. Default value: 50
- `"key"`: The optional API key to authorize the request.
"""
function search_place_index_for_position(
IndexName, Position; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/places/v0/indexes/$(IndexName)/search/position",
Dict{String,Any}("Position" => Position);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_place_index_for_position(
IndexName,
Position,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/places/v0/indexes/$(IndexName)/search/position",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Position" => Position), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_place_index_for_suggestions(index_name, text)
search_place_index_for_suggestions(index_name, text, params::Dict{String,<:Any})
Generates suggestions for addresses and points of interest based on partial or misspelled
free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy
matching. Optional parameters let you narrow your search results by bounding box or
country, or bias your search toward a specific position on the globe. You can search for
suggested place names near a specified position by using BiasPosition, or filter results
within a bounding box by using FilterBBox. These parameters are mutually exclusive; using
both BiasPosition and FilterBBox in the same command returns an error.
# Arguments
- `index_name`: The name of the place index resource you want to use for the search.
- `text`: The free-form partial text to use to generate place suggestions. For example,
eiffel tow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BiasPosition"`: An optional parameter that indicates a preference for place suggestions
that are closer to a specified position. If provided, this parameter must contain a pair
of numbers. The first number represents the X coordinate, or longitude; the second number
represents the Y coordinate, or latitude. For example, [-123.1174, 49.2847] represents the
position with longitude -123.1174 and latitude 49.2847. BiasPosition and FilterBBox are
mutually exclusive. Specifying both options results in an error.
- `"FilterBBox"`: An optional parameter that limits the search results by returning only
suggestions within a specified bounding box. If provided, this parameter must contain a
total of four consecutive numbers in two pairs. The first pair of numbers represents the X
and Y coordinates (longitude and latitude, respectively) of the southwest corner of the
bounding box; the second pair of numbers represents the X and Y coordinates (longitude and
latitude, respectively) of the northeast corner of the bounding box. For example,
[-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest
corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude
-12.0684 and latitude -36.9542. FilterBBox and BiasPosition are mutually exclusive.
Specifying both options results in an error.
- `"FilterCategories"`: A list of one or more Amazon Location categories to filter the
returned places. If you include more than one category, the results will include results
that match any of the categories listed. For more information about using categories,
including a list of Amazon Location categories, see Categories and filtering, in the Amazon
Location Service Developer Guide.
- `"FilterCountries"`: An optional parameter that limits the search results by returning
only suggestions within the provided list of countries. Use the ISO 3166 3-digit country
code. For example, Australia uses three upper-case characters: AUS.
- `"Language"`: The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example, en for English. This setting affects the languages used
in the results. If no language is specified, or not supported for a particular result, the
partner automatically chooses a language for the result. For an example, we'll use the
Greek language. You search for Athens, Gr to get suggestions with the language parameter
set to en. The results found will most likely be returned as Athens, Greece. If you set the
language parameter to el, for Greek, then the result found will more likely be returned as
Αθήνα, Ελλάδα. If the data provider does not have a value for Greek, the result
will be in a language that the provider does support.
- `"MaxResults"`: An optional parameter. The maximum number of results returned per
request. The default: 5
- `"key"`: The optional API key to authorize the request.
"""
function search_place_index_for_suggestions(
IndexName, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/places/v0/indexes/$(IndexName)/search/suggestions",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_place_index_for_suggestions(
IndexName,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/places/v0/indexes/$(IndexName)/search/suggestions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_place_index_for_text(index_name, text)
search_place_index_for_text(index_name, text, params::Dict{String,<:Any})
Geocodes free-form text, such as an address, name, city, or region to allow you to search
for Places or points of interest. Optional parameters let you narrow your search results
by bounding box or country, or bias your search toward a specific position on the globe.
You can search for places near a given position using BiasPosition, or filter results
within a bounding box using FilterBBox. Providing both parameters simultaneously returns an
error. Search results are returned in order of highest to lowest relevance.
# Arguments
- `index_name`: The name of the place index resource you want to use for the search.
- `text`: The address, name, city, or region to be used in the search in free-form text
format. For example, 123 Any Street.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BiasPosition"`: An optional parameter that indicates a preference for places that are
closer to a specified position. If provided, this parameter must contain a pair of
numbers. The first number represents the X coordinate, or longitude; the second number
represents the Y coordinate, or latitude. For example, [-123.1174, 49.2847] represents the
position with longitude -123.1174 and latitude 49.2847. BiasPosition and FilterBBox are
mutually exclusive. Specifying both options results in an error.
- `"FilterBBox"`: An optional parameter that limits the search results by returning only
places that are within the provided bounding box. If provided, this parameter must contain
a total of four consecutive numbers in two pairs. The first pair of numbers represents the
X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the
bounding box; the second pair of numbers represents the X and Y coordinates (longitude and
latitude, respectively) of the northeast corner of the bounding box. For example,
[-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest
corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude
-12.0684 and latitude -36.9542. FilterBBox and BiasPosition are mutually exclusive.
Specifying both options results in an error.
- `"FilterCategories"`: A list of one or more Amazon Location categories to filter the
returned places. If you include more than one category, the results will include results
that match any of the categories listed. For more information about using categories,
including a list of Amazon Location categories, see Categories and filtering, in the Amazon
Location Service Developer Guide.
- `"FilterCountries"`: An optional parameter that limits the search results by returning
only places that are in a specified list of countries. Valid values include ISO 3166
3-digit country codes. For example, Australia uses three upper-case characters: AUS.
- `"Language"`: The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example, en for English. This setting affects the languages used
in the results, but not the results themselves. If no language is specified, or not
supported for a particular result, the partner automatically chooses a language for the
result. For an example, we'll use the Greek language. You search for Athens, Greece, with
the language parameter set to en. The result found will most likely be returned as Athens.
If you set the language parameter to el, for Greek, then the result found will more likely
be returned as Αθήνα. If the data provider does not have a value for Greek, the result
will be in a language that the provider does support.
- `"MaxResults"`: An optional parameter. The maximum number of results returned per
request. The default: 50
- `"key"`: The optional API key to authorize the request.
"""
function search_place_index_for_text(
IndexName, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/places/v0/indexes/$(IndexName)/search/text",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_place_index_for_text(
IndexName,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/places/v0/indexes/$(IndexName)/search/text",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service
resource. Tags can help you organize and categorize your resources. You can also use them
to scope user permissions, by granting a user permission to access or change only resources
with certain tag values. You can use the TagResource operation with an Amazon Location
Service resource that already has tags. If you specify a new tag key for the resource, this
tag is appended to the tags already associated with the resource. If you specify a tag key
that's already associated with the resource, the new tag value that you specify replaces
the previous value for that tag. You can associate up to 50 tags with a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags you want to
update. Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
- `tags`: Applies one or more tags to specific resource. A tag is a key-value pair that
helps you manage, identify, search, and filter your resources. Format: \"key\" : \"value\"
Restrictions: Maximum 50 tags per resource. Each tag key must be unique and must have
exactly one associated value. Maximum key length: 128 Unicode characters in UTF-8.
Maximum value length: 256 Unicode characters in UTF-8. Can use alphanumeric characters
(A–Z, a–z, 0–9), and the following characters: + - = . _ : / @ Cannot use \"aws:\"
as a prefix for a key.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from the specified Amazon Location resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource from which you want to
remove tags. Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
- `tag_keys`: The list of tag keys to remove from the specified resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_geofence_collection(collection_name)
update_geofence_collection(collection_name, params::Dict{String,<:Any})
Updates the specified properties of a given geofence collection.
# Arguments
- `collection_name`: The name of the geofence collection to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Updates the description for the geofence collection.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"PricingPlanDataSource"`: This parameter is no longer used.
"""
function update_geofence_collection(
CollectionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"PATCH",
"/geofencing/v0/collections/$(CollectionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_geofence_collection(
CollectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"PATCH",
"/geofencing/v0/collections/$(CollectionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_key(key_name)
update_key(key_name, params::Dict{String,<:Any})
Updates the specified properties of a given API key resource.
# Arguments
- `key_name`: The name of the API key resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Updates the description for the API key resource.
- `"ExpireTime"`: Updates the timestamp for when the API key resource will expire in ISO
8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
- `"ForceUpdate"`: The boolean flag to be included for updating ExpireTime or Restrictions
details. Must be set to true to update an API key resource that has been used in the past 7
days. False if force update is not preferred Default value: False
- `"NoExpiry"`: Whether the API key should expire. Set to true to set the API key to have
no expiration time.
- `"Restrictions"`: Updates the API key restrictions for the API key resource.
"""
function update_key(KeyName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"PATCH",
"/metadata/v0/keys/$(KeyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_key(
KeyName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"PATCH",
"/metadata/v0/keys/$(KeyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_map(map_name)
update_map(map_name, params::Dict{String,<:Any})
Updates the specified properties of a given map resource.
# Arguments
- `map_name`: The name of the map resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationUpdate"`: Updates the parts of the map configuration that can be updated,
including the political view.
- `"Description"`: Updates the description for the map resource.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
"""
function update_map(MapName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"PATCH",
"/maps/v0/maps/$(MapName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_map(
MapName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"PATCH",
"/maps/v0/maps/$(MapName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_place_index(index_name)
update_place_index(index_name, params::Dict{String,<:Any})
Updates the specified properties of a given place index resource.
# Arguments
- `index_name`: The name of the place index resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSourceConfiguration"`: Updates the data storage option for the place index resource.
- `"Description"`: Updates the description for the place index resource.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
"""
function update_place_index(IndexName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"PATCH",
"/places/v0/indexes/$(IndexName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_place_index(
IndexName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"PATCH",
"/places/v0/indexes/$(IndexName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_route_calculator(calculator_name)
update_route_calculator(calculator_name, params::Dict{String,<:Any})
Updates the specified properties for a given route calculator resource.
# Arguments
- `calculator_name`: The name of the route calculator resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Updates the description for the route calculator resource.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
"""
function update_route_calculator(
CalculatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"PATCH",
"/routes/v0/calculators/$(CalculatorName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_route_calculator(
CalculatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"PATCH",
"/routes/v0/calculators/$(CalculatorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_tracker(tracker_name)
update_tracker(tracker_name, params::Dict{String,<:Any})
Updates the specified properties of a given tracker resource.
# Arguments
- `tracker_name`: The name of the tracker resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Updates the description for the tracker resource.
- `"EventBridgeEnabled"`: Whether to enable position UPDATE events from this tracker to be
sent to EventBridge. You do not need enable this feature to get ENTER and EXIT events for
geofences with this tracker. Those events are always sent to EventBridge.
- `"KmsKeyEnableGeospatialQueries"`: Enables GeospatialQueries for a tracker that uses a
Amazon Web Services KMS customer managed key. This parameter is only used if you are using
a KMS customer managed key.
- `"PositionFiltering"`: Updates the position filtering for the tracker resource. Valid
values: TimeBased - Location updates are evaluated against linked geofence collections,
but not every location update is stored. If your update frequency is more often than 30
seconds, only one update per 30 seconds is stored for each unique device ID.
DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are
ignored. Location updates within this distance are neither evaluated against linked
geofence collections, nor stored. This helps control costs by reducing the number of
geofence evaluations and historical device positions to paginate through. Distance-based
filtering can also reduce the effects of GPS noise when displaying device trajectories on a
map. AccuracyBased - If the device has moved less than the measured accuracy, location
updates are ignored. For example, if two consecutive updates from a device have a
horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved
less than 15 m. Ignored location updates are neither evaluated against linked geofence
collections, nor stored. This helps educe the effects of GPS noise when displaying device
trajectories on a map, and can help control costs by reducing the number of geofence
evaluations.
- `"PricingPlan"`: No longer used. If included, the only allowed value is RequestBasedUsage.
- `"PricingPlanDataSource"`: This parameter is no longer used.
"""
function update_tracker(TrackerName; aws_config::AbstractAWSConfig=global_aws_config())
return location(
"PATCH",
"/tracking/v0/trackers/$(TrackerName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_tracker(
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"PATCH",
"/tracking/v0/trackers/$(TrackerName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_device_position(device_state, tracker_name)
verify_device_position(device_state, tracker_name, params::Dict{String,<:Any})
Verifies the integrity of the device's position by determining if it was reported behind a
proxy, and by comparing it to an inferred position estimated based on the device's state.
# Arguments
- `device_state`: The device's state, including position, IP address, cell signals and
Wi-Fi access points.
- `tracker_name`: The name of the tracker resource to be associated with verification
request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DistanceUnit"`: The distance unit for the verification request. Default Value:
Kilometers
"""
function verify_device_position(
DeviceState, TrackerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/positions/verify",
Dict{String,Any}("DeviceState" => DeviceState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_device_position(
DeviceState,
TrackerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return location(
"POST",
"/tracking/v0/trackers/$(TrackerName)/positions/verify",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeviceState" => DeviceState), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 78252 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lookoutequipment
using AWS.Compat
using AWS.UUIDs
"""
create_dataset(client_token, dataset_name)
create_dataset(client_token, dataset_name, params::Dict{String,<:Any})
Creates a container for a collection of data being ingested for analysis. The dataset
contains the metadata describing where the data is and what the data actually looks like.
For example, it contains the location of the data source, the data schema, and other
information. A dataset also contains any tags associated with the ingested data.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client
request token, Amazon Lookout for Equipment generates one.
- `dataset_name`: The name of the dataset being created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetSchema"`: A JSON description of the data that is in each time series dataset,
including names, column names, and data types.
- `"ServerSideKmsKeyId"`: Provides the identifier of the KMS key used to encrypt dataset
data by Amazon Lookout for Equipment.
- `"Tags"`: Any tags associated with the ingested data described in the dataset.
"""
function create_dataset(
ClientToken, DatasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"CreateDataset",
Dict{String,Any}("ClientToken" => ClientToken, "DatasetName" => DatasetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
ClientToken,
DatasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken, "DatasetName" => DatasetName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_inference_scheduler(client_token, data_input_configuration, data_output_configuration, data_upload_frequency, inference_scheduler_name, model_name, role_arn)
create_inference_scheduler(client_token, data_input_configuration, data_output_configuration, data_upload_frequency, inference_scheduler_name, model_name, role_arn, params::Dict{String,<:Any})
Creates a scheduled inference. Scheduling an inference is setting up a continuous
real-time inference plan to analyze new measurement data. When setting up the schedule, you
provide an S3 bucket location for the input data, assign it a delimiter between separate
entries in the data, set an offset delay if desired, and set the frequency of inferencing.
You must also provide an S3 bucket location for the output data.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client
request token, Amazon Lookout for Equipment generates one.
- `data_input_configuration`: Specifies configuration information for the input data for
the inference scheduler, including delimiter, format, and dataset location.
- `data_output_configuration`: Specifies configuration information for the output results
for the inference scheduler, including the S3 location for the output.
- `data_upload_frequency`: How often data is uploaded to the source Amazon S3 bucket for
the input data. The value chosen is the length of time between data uploads. For instance,
if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the
source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout
for Equipment runs inference on your data. For more information, see Understanding the
inference process.
- `inference_scheduler_name`: The name of the inference scheduler being created.
- `model_name`: The name of the previously trained machine learning model being used to
create the inference scheduler.
- `role_arn`: The Amazon Resource Name (ARN) of a role with permission to access the data
source being used for the inference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataDelayOffsetInMinutes"`: The interval (in minutes) of planned delay at the start of
each inference segment. For example, if inference is set to run every ten minutes, the
delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at
the configured interval (which, without a delay configured, would be 09:10) plus the
additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay
provides a buffer for you to upload data at the same frequency, so that you don't have to
stop and restart the scheduler when uploading new data. For more information, see
Understanding the inference process.
- `"ServerSideKmsKeyId"`: Provides the identifier of the KMS key used to encrypt inference
scheduler data by Amazon Lookout for Equipment.
- `"Tags"`: Any tags associated with the inference scheduler.
"""
function create_inference_scheduler(
ClientToken,
DataInputConfiguration,
DataOutputConfiguration,
DataUploadFrequency,
InferenceSchedulerName,
ModelName,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateInferenceScheduler",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataInputConfiguration" => DataInputConfiguration,
"DataOutputConfiguration" => DataOutputConfiguration,
"DataUploadFrequency" => DataUploadFrequency,
"InferenceSchedulerName" => InferenceSchedulerName,
"ModelName" => ModelName,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_inference_scheduler(
ClientToken,
DataInputConfiguration,
DataOutputConfiguration,
DataUploadFrequency,
InferenceSchedulerName,
ModelName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateInferenceScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataInputConfiguration" => DataInputConfiguration,
"DataOutputConfiguration" => DataOutputConfiguration,
"DataUploadFrequency" => DataUploadFrequency,
"InferenceSchedulerName" => InferenceSchedulerName,
"ModelName" => ModelName,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_label(client_token, end_time, label_group_name, rating, start_time)
create_label(client_token, end_time, label_group_name, rating, start_time, params::Dict{String,<:Any})
Creates a label for an event.
# Arguments
- `client_token`: A unique identifier for the request to create a label. If you do not set
the client request token, Lookout for Equipment generates one.
- `end_time`: The end time of the labeled event.
- `label_group_name`: The name of a group of labels. Data in this field will be retained
for service usage. Follow best practices for the security of your data.
- `rating`: Indicates whether a labeled event represents an anomaly.
- `start_time`: The start time of the labeled event.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Equipment"`: Indicates that a label pertains to a particular piece of equipment. Data
in this field will be retained for service usage. Follow best practices for the security of
your data.
- `"FaultCode"`: Provides additional information about the label. The fault code must be
defined in the FaultCodes attribute of the label group. Data in this field will be retained
for service usage. Follow best practices for the security of your data.
- `"Notes"`: Metadata providing additional information about the label. Data in this
field will be retained for service usage. Follow best practices for the security of your
data.
"""
function create_label(
ClientToken,
EndTime,
LabelGroupName,
Rating,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateLabel",
Dict{String,Any}(
"ClientToken" => ClientToken,
"EndTime" => EndTime,
"LabelGroupName" => LabelGroupName,
"Rating" => Rating,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_label(
ClientToken,
EndTime,
LabelGroupName,
Rating,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateLabel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"EndTime" => EndTime,
"LabelGroupName" => LabelGroupName,
"Rating" => Rating,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_label_group(client_token, label_group_name)
create_label_group(client_token, label_group_name, params::Dict{String,<:Any})
Creates a group of labels.
# Arguments
- `client_token`: A unique identifier for the request to create a label group. If you do
not set the client request token, Lookout for Equipment generates one.
- `label_group_name`: Names a group of labels. Data in this field will be retained for
service usage. Follow best practices for the security of your data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FaultCodes"`: The acceptable fault codes (indicating the type of anomaly associated
with the label) that can be used with this label group. Data in this field will be retained
for service usage. Follow best practices for the security of your data.
- `"Tags"`: Tags that provide metadata about the label group you are creating. Data in
this field will be retained for service usage. Follow best practices for the security of
your data.
"""
function create_label_group(
ClientToken, LabelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"CreateLabelGroup",
Dict{String,Any}("ClientToken" => ClientToken, "LabelGroupName" => LabelGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_label_group(
ClientToken,
LabelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateLabelGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken, "LabelGroupName" => LabelGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model(client_token, dataset_name, model_name)
create_model(client_token, dataset_name, model_name, params::Dict{String,<:Any})
Creates a machine learning model for data inference. A machine-learning (ML) model is a
mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the
model learns the patterns of normal behavior and detects abnormal behavior that could be
potential equipment failure (or maintenance events). The models are made by analyzing
normal data and abnormalities in machine behavior that have already occurred. Your model is
trained using a portion of the data from your dataset and uses that data to learn patterns
of normal behavior and abnormal patterns that lead to equipment failure. Another portion of
the data is used to evaluate the model's accuracy.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client request
token, Amazon Lookout for Equipment generates one.
- `dataset_name`: The name of the dataset for the machine learning model being created.
- `model_name`: The name for the machine learning model to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataPreProcessingConfiguration"`: The configuration is the TargetSamplingRate, which is
the sampling rate of the data after post processing by Amazon Lookout for Equipment. For
example, if you provide data that has been collected at a 1 second level and you want the
system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1
minute. When providing a value for the TargetSamplingRate, you must attach the prefix
\"PT\" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for
a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
- `"DatasetSchema"`: The data schema for the machine learning model being created.
- `"EvaluationDataEndTime"`: Indicates the time reference in the dataset that should be
used to end the subset of evaluation data for the machine learning model.
- `"EvaluationDataStartTime"`: Indicates the time reference in the dataset that should be
used to begin the subset of evaluation data for the machine learning model.
- `"LabelsInputConfiguration"`: The input configuration for the labels being used for the
machine learning model that's being created.
- `"ModelDiagnosticsOutputConfiguration"`: The Amazon S3 location where you want Amazon
Lookout for Equipment to save the pointwise model diagnostics. You must also specify the
RoleArn request parameter.
- `"OffCondition"`: Indicates that the asset associated with this sensor has been shut off.
As long as this condition is met, Lookout for Equipment will not use data from this asset
for training, evaluation, or inference.
- `"RoleArn"`: The Amazon Resource Name (ARN) of a role with permission to access the data
source being used to create the machine learning model.
- `"ServerSideKmsKeyId"`: Provides the identifier of the KMS key used to encrypt model data
by Amazon Lookout for Equipment.
- `"Tags"`: Any tags associated with the machine learning model being created.
- `"TrainingDataEndTime"`: Indicates the time reference in the dataset that should be used
to end the subset of training data for the machine learning model.
- `"TrainingDataStartTime"`: Indicates the time reference in the dataset that should be
used to begin the subset of training data for the machine learning model.
"""
function create_model(
ClientToken, DatasetName, ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"CreateModel",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DatasetName" => DatasetName,
"ModelName" => ModelName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model(
ClientToken,
DatasetName,
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DatasetName" => DatasetName,
"ModelName" => ModelName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_retraining_scheduler(client_token, lookback_window, model_name, retraining_frequency)
create_retraining_scheduler(client_token, lookback_window, model_name, retraining_frequency, params::Dict{String,<:Any})
Creates a retraining scheduler on the specified model.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client request
token, Amazon Lookout for Equipment generates one.
- `lookback_window`: The number of past days of data that will be used for retraining.
- `model_name`: The name of the model to add the retraining scheduler to.
- `retraining_frequency`: This parameter uses the ISO 8601 standard to set the frequency at
which you want retraining to occur in terms of Years, Months, and/or Days (note: other
parameters like Time are not currently supported). The minimum value is 30 days (P30D) and
the maximum value is 1 year (P1Y). For example, the following values are valid: P3M15D
– Every 3 months and 15 days P2M – Every 2 months P150D – Every 150 days
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PromoteMode"`: Indicates how the service will use new models. In MANAGED mode, new
models will automatically be used for inference if they have better performance than the
current model. In MANUAL mode, the new models will not be used until they are manually
activated.
- `"RetrainingStartDate"`: The start date for the retraining scheduler. Lookout for
Equipment truncates the time you provide to the nearest UTC day.
"""
function create_retraining_scheduler(
ClientToken,
LookbackWindow,
ModelName,
RetrainingFrequency;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateRetrainingScheduler",
Dict{String,Any}(
"ClientToken" => ClientToken,
"LookbackWindow" => LookbackWindow,
"ModelName" => ModelName,
"RetrainingFrequency" => RetrainingFrequency,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_retraining_scheduler(
ClientToken,
LookbackWindow,
ModelName,
RetrainingFrequency,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"CreateRetrainingScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"LookbackWindow" => LookbackWindow,
"ModelName" => ModelName,
"RetrainingFrequency" => RetrainingFrequency,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_name)
delete_dataset(dataset_name, params::Dict{String,<:Any})
Deletes a dataset and associated artifacts. The operation will check to see if any
inference scheduler or data ingestion job is currently using the dataset, and if there
isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted.
This does not affect any models that used this dataset for training and evaluation, but
does prevent it from being used in the future.
# Arguments
- `dataset_name`: The name of the dataset to be deleted.
"""
function delete_dataset(DatasetName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"DeleteDataset",
Dict{String,Any}("DatasetName" => DatasetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset(
DatasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetName" => DatasetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inference_scheduler(inference_scheduler_name)
delete_inference_scheduler(inference_scheduler_name, params::Dict{String,<:Any})
Deletes an inference scheduler that has been set up. Prior inference results will not be
deleted.
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler to be deleted.
"""
function delete_inference_scheduler(
InferenceSchedulerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DeleteInferenceScheduler",
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inference_scheduler(
InferenceSchedulerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteInferenceScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_label(label_group_name, label_id)
delete_label(label_group_name, label_id, params::Dict{String,<:Any})
Deletes a label.
# Arguments
- `label_group_name`: The name of the label group that contains the label that you want to
delete. Data in this field will be retained for service usage. Follow best practices for
the security of your data.
- `label_id`: The ID of the label that you want to delete.
"""
function delete_label(
LabelGroupName, LabelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DeleteLabel",
Dict{String,Any}("LabelGroupName" => LabelGroupName, "LabelId" => LabelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_label(
LabelGroupName,
LabelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteLabel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LabelGroupName" => LabelGroupName, "LabelId" => LabelId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_label_group(label_group_name)
delete_label_group(label_group_name, params::Dict{String,<:Any})
Deletes a group of labels.
# Arguments
- `label_group_name`: The name of the label group that you want to delete. Data in this
field will be retained for service usage. Follow best practices for the security of your
data.
"""
function delete_label_group(
LabelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DeleteLabelGroup",
Dict{String,Any}("LabelGroupName" => LabelGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_label_group(
LabelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteLabelGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LabelGroupName" => LabelGroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model(model_name)
delete_model(model_name, params::Dict{String,<:Any})
Deletes a machine learning model currently available for Amazon Lookout for Equipment. This
will prevent it from being used with an inference scheduler, even one that is already set
up.
# Arguments
- `model_name`: The name of the machine learning model to be deleted.
"""
function delete_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"DeleteModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Deletes the resource policy attached to the resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which the resource
policy should be deleted.
"""
function delete_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DeleteResourcePolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_retraining_scheduler(model_name)
delete_retraining_scheduler(model_name, params::Dict{String,<:Any})
Deletes a retraining scheduler from a model. The retraining scheduler must be in the
STOPPED status.
# Arguments
- `model_name`: The name of the model whose retraining scheduler you want to delete.
"""
function delete_retraining_scheduler(
ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DeleteRetrainingScheduler",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_retraining_scheduler(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DeleteRetrainingScheduler",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_ingestion_job(job_id)
describe_data_ingestion_job(job_id, params::Dict{String,<:Any})
Provides information on a specific data ingestion job such as creation time, dataset ARN,
and status.
# Arguments
- `job_id`: The job ID of the data ingestion job.
"""
function describe_data_ingestion_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeDataIngestionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_ingestion_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeDataIngestionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_name)
describe_dataset(dataset_name, params::Dict{String,<:Any})
Provides a JSON description of the data in each time series dataset, including names,
column names, and data types.
# Arguments
- `dataset_name`: The name of the dataset to be described.
"""
function describe_dataset(DatasetName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"DescribeDataset",
Dict{String,Any}("DatasetName" => DatasetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset(
DatasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetName" => DatasetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inference_scheduler(inference_scheduler_name)
describe_inference_scheduler(inference_scheduler_name, params::Dict{String,<:Any})
Specifies information about the inference scheduler being used, including name, model,
status, and associated metadata
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler being described.
"""
function describe_inference_scheduler(
InferenceSchedulerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeInferenceScheduler",
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inference_scheduler(
InferenceSchedulerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeInferenceScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_label(label_group_name, label_id)
describe_label(label_group_name, label_id, params::Dict{String,<:Any})
Returns the name of the label.
# Arguments
- `label_group_name`: Returns the name of the group containing the label.
- `label_id`: Returns the ID of the label.
"""
function describe_label(
LabelGroupName, LabelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeLabel",
Dict{String,Any}("LabelGroupName" => LabelGroupName, "LabelId" => LabelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_label(
LabelGroupName,
LabelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeLabel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LabelGroupName" => LabelGroupName, "LabelId" => LabelId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_label_group(label_group_name)
describe_label_group(label_group_name, params::Dict{String,<:Any})
Returns information about the label group.
# Arguments
- `label_group_name`: Returns the name of the label group.
"""
function describe_label_group(
LabelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeLabelGroup",
Dict{String,Any}("LabelGroupName" => LabelGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_label_group(
LabelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeLabelGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LabelGroupName" => LabelGroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model(model_name)
describe_model(model_name, params::Dict{String,<:Any})
Provides a JSON containing the overall information about a specific machine learning model,
including model name and ARN, dataset, training and evaluation information, status, and so
on.
# Arguments
- `model_name`: The name of the machine learning model to be described.
"""
function describe_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"DescribeModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_version(model_name, model_version)
describe_model_version(model_name, model_version, params::Dict{String,<:Any})
Retrieves information about a specific machine learning model version.
# Arguments
- `model_name`: The name of the machine learning model that this version belongs to.
- `model_version`: The version of the machine learning model.
"""
function describe_model_version(
ModelName, ModelVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeModelVersion",
Dict{String,Any}("ModelName" => ModelName, "ModelVersion" => ModelVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_version(
ModelName,
ModelVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelName" => ModelName, "ModelVersion" => ModelVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_policy(resource_arn)
describe_resource_policy(resource_arn, params::Dict{String,<:Any})
Provides the details of a resource policy attached to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that is associated with
the resource policy.
"""
function describe_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeResourcePolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_retraining_scheduler(model_name)
describe_retraining_scheduler(model_name, params::Dict{String,<:Any})
Provides a description of the retraining scheduler, including information such as the model
name and retraining parameters.
# Arguments
- `model_name`: The name of the model that the retraining scheduler is attached to.
"""
function describe_retraining_scheduler(
ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"DescribeRetrainingScheduler",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_retraining_scheduler(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"DescribeRetrainingScheduler",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_dataset(client_token, source_dataset_arn)
import_dataset(client_token, source_dataset_arn, params::Dict{String,<:Any})
Imports a dataset.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client request
token, Amazon Lookout for Equipment generates one.
- `source_dataset_arn`: The Amazon Resource Name (ARN) of the dataset to import.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetName"`: The name of the machine learning dataset to be created. If the dataset
already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't
specify this field, it is filled with the name of the source dataset.
- `"ServerSideKmsKeyId"`: Provides the identifier of the KMS key key used to encrypt model
data by Amazon Lookout for Equipment.
- `"Tags"`: Any tags associated with the dataset to be created.
"""
function import_dataset(
ClientToken, SourceDatasetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ImportDataset",
Dict{String,Any}(
"ClientToken" => ClientToken, "SourceDatasetArn" => SourceDatasetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_dataset(
ClientToken,
SourceDatasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ImportDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken, "SourceDatasetArn" => SourceDatasetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_model_version(client_token, dataset_name, source_model_version_arn)
import_model_version(client_token, dataset_name, source_model_version_arn, params::Dict{String,<:Any})
Imports a model that has been trained successfully.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client request
token, Amazon Lookout for Equipment generates one.
- `dataset_name`: The name of the dataset for the machine learning model being imported.
- `source_model_version_arn`: The Amazon Resource Name (ARN) of the model version to import.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InferenceDataImportStrategy"`: Indicates how to import the accumulated inference data
when a model version is imported. The possible values are as follows: NO_IMPORT – Don't
import the data. ADD_WHEN_EMPTY – Only import the data from the source model if there
is no existing data in the target model. OVERWRITE – Import the data from the source
model and overwrite the existing data in the target model.
- `"LabelsInputConfiguration"`:
- `"ModelName"`: The name for the machine learning model to be created. If the model
already exists, Amazon Lookout for Equipment creates a new version. If you do not specify
this field, it is filled with the name of the source model.
- `"RoleArn"`: The Amazon Resource Name (ARN) of a role with permission to access the data
source being used to create the machine learning model.
- `"ServerSideKmsKeyId"`: Provides the identifier of the KMS key key used to encrypt model
data by Amazon Lookout for Equipment.
- `"Tags"`: The tags associated with the machine learning model to be created.
"""
function import_model_version(
ClientToken,
DatasetName,
SourceModelVersionArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ImportModelVersion",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DatasetName" => DatasetName,
"SourceModelVersionArn" => SourceModelVersionArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_model_version(
ClientToken,
DatasetName,
SourceModelVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ImportModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DatasetName" => DatasetName,
"SourceModelVersionArn" => SourceModelVersionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_ingestion_jobs()
list_data_ingestion_jobs(params::Dict{String,<:Any})
Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of
the input data, status, and so on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetName"`: The name of the dataset being used for the data ingestion job.
- `"MaxResults"`: Specifies the maximum number of data ingestion jobs to list.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
data ingestion jobs.
- `"Status"`: Indicates the status of the data ingestion job.
"""
function list_data_ingestion_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListDataIngestionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_data_ingestion_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListDataIngestionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
Lists all datasets currently available in your account, filtering on the dataset name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetNameBeginsWith"`: The beginning of the name of the datasets to be listed.
- `"MaxResults"`: Specifies the maximum number of datasets to list.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
datasets.
"""
function list_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListDatasets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListDatasets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_inference_events(inference_scheduler_name, interval_end_time, interval_start_time)
list_inference_events(inference_scheduler_name, interval_end_time, interval_start_time, params::Dict{String,<:Any})
Lists all inference events that have been found for the specified inference scheduler.
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler for the inference events
listed.
- `interval_end_time`: Returns all the inference events with an end start time equal to or
greater than less than the end time given.
- `interval_start_time`: Lookout for Equipment will return all the inference events with
an end time equal to or greater than the start time given.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of inference events to list.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
inference events.
"""
function list_inference_events(
InferenceSchedulerName,
IntervalEndTime,
IntervalStartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListInferenceEvents",
Dict{String,Any}(
"InferenceSchedulerName" => InferenceSchedulerName,
"IntervalEndTime" => IntervalEndTime,
"IntervalStartTime" => IntervalStartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_inference_events(
InferenceSchedulerName,
IntervalEndTime,
IntervalStartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListInferenceEvents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InferenceSchedulerName" => InferenceSchedulerName,
"IntervalEndTime" => IntervalEndTime,
"IntervalStartTime" => IntervalStartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inference_executions(inference_scheduler_name)
list_inference_executions(inference_scheduler_name, params::Dict{String,<:Any})
Lists all inference executions that have been performed by the specified inference
scheduler.
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler for the inference
execution listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataEndTimeBefore"`: The time reference in the inferenced dataset before which Amazon
Lookout for Equipment stopped the inference execution.
- `"DataStartTimeAfter"`: The time reference in the inferenced dataset after which Amazon
Lookout for Equipment started the inference execution.
- `"MaxResults"`: Specifies the maximum number of inference executions to list.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
inference executions.
- `"Status"`: The status of the inference execution.
"""
function list_inference_executions(
InferenceSchedulerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListInferenceExecutions",
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_inference_executions(
InferenceSchedulerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListInferenceExecutions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inference_schedulers()
list_inference_schedulers(params::Dict{String,<:Any})
Retrieves a list of all inference schedulers currently available for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InferenceSchedulerNameBeginsWith"`: The beginning of the name of the inference
schedulers to be listed.
- `"MaxResults"`: Specifies the maximum number of inference schedulers to list.
- `"ModelName"`: The name of the machine learning model used by the inference scheduler to
be listed.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
inference schedulers.
- `"Status"`: Specifies the current status of the inference schedulers.
"""
function list_inference_schedulers(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListInferenceSchedulers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_inference_schedulers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListInferenceSchedulers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_label_groups()
list_label_groups(params::Dict{String,<:Any})
Returns a list of the label groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LabelGroupNameBeginsWith"`: The beginning of the name of the label groups to be
listed.
- `"MaxResults"`: Specifies the maximum number of label groups to list.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
label groups.
"""
function list_label_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListLabelGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_label_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListLabelGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_labels(label_group_name)
list_labels(label_group_name, params::Dict{String,<:Any})
Provides a list of labels.
# Arguments
- `label_group_name`: Returns the name of the label group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Equipment"`: Lists the labels that pertain to a particular piece of equipment.
- `"FaultCode"`: Returns labels with a particular fault code.
- `"IntervalEndTime"`: Returns all labels with a start time earlier than the end time
given.
- `"IntervalStartTime"`: Returns all the labels with a end time equal to or later than the
start time given.
- `"MaxResults"`: Specifies the maximum number of labels to list.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
label groups.
"""
function list_labels(LabelGroupName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListLabels",
Dict{String,Any}("LabelGroupName" => LabelGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_labels(
LabelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListLabels",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LabelGroupName" => LabelGroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_versions(model_name)
list_model_versions(model_name, params::Dict{String,<:Any})
Generates a list of all model versions for a given model, including the model version,
model version ARN, and status. To list a subset of versions, use the MaxModelVersion and
MinModelVersion fields.
# Arguments
- `model_name`: Then name of the machine learning model for which the model versions are to
be listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAtEndTime"`: Filter results to return all the model versions created before this
time.
- `"CreatedAtStartTime"`: Filter results to return all the model versions created after
this time.
- `"MaxModelVersion"`: Specifies the highest version of the model to return in the list.
- `"MaxResults"`: Specifies the maximum number of machine learning model versions to list.
- `"MinModelVersion"`: Specifies the lowest version of the model to return in the list.
- `"NextToken"`: If the total number of results exceeds the limit that the response can
display, the response returns an opaque pagination token indicating where to continue the
listing of machine learning model versions. Use this token in the NextToken field in the
request to list the next page of results.
- `"SourceType"`: Filter the results based on the way the model version was generated.
- `"Status"`: Filter the results based on the current status of the model version.
"""
function list_model_versions(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListModelVersions",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_versions(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListModelVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_models()
list_models(params::Dict{String,<:Any})
Generates a list of all models in the account, including model name and ARN, dataset, and
status.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetNameBeginsWith"`: The beginning of the name of the dataset of the machine
learning models to be listed.
- `"MaxResults"`: Specifies the maximum number of machine learning models to list.
- `"ModelNameBeginsWith"`: The beginning of the name of the machine learning models being
listed.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
machine learning models.
- `"Status"`: The status of the machine learning model.
"""
function list_models(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListModels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListModels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_retraining_schedulers()
list_retraining_schedulers(params::Dict{String,<:Any})
Lists all retraining schedulers in your account, filtering by model name prefix and status.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of retraining schedulers to list.
- `"ModelNameBeginsWith"`: Specify this field to only list retraining schedulers whose
machine learning models begin with the value you specify.
- `"NextToken"`: If the number of results exceeds the maximum, a pagination token is
returned. Use the token in the request to show the next page of retraining schedulers.
- `"Status"`: Specify this field to only list retraining schedulers whose status matches
the value you specify.
"""
function list_retraining_schedulers(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"ListRetrainingSchedulers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_retraining_schedulers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListRetrainingSchedulers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sensor_statistics(dataset_name)
list_sensor_statistics(dataset_name, params::Dict{String,<:Any})
Lists statistics about the data collected for each of the sensors that have been
successfully ingested in the particular dataset. Can also be used to retreive Sensor
Statistics for a previous ingestion job.
# Arguments
- `dataset_name`: The name of the dataset associated with the list of Sensor Statistics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IngestionJobId"`: The ingestion job id associated with the list of Sensor Statistics.
To get sensor statistics for a particular ingestion job id, both dataset name and ingestion
job id must be submitted as inputs.
- `"MaxResults"`: Specifies the maximum number of sensors for which to retrieve statistics.
- `"NextToken"`: An opaque pagination token indicating where to continue the listing of
sensor statistics.
"""
function list_sensor_statistics(
DatasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListSensorStatistics",
Dict{String,Any}("DatasetName" => DatasetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sensor_statistics(
DatasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListSensorStatistics",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetName" => DatasetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all the tags for a specified resource, including key and value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource (such as the dataset or
model) that is the focus of the ListTagsForResource operation.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(client_token, resource_arn, resource_policy)
put_resource_policy(client_token, resource_arn, resource_policy, params::Dict{String,<:Any})
Creates a resource control policy for a given resource.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client request
token, Amazon Lookout for Equipment generates one.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which the policy is
being created.
- `resource_policy`: The JSON-formatted resource policy to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyRevisionId"`: A unique identifier for a revision of the resource policy.
"""
function put_resource_policy(
ClientToken,
ResourceArn,
ResourcePolicy;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"PutResourcePolicy",
Dict{String,Any}(
"ClientToken" => ClientToken,
"ResourceArn" => ResourceArn,
"ResourcePolicy" => ResourcePolicy,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
ClientToken,
ResourceArn,
ResourcePolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"ResourceArn" => ResourceArn,
"ResourcePolicy" => ResourcePolicy,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_data_ingestion_job(client_token, dataset_name, ingestion_input_configuration, role_arn)
start_data_ingestion_job(client_token, dataset_name, ingestion_input_configuration, role_arn, params::Dict{String,<:Any})
Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
# Arguments
- `client_token`: A unique identifier for the request. If you do not set the client
request token, Amazon Lookout for Equipment generates one.
- `dataset_name`: The name of the dataset being used by the data ingestion job.
- `ingestion_input_configuration`: Specifies information for the input data for the data
ingestion job, including dataset S3 location.
- `role_arn`: The Amazon Resource Name (ARN) of a role with permission to access the data
source for the data ingestion job.
"""
function start_data_ingestion_job(
ClientToken,
DatasetName,
IngestionInputConfiguration,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"StartDataIngestionJob",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DatasetName" => DatasetName,
"IngestionInputConfiguration" => IngestionInputConfiguration,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_data_ingestion_job(
ClientToken,
DatasetName,
IngestionInputConfiguration,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"StartDataIngestionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DatasetName" => DatasetName,
"IngestionInputConfiguration" => IngestionInputConfiguration,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_inference_scheduler(inference_scheduler_name)
start_inference_scheduler(inference_scheduler_name, params::Dict{String,<:Any})
Starts an inference scheduler.
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler to be started.
"""
function start_inference_scheduler(
InferenceSchedulerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"StartInferenceScheduler",
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_inference_scheduler(
InferenceSchedulerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"StartInferenceScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_retraining_scheduler(model_name)
start_retraining_scheduler(model_name, params::Dict{String,<:Any})
Starts a retraining scheduler.
# Arguments
- `model_name`: The name of the model whose retraining scheduler you want to start.
"""
function start_retraining_scheduler(
ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"StartRetrainingScheduler",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_retraining_scheduler(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"StartRetrainingScheduler",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_inference_scheduler(inference_scheduler_name)
stop_inference_scheduler(inference_scheduler_name, params::Dict{String,<:Any})
Stops an inference scheduler.
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler to be stopped.
"""
function stop_inference_scheduler(
InferenceSchedulerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"StopInferenceScheduler",
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_inference_scheduler(
InferenceSchedulerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"StopInferenceScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_retraining_scheduler(model_name)
stop_retraining_scheduler(model_name, params::Dict{String,<:Any})
Stops a retraining scheduler.
# Arguments
- `model_name`: The name of the model whose retraining scheduler you want to stop.
"""
function stop_retraining_scheduler(
ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"StopRetrainingScheduler",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_retraining_scheduler(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"StopRetrainingScheduler",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates a given tag to a resource in your account. A tag is a key-value pair which can
be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for
organizing your resources as well as helping you to search and filter by tag. Multiple tags
can be added to a resource, either when you create it, or later. Up to 50 tags can be
associated with each resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the specific resource to which the tag
should be associated.
- `tags`: The tag or tags to be associated with a specific resource. Both the tag key and
value are specified.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a specific tag from a given resource. The tag is specified by its key.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which the tag is
currently associated.
- `tag_keys`: Specifies the key of the tag to be removed from a specified resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_active_model_version(model_name, model_version)
update_active_model_version(model_name, model_version, params::Dict{String,<:Any})
Sets the active model version for a given machine learning model.
# Arguments
- `model_name`: The name of the machine learning model for which the active model version
is being set.
- `model_version`: The version of the machine learning model for which the active model
version is being set.
"""
function update_active_model_version(
ModelName, ModelVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"UpdateActiveModelVersion",
Dict{String,Any}("ModelName" => ModelName, "ModelVersion" => ModelVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_active_model_version(
ModelName,
ModelVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"UpdateActiveModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelName" => ModelName, "ModelVersion" => ModelVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_inference_scheduler(inference_scheduler_name)
update_inference_scheduler(inference_scheduler_name, params::Dict{String,<:Any})
Updates an inference scheduler.
# Arguments
- `inference_scheduler_name`: The name of the inference scheduler to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataDelayOffsetInMinutes"`: A period of time (in minutes) by which inference on the
data is delayed after the data starts. For instance, if you select an offset delay time of
five minutes, inference will not begin on the data until the first data measurement after
the five minute mark. For example, if five minutes is selected, the inference scheduler
will wake up at the configured frequency with the additional five minute delay time to
check the customer S3 bucket. The customer can upload data at the same frequency and they
don't need to stop and restart the scheduler when uploading new data.
- `"DataInputConfiguration"`: Specifies information for the input data for the inference
scheduler, including delimiter, format, and dataset location.
- `"DataOutputConfiguration"`: Specifies information for the output results from the
inference scheduler, including the output S3 location.
- `"DataUploadFrequency"`: How often data is uploaded to the source S3 bucket for the input
data. The value chosen is the length of time between data uploads. For instance, if you
select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source
bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for
Equipment starts a scheduled inference on your data. In this example, it starts once every
5 minutes.
- `"RoleArn"`: The Amazon Resource Name (ARN) of a role with permission to access the data
source for the inference scheduler.
"""
function update_inference_scheduler(
InferenceSchedulerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"UpdateInferenceScheduler",
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_inference_scheduler(
InferenceSchedulerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"UpdateInferenceScheduler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceSchedulerName" => InferenceSchedulerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_label_group(label_group_name)
update_label_group(label_group_name, params::Dict{String,<:Any})
Updates the label group.
# Arguments
- `label_group_name`: The name of the label group to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FaultCodes"`: Updates the code indicating the type of anomaly associated with the
label. Data in this field will be retained for service usage. Follow best practices for
the security of your data.
"""
function update_label_group(
LabelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"UpdateLabelGroup",
Dict{String,Any}("LabelGroupName" => LabelGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_label_group(
LabelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"UpdateLabelGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LabelGroupName" => LabelGroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model(model_name)
update_model(model_name, params::Dict{String,<:Any})
Updates a model in the account.
# Arguments
- `model_name`: The name of the model to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LabelsInputConfiguration"`:
- `"ModelDiagnosticsOutputConfiguration"`: The Amazon S3 location where you want Amazon
Lookout for Equipment to save the pointwise model diagnostics for the model. You must also
specify the RoleArn request parameter.
- `"RoleArn"`: The ARN of the model to update.
"""
function update_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutequipment(
"UpdateModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"UpdateModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_retraining_scheduler(model_name)
update_retraining_scheduler(model_name, params::Dict{String,<:Any})
Updates a retraining scheduler.
# Arguments
- `model_name`: The name of the model whose retraining scheduler you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LookbackWindow"`: The number of past days of data that will be used for retraining.
- `"PromoteMode"`: Indicates how the service will use new models. In MANAGED mode, new
models will automatically be used for inference if they have better performance than the
current model. In MANUAL mode, the new models will not be used until they are manually
activated.
- `"RetrainingFrequency"`: This parameter uses the ISO 8601 standard to set the frequency
at which you want retraining to occur in terms of Years, Months, and/or Days (note: other
parameters like Time are not currently supported). The minimum value is 30 days (P30D) and
the maximum value is 1 year (P1Y). For example, the following values are valid: P3M15D
– Every 3 months and 15 days P2M – Every 2 months P150D – Every 150 days
- `"RetrainingStartDate"`: The start date for the retraining scheduler. Lookout for
Equipment truncates the time you provide to the nearest UTC day.
"""
function update_retraining_scheduler(
ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutequipment(
"UpdateRetrainingScheduler",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_retraining_scheduler(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutequipment(
"UpdateRetrainingScheduler",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 42261 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lookoutmetrics
using AWS.Compat
using AWS.UUIDs
"""
activate_anomaly_detector(anomaly_detector_arn)
activate_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})
Activates an anomaly detector.
# Arguments
- `anomaly_detector_arn`: The ARN of the anomaly detector.
"""
function activate_anomaly_detector(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/ActivateAnomalyDetector",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_anomaly_detector(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/ActivateAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
back_test_anomaly_detector(anomaly_detector_arn)
back_test_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})
Runs a backtest for anomaly detection for the specified resource.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
"""
function back_test_anomaly_detector(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/BackTestAnomalyDetector",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function back_test_anomaly_detector(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/BackTestAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_alert(action, alert_name, anomaly_detector_arn)
create_alert(action, alert_name, anomaly_detector_arn, params::Dict{String,<:Any})
Creates an alert for an anomaly detector.
# Arguments
- `action`: Action that will be triggered when there is an alert.
- `alert_name`: The name of the alert.
- `anomaly_detector_arn`: The ARN of the detector to which the alert is attached.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlertDescription"`: A description of the alert.
- `"AlertFilters"`: The configuration of the alert filters, containing MetricList and
DimensionFilterList.
- `"AlertSensitivityThreshold"`: An integer from 0 to 100 specifying the alert sensitivity
threshold.
- `"Tags"`: A list of tags to apply to the alert.
"""
function create_alert(
Action, AlertName, AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/CreateAlert",
Dict{String,Any}(
"Action" => Action,
"AlertName" => AlertName,
"AnomalyDetectorArn" => AnomalyDetectorArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alert(
Action,
AlertName,
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/CreateAlert",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Action" => Action,
"AlertName" => AlertName,
"AnomalyDetectorArn" => AnomalyDetectorArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_anomaly_detector(anomaly_detector_config, anomaly_detector_name)
create_anomaly_detector(anomaly_detector_config, anomaly_detector_name, params::Dict{String,<:Any})
Creates an anomaly detector.
# Arguments
- `anomaly_detector_config`: Contains information about the configuration of the anomaly
detector.
- `anomaly_detector_name`: The name of the detector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnomalyDetectorDescription"`: A description of the detector.
- `"KmsKeyArn"`: The ARN of the KMS key to use to encrypt your data.
- `"Tags"`: A list of tags to apply to the anomaly detector.
"""
function create_anomaly_detector(
AnomalyDetectorConfig,
AnomalyDetectorName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/CreateAnomalyDetector",
Dict{String,Any}(
"AnomalyDetectorConfig" => AnomalyDetectorConfig,
"AnomalyDetectorName" => AnomalyDetectorName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_anomaly_detector(
AnomalyDetectorConfig,
AnomalyDetectorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/CreateAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorConfig" => AnomalyDetectorConfig,
"AnomalyDetectorName" => AnomalyDetectorName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_metric_set(anomaly_detector_arn, metric_list, metric_set_name, metric_source)
create_metric_set(anomaly_detector_arn, metric_list, metric_set_name, metric_source, params::Dict{String,<:Any})
Creates a dataset.
# Arguments
- `anomaly_detector_arn`: The ARN of the anomaly detector that will use the dataset.
- `metric_list`: A list of metrics that the dataset will contain.
- `metric_set_name`: The name of the dataset.
- `metric_source`: Contains information about how the source data should be interpreted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DimensionFilterList"`: A list of filters that specify which data is kept for anomaly
detection.
- `"DimensionList"`: A list of the fields you want to treat as dimensions.
- `"MetricSetDescription"`: A description of the dataset you are creating.
- `"MetricSetFrequency"`: The frequency with which the source data will be analyzed for
anomalies.
- `"Offset"`: After an interval ends, the amount of seconds that the detector waits before
importing data. Offset is only supported for S3, Redshift, Athena and datasources.
- `"Tags"`: A list of tags to apply to the dataset.
- `"TimestampColumn"`: Contains information about the column used for tracking time in your
source data.
- `"Timezone"`: The time zone in which your source data was recorded.
"""
function create_metric_set(
AnomalyDetectorArn,
MetricList,
MetricSetName,
MetricSource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/CreateMetricSet",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"MetricList" => MetricList,
"MetricSetName" => MetricSetName,
"MetricSource" => MetricSource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_metric_set(
AnomalyDetectorArn,
MetricList,
MetricSetName,
MetricSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/CreateMetricSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"MetricList" => MetricList,
"MetricSetName" => MetricSetName,
"MetricSource" => MetricSource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_anomaly_detector(anomaly_detector_arn)
deactivate_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})
Deactivates an anomaly detector.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
"""
function deactivate_anomaly_detector(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/DeactivateAnomalyDetector",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_anomaly_detector(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DeactivateAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alert(alert_arn)
delete_alert(alert_arn, params::Dict{String,<:Any})
Deletes an alert.
# Arguments
- `alert_arn`: The ARN of the alert to delete.
"""
function delete_alert(AlertArn; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST",
"/DeleteAlert",
Dict{String,Any}("AlertArn" => AlertArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alert(
AlertArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DeleteAlert",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AlertArn" => AlertArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_anomaly_detector(anomaly_detector_arn)
delete_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})
Deletes a detector. Deleting an anomaly detector will delete all of its corresponding
resources including any configured datasets and alerts.
# Arguments
- `anomaly_detector_arn`: The ARN of the detector to delete.
"""
function delete_anomaly_detector(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/DeleteAnomalyDetector",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_anomaly_detector(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DeleteAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_alert(alert_arn)
describe_alert(alert_arn, params::Dict{String,<:Any})
Describes an alert. Amazon Lookout for Metrics API actions are eventually consistent. If
you do a read operation on a resource immediately after creating or modifying it, use
retries to allow time for the write operation to complete.
# Arguments
- `alert_arn`: The ARN of the alert to describe.
"""
function describe_alert(AlertArn; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST",
"/DescribeAlert",
Dict{String,Any}("AlertArn" => AlertArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_alert(
AlertArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DescribeAlert",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AlertArn" => AlertArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_anomaly_detection_executions(anomaly_detector_arn)
describe_anomaly_detection_executions(anomaly_detector_arn, params::Dict{String,<:Any})
Returns information about the status of the specified anomaly detection jobs.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of items to return in the response.
- `"NextToken"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"Timestamp"`: The timestamp of the anomaly detection job.
"""
function describe_anomaly_detection_executions(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/DescribeAnomalyDetectionExecutions",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_anomaly_detection_executions(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DescribeAnomalyDetectionExecutions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_anomaly_detector(anomaly_detector_arn)
describe_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})
Describes a detector. Amazon Lookout for Metrics API actions are eventually consistent. If
you do a read operation on a resource immediately after creating or modifying it, use
retries to allow time for the write operation to complete.
# Arguments
- `anomaly_detector_arn`: The ARN of the detector to describe.
"""
function describe_anomaly_detector(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/DescribeAnomalyDetector",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_anomaly_detector(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DescribeAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metric_set(metric_set_arn)
describe_metric_set(metric_set_arn, params::Dict{String,<:Any})
Describes a dataset. Amazon Lookout for Metrics API actions are eventually consistent. If
you do a read operation on a resource immediately after creating or modifying it, use
retries to allow time for the write operation to complete.
# Arguments
- `metric_set_arn`: The ARN of the dataset.
"""
function describe_metric_set(
MetricSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/DescribeMetricSet",
Dict{String,Any}("MetricSetArn" => MetricSetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metric_set(
MetricSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DescribeMetricSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MetricSetArn" => MetricSetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_metric_set_config(anomaly_detector_arn, auto_detection_metric_source)
detect_metric_set_config(anomaly_detector_arn, auto_detection_metric_source, params::Dict{String,<:Any})
Detects an Amazon S3 dataset's file format, interval, and offset.
# Arguments
- `anomaly_detector_arn`: An anomaly detector ARN.
- `auto_detection_metric_source`: A data source.
"""
function detect_metric_set_config(
AnomalyDetectorArn,
AutoDetectionMetricSource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DetectMetricSetConfig",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AutoDetectionMetricSource" => AutoDetectionMetricSource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_metric_set_config(
AnomalyDetectorArn,
AutoDetectionMetricSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/DetectMetricSetConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AutoDetectionMetricSource" => AutoDetectionMetricSource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_anomaly_group(anomaly_detector_arn, anomaly_group_id)
get_anomaly_group(anomaly_detector_arn, anomaly_group_id, params::Dict{String,<:Any})
Returns details about a group of anomalous metrics.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
- `anomaly_group_id`: The ID of the anomaly group.
"""
function get_anomaly_group(
AnomalyDetectorArn, AnomalyGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/GetAnomalyGroup",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn, "AnomalyGroupId" => AnomalyGroupId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_anomaly_group(
AnomalyDetectorArn,
AnomalyGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/GetAnomalyGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupId" => AnomalyGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_quality_metrics(anomaly_detector_arn)
get_data_quality_metrics(anomaly_detector_arn, params::Dict{String,<:Any})
Returns details about the requested data quality metrics.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector that you
want to investigate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MetricSetArn"`: The Amazon Resource Name (ARN) of a specific data quality metric set.
"""
function get_data_quality_metrics(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/GetDataQualityMetrics",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_quality_metrics(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/GetDataQualityMetrics",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback)
get_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback, params::Dict{String,<:Any})
Get feedback for an anomaly group.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
- `anomaly_group_time_series_feedback`: The anomalous metric and group ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
"""
function get_feedback(
AnomalyDetectorArn,
AnomalyGroupTimeSeriesFeedback;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/GetFeedback",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupTimeSeriesFeedback" => AnomalyGroupTimeSeriesFeedback,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_feedback(
AnomalyDetectorArn,
AnomalyGroupTimeSeriesFeedback,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/GetFeedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupTimeSeriesFeedback" => AnomalyGroupTimeSeriesFeedback,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sample_data()
get_sample_data(params::Dict{String,<:Any})
Returns a selection of sample records from an Amazon S3 datasource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"S3SourceConfig"`: A datasource bucket in Amazon S3.
"""
function get_sample_data(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST", "/GetSampleData"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_sample_data(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/GetSampleData",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_alerts()
list_alerts(params::Dict{String,<:Any})
Lists the alerts attached to a detector. Amazon Lookout for Metrics API actions are
eventually consistent. If you do a read operation on a resource immediately after creating
or modifying it, use retries to allow time for the write operation to complete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnomalyDetectorArn"`: The ARN of the alert's detector.
- `"MaxResults"`: The maximum number of results that will be displayed by the request.
- `"NextToken"`: If the result of the previous request is truncated, the response includes
a NextToken. To retrieve the next set of results, use the token in the next request. Tokens
expire after 24 hours.
"""
function list_alerts(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST", "/ListAlerts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_alerts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/ListAlerts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_anomaly_detectors()
list_anomaly_detectors(params::Dict{String,<:Any})
Lists the detectors in the current AWS Region. Amazon Lookout for Metrics API actions are
eventually consistent. If you do a read operation on a resource immediately after creating
or modifying it, use retries to allow time for the write operation to complete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: If the result of the previous request was truncated, the response includes
a NextToken. To retrieve the next set of results, use the token in the next request. Tokens
expire after 24 hours.
"""
function list_anomaly_detectors(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST",
"/ListAnomalyDetectors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_anomaly_detectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/ListAnomalyDetectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_anomaly_group_related_metrics(anomaly_detector_arn, anomaly_group_id)
list_anomaly_group_related_metrics(anomaly_detector_arn, anomaly_group_id, params::Dict{String,<:Any})
Returns a list of measures that are potential causes or effects of an anomaly group.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
- `anomaly_group_id`: The ID of the anomaly group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
- `"RelationshipTypeFilter"`: Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or
downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.
"""
function list_anomaly_group_related_metrics(
AnomalyDetectorArn, AnomalyGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/ListAnomalyGroupRelatedMetrics",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn, "AnomalyGroupId" => AnomalyGroupId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_anomaly_group_related_metrics(
AnomalyDetectorArn,
AnomalyGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/ListAnomalyGroupRelatedMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupId" => AnomalyGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_anomaly_group_summaries(anomaly_detector_arn, sensitivity_threshold)
list_anomaly_group_summaries(anomaly_detector_arn, sensitivity_threshold, params::Dict{String,<:Any})
Returns a list of anomaly groups.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
- `sensitivity_threshold`: The minimum severity score for inclusion in the output.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
"""
function list_anomaly_group_summaries(
AnomalyDetectorArn,
SensitivityThreshold;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/ListAnomalyGroupSummaries",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"SensitivityThreshold" => SensitivityThreshold,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_anomaly_group_summaries(
AnomalyDetectorArn,
SensitivityThreshold,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/ListAnomalyGroupSummaries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"SensitivityThreshold" => SensitivityThreshold,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_anomaly_group_time_series(anomaly_detector_arn, anomaly_group_id, metric_name)
list_anomaly_group_time_series(anomaly_detector_arn, anomaly_group_id, metric_name, params::Dict{String,<:Any})
Gets a list of anomalous metrics for a measure in an anomaly group.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
- `anomaly_group_id`: The ID of the anomaly group.
- `metric_name`: The name of the measure field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: Specify the pagination token that's returned by a previous request to
retrieve the next page of results.
"""
function list_anomaly_group_time_series(
AnomalyDetectorArn,
AnomalyGroupId,
MetricName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/ListAnomalyGroupTimeSeries",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupId" => AnomalyGroupId,
"MetricName" => MetricName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_anomaly_group_time_series(
AnomalyDetectorArn,
AnomalyGroupId,
MetricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/ListAnomalyGroupTimeSeries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupId" => AnomalyGroupId,
"MetricName" => MetricName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_metric_sets()
list_metric_sets(params::Dict{String,<:Any})
Lists the datasets in the current AWS Region. Amazon Lookout for Metrics API actions are
eventually consistent. If you do a read operation on a resource immediately after creating
or modifying it, use retries to allow time for the write operation to complete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnomalyDetectorArn"`: The ARN of the anomaly detector containing the metrics sets to
list.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: If the result of the previous request was truncated, the response includes
a NextToken. To retrieve the next set of results, use the token in the next request. Tokens
expire after 24 hours.
"""
function list_metric_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST", "/ListMetricSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_metric_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/ListMetricSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets a list of tags for a detector, dataset, or alert.
# Arguments
- `resource_arn`: The resource's Amazon Resource Name (ARN).
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback)
put_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback, params::Dict{String,<:Any})
Add feedback for an anomalous metric.
# Arguments
- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector.
- `anomaly_group_time_series_feedback`: Feedback for an anomalous metric.
"""
function put_feedback(
AnomalyDetectorArn,
AnomalyGroupTimeSeriesFeedback;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/PutFeedback",
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupTimeSeriesFeedback" => AnomalyGroupTimeSeriesFeedback,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_feedback(
AnomalyDetectorArn,
AnomalyGroupTimeSeriesFeedback,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/PutFeedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnomalyDetectorArn" => AnomalyDetectorArn,
"AnomalyGroupTimeSeriesFeedback" => AnomalyGroupTimeSeriesFeedback,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to a detector, dataset, or alert.
# Arguments
- `resource_arn`: The resource's Amazon Resource Name (ARN).
- `tags`: Tags to apply to the resource. Tag keys and values can contain letters, numbers,
spaces, and the following symbols: _.:/=+@-
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a detector, dataset, or alert.
# Arguments
- `resource_arn`: The resource's Amazon Resource Name (ARN).
- `tag_keys`: Keys to remove from the resource's tags.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_alert(alert_arn)
update_alert(alert_arn, params::Dict{String,<:Any})
Make changes to an existing alert.
# Arguments
- `alert_arn`: The ARN of the alert to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Action"`: Action that will be triggered when there is an alert.
- `"AlertDescription"`: A description of the alert.
- `"AlertFilters"`: The configuration of the alert filters, containing MetricList and
DimensionFilterList.
- `"AlertSensitivityThreshold"`: An integer from 0 to 100 specifying the alert sensitivity
threshold.
"""
function update_alert(AlertArn; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST",
"/UpdateAlert",
Dict{String,Any}("AlertArn" => AlertArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_alert(
AlertArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/UpdateAlert",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AlertArn" => AlertArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_anomaly_detector(anomaly_detector_arn)
update_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})
Updates a detector. After activation, you can only change a detector's ingestion delay and
description.
# Arguments
- `anomaly_detector_arn`: The ARN of the detector to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnomalyDetectorConfig"`: Contains information about the configuration to which the
detector will be updated.
- `"AnomalyDetectorDescription"`: The updated detector description.
- `"KmsKeyArn"`: The Amazon Resource Name (ARN) of an AWS KMS encryption key.
"""
function update_anomaly_detector(
AnomalyDetectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutmetrics(
"POST",
"/UpdateAnomalyDetector",
Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_anomaly_detector(
AnomalyDetectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/UpdateAnomalyDetector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AnomalyDetectorArn" => AnomalyDetectorArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_metric_set(metric_set_arn)
update_metric_set(metric_set_arn, params::Dict{String,<:Any})
Updates a dataset.
# Arguments
- `metric_set_arn`: The ARN of the dataset to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DimensionFilterList"`: Describes a list of filters for choosing specific dimensions and
specific values. Each filter consists of the dimension and one of its values that you want
to include. When multiple dimensions or values are specified, the dimensions are joined
with an AND operation and the values are joined with an OR operation.
- `"DimensionList"`: The dimension list.
- `"MetricList"`: The metric list.
- `"MetricSetDescription"`: The dataset's description.
- `"MetricSetFrequency"`: The dataset's interval.
- `"MetricSource"`:
- `"Offset"`: After an interval ends, the amount of seconds that the detector waits before
importing data. Offset is only supported for S3, Redshift, Athena and datasources.
- `"TimestampColumn"`: The timestamp column.
"""
function update_metric_set(MetricSetArn; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutmetrics(
"POST",
"/UpdateMetricSet",
Dict{String,Any}("MetricSetArn" => MetricSetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_metric_set(
MetricSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutmetrics(
"POST",
"/UpdateMetricSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MetricSetArn" => MetricSetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 48582 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: lookoutvision
using AWS.Compat
using AWS.UUIDs
"""
create_dataset(dataset_type, project_name)
create_dataset(dataset_type, project_name, params::Dict{String,<:Any})
Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a
training or a test dataset from a valid dataset source (DatasetSource). If you want a
single dataset project, specify train for the value of DatasetType. To have a project with
separate training and test datasets, call CreateDataset twice. On the first call, specify
train for the value of DatasetType. On the second call, specify test for the value of
DatasetType. This operation requires permissions to perform the
lookoutvision:CreateDataset operation.
# Arguments
- `dataset_type`: The type of the dataset. Specify train for a training dataset. Specify
test for a test dataset.
- `project_name`: The name of the project in which you want to create a dataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetSource"`: The location of the manifest file that Amazon Lookout for Vision uses
to create the dataset. If you don't specify DatasetSource, an empty dataset is created and
the operation synchronously returns. Later, you can add JSON Lines by calling
UpdateDatasetEntries. If you specify a value for DataSource, the manifest at the S3
location is validated and used to create the dataset. The call to CreateDataset is
asynchronous and might take a while to complete. To find out the current status, Check the
value of Status returned in a call to DescribeDataset.
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
CreateDataset completes only once. You choose the value to pass. For example, An issue
might prevent you from getting a response from CreateDataset. In this case, safely retry
your call to CreateDataset by using the same ClientToken parameter value. If you don't
supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
prevents retries after a network error from making multiple dataset creation requests.
You'll need to provide your own value for other use cases. An error occurs if the other
input parameters are not the same as in the first request. Using a different value for
ClientToken is considered a new call to CreateDataset. An idempotency token is active for 8
hours.
"""
function create_dataset(
DatasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/datasets",
Dict{String,Any}(
"DatasetType" => DatasetType, "X-Amzn-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
DatasetType,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/datasets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetType" => DatasetType, "X-Amzn-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model(output_config, project_name)
create_model(output_config, project_name, params::Dict{String,<:Any})
Creates a new version of a model within an an Amazon Lookout for Vision project.
CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests,
and evaluates a new version of a model. To get the current status, check the Status field
returned in the response from DescribeModel. If the project has a single dataset, Amazon
Lookout for Vision internally splits the dataset to create a training and a test dataset.
If the project has a training and a test dataset, Lookout for Vision uses the respective
datasets to train and test the model. After training completes, the evaluation metrics are
stored at the location specified in OutputConfig. This operation requires permissions to
perform the lookoutvision:CreateModel operation. If you want to tag your model, you also
require permission to the lookoutvision:TagResource operation.
# Arguments
- `output_config`: The location where Amazon Lookout for Vision saves the training results.
- `project_name`: The name of the project in which you want to create a model version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the version of the model.
- `"KmsKeyId"`: The identifier for your AWS KMS key. The key is used to encrypt training
and test images copied into the service for model training. Your source images are
unaffected. If this parameter is not specified, the copied images are encrypted by a key
that AWS owns and manages.
- `"Tags"`: A set of tags (key-value pairs) that you want to attach to the model.
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
CreateModel completes only once. You choose the value to pass. For example, An issue might
prevent you from getting a response from CreateModel. In this case, safely retry your call
to CreateModel by using the same ClientToken parameter value. If you don't supply a value
for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries
after a network error from starting multiple training jobs. You'll need to provide your own
value for other use cases. An error occurs if the other input parameters are not the same
as in the first request. Using a different value for ClientToken is considered a new call
to CreateModel. An idempotency token is active for 8 hours.
"""
function create_model(
OutputConfig, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models",
Dict{String,Any}(
"OutputConfig" => OutputConfig, "X-Amzn-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model(
OutputConfig,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputConfig" => OutputConfig, "X-Amzn-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(project_name)
create_project(project_name, params::Dict{String,<:Any})
Creates an empty Amazon Lookout for Vision project. After you create the project, add a
dataset by calling CreateDataset. This operation requires permissions to perform the
lookoutvision:CreateProject operation.
# Arguments
- `project_name`: The name for the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
CreateProject completes only once. You choose the value to pass. For example, An issue
might prevent you from getting a response from CreateProject. In this case, safely retry
your call to CreateProject by using the same ClientToken parameter value. If you don't
supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
prevents retries after a network error from making multiple project creation requests.
You'll need to provide your own value for other use cases. An error occurs if the other
input parameters are not the same as in the first request. Using a different value for
ClientToken is considered a new call to CreateProject. An idempotency token is active for 8
hours.
"""
function create_project(ProjectName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutvision(
"POST",
"/2020-11-20/projects",
Dict{String,Any}(
"ProjectName" => ProjectName, "X-Amzn-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
ProjectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProjectName" => ProjectName, "X-Amzn-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_type, project_name)
delete_dataset(dataset_type, project_name, params::Dict{String,<:Any})
Deletes an existing Amazon Lookout for Vision dataset. If your the project has a single
dataset, you must create a new dataset before you can create a model. If you project has a
training dataset and a test dataset consider the following. If you delete the test
dataset, your project reverts to a single dataset project. If you then train the model,
Amazon Lookout for Vision internally splits the remaining dataset into a training and test
dataset. If you delete the training dataset, you must create a training dataset before
you can create a model. This operation requires permissions to perform the
lookoutvision:DeleteDataset operation.
# Arguments
- `dataset_type`: The type of the dataset to delete. Specify train to delete the training
dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset
project, specify train.
- `project_name`: The name of the project that contains the dataset that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
DeleteDataset completes only once. You choose the value to pass. For example, An issue
might prevent you from getting a response from DeleteDataset. In this case, safely retry
your call to DeleteDataset by using the same ClientToken parameter value. If you don't
supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
prevents retries after a network error from making multiple deletetion requests. You'll
need to provide your own value for other use cases. An error occurs if the other input
parameters are not the same as in the first request. Using a different value for
ClientToken is considered a new call to DeleteDataset. An idempotency token is active for 8
hours.
"""
function delete_dataset(
datasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"DELETE",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)",
Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset(
datasetType,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"DELETE",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model(model_version, project_name)
delete_model(model_version, project_name, params::Dict{String,<:Any})
Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a
running model, use the StopModel operation. It might take a few seconds to delete a model.
To determine if a model has been deleted, call ListModels and check if the version of the
model (ModelVersion) is in the Models array. This operation requires permissions to
perform the lookoutvision:DeleteModel operation.
# Arguments
- `model_version`: The version of the model that you want to delete.
- `project_name`: The name of the project that contains the model that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
DeleteModel completes only once. You choose the value to pass. For example, an issue might
prevent you from getting a response from DeleteModel. In this case, safely retry your call
to DeleteModel by using the same ClientToken parameter value. If you don't supply a value
for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries
after a network error from making multiple model deletion requests. You'll need to provide
your own value for other use cases. An error occurs if the other input parameters are not
the same as in the first request. Using a different value for ClientToken is considered a
new call to DeleteModel. An idempotency token is active for 8 hours.
"""
function delete_model(
modelVersion, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"DELETE",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)",
Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model(
modelVersion,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"DELETE",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(project_name)
delete_project(project_name, params::Dict{String,<:Any})
Deletes an Amazon Lookout for Vision project. To delete a project, you must first delete
each version of the model associated with the project. To delete a model use the
DeleteModel operation. You also have to delete the dataset(s) associated with the model.
For more information, see DeleteDataset. The images referenced by the training and test
datasets aren't deleted. This operation requires permissions to perform the
lookoutvision:DeleteProject operation.
# Arguments
- `project_name`: The name of the project to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
DeleteProject completes only once. You choose the value to pass. For example, An issue
might prevent you from getting a response from DeleteProject. In this case, safely retry
your call to DeleteProject by using the same ClientToken parameter value. If you don't
supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
prevents retries after a network error from making multiple project deletion requests.
You'll need to provide your own value for other use cases. An error occurs if the other
input parameters are not the same as in the first request. Using a different value for
ClientToken is considered a new call to DeleteProject. An idempotency token is active for 8
hours.
"""
function delete_project(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutvision(
"DELETE",
"/2020-11-20/projects/$(projectName)",
Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"DELETE",
"/2020-11-20/projects/$(projectName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_type, project_name)
describe_dataset(dataset_type, project_name, params::Dict{String,<:Any})
Describe an Amazon Lookout for Vision dataset. This operation requires permissions to
perform the lookoutvision:DescribeDataset operation.
# Arguments
- `dataset_type`: The type of the dataset to describe. Specify train to describe the
training dataset. Specify test to describe the test dataset. If you have a single dataset
project, specify train
- `project_name`: The name of the project that contains the dataset that you want to
describe.
"""
function describe_dataset(
datasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset(
datasetType,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model(model_version, project_name)
describe_model(model_version, project_name, params::Dict{String,<:Any})
Describes a version of an Amazon Lookout for Vision model. This operation requires
permissions to perform the lookoutvision:DescribeModel operation.
# Arguments
- `model_version`: The version of the model that you want to describe.
- `project_name`: The project that contains the version of a model that you want to
describe.
"""
function describe_model(
modelVersion, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model(
modelVersion,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_packaging_job(job_name, project_name)
describe_model_packaging_job(job_name, project_name, params::Dict{String,<:Any})
Describes an Amazon Lookout for Vision model packaging job. This operation requires
permissions to perform the lookoutvision:DescribeModelPackagingJob operation. For more
information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
Lookout for Vision Developer Guide.
# Arguments
- `job_name`: The job name for the model packaging job.
- `project_name`: The name of the project that contains the model packaging job that you
want to describe.
"""
function describe_model_packaging_job(
jobName, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/modelpackagingjobs/$(jobName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_packaging_job(
jobName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/modelpackagingjobs/$(jobName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(project_name)
describe_project(project_name, params::Dict{String,<:Any})
Describes an Amazon Lookout for Vision project. This operation requires permissions to
perform the lookoutvision:DescribeProject operation.
# Arguments
- `project_name`: The name of the project that you want to describe.
"""
function describe_project(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_project(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_anomalies(body, content-_type, model_version, project_name)
detect_anomalies(body, content-_type, model_version, project_name, params::Dict{String,<:Any})
Detects anomalies in an image that you supply. The response from DetectAnomalies includes
a boolean prediction that the image contains one or more anomalies and a confidence value
for the prediction. If the model is an image segmentation model, the response also includes
segmentation information for each type of anomaly found in the image. Before calling
DetectAnomalies, you must first start your model with the StartModel operation. You are
charged for the amount of time, in minutes, that a model runs and for the number of anomaly
detection units that your model uses. If you are not using a model, use the StopModel
operation to stop your model. For more information, see Detecting anomalies in an image
in the Amazon Lookout for Vision developer guide. This operation requires permissions to
perform the lookoutvision:DetectAnomalies operation.
# Arguments
- `body`: The unencrypted image bytes that you want to analyze.
- `content-_type`: The type of the image passed in Body. Valid values are image/png (PNG
format images) and image/jpeg (JPG format images).
- `model_version`: The version of the model that you want to use.
- `project_name`: The name of the project that contains the model version that you want to
use.
"""
function detect_anomalies(
Body,
Content_Type,
modelVersion,
projectName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)/detect",
Dict{String,Any}(
"Body" => Body, "headers" => Dict{String,Any}("Content-Type" => Content_Type)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_anomalies(
Body,
Content_Type,
modelVersion,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)/detect",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Body" => Body,
"headers" => Dict{String,Any}("Content-Type" => Content_Type),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dataset_entries(dataset_type, project_name)
list_dataset_entries(dataset_type, project_name, params::Dict{String,<:Any})
Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the
anomaly information for a single image, including the image location and the assigned
label. This operation requires permissions to perform the lookoutvision:ListDatasetEntries
operation.
# Arguments
- `dataset_type`: The type of the dataset that you want to list. Specify train to list the
training dataset. Specify test to list the test dataset. If you have a single dataset
project, specify train.
- `project_name`: The name of the project that contains the dataset that you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"anomalyClass"`: Specify normal to include only normal images. Specify anomaly to only
include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns
normal and anomalous images.
- `"createdAfter"`: Only includes entries after the specified date in the response. For
example, 2020-06-23T00:00:00.
- `"createdBefore"`: Only includes entries before the specified date in the response. For
example, 2020-06-23T00:00:00.
- `"labeled"`: Specify true to include labeled entries, otherwise specify false. If you
don't specify a value, Lookout for Vision returns all entries.
- `"maxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"nextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can
use this pagination token to retrieve the next set of dataset entries.
- `"sourceRefContains"`: Perform a \"contains\" search on the values of the source-ref key
within the dataset. For example a value of \"IMG_17\" returns all JSON Lines where the
source-ref key value matches *IMG_17*.
"""
function list_dataset_entries(
datasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)/entries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dataset_entries(
datasetType,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)/entries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_packaging_jobs(project_name)
list_model_packaging_jobs(project_name, params::Dict{String,<:Any})
Lists the model packaging jobs created for an Amazon Lookout for Vision project. This
operation requires permissions to perform the lookoutvision:ListModelPackagingJobs
operation. For more information, see Using your Amazon Lookout for Vision model on an edge
device in the Amazon Lookout for Vision Developer Guide.
# Arguments
- `project_name`: The name of the project for which you want to list the model packaging
jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"nextToken"`: If the previous response was incomplete (because there is more results to
retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can
use this pagination token to retrieve the next set of results.
"""
function list_model_packaging_jobs(
projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/modelpackagingjobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_packaging_jobs(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/modelpackagingjobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_models(project_name)
list_models(project_name, params::Dict{String,<:Any})
Lists the versions of a model in an Amazon Lookout for Vision project. The ListModels
operation is eventually consistent. Recent calls to CreateModel might take a while to
appear in the response from ListProjects. This operation requires permissions to perform
the lookoutvision:ListModels operation.
# Arguments
- `project_name`: The name of the project that contains the model versions that you want to
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"nextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can
use this pagination token to retrieve the next set of models.
"""
function list_models(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/models";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_models(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/projects/$(projectName)/models",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region
in which you call ListProjects. The ListProjects operation is eventually consistent. Recent
calls to CreateProject and DeleteProject might take a while to appear in the response from
ListProjects. This operation requires permissions to perform the lookoutvision:ListProjects
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"nextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can
use this pagination token to retrieve the next set of projects.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutvision(
"GET",
"/2020-11-20/projects";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/projects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of tags attached to the specified Amazon Lookout for Vision model. This
operation requires permissions to perform the lookoutvision:ListTagsForResource operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the model for which you want to list
tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"GET",
"/2020-11-20/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"GET",
"/2020-11-20/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_model(min_inference_units, model_version, project_name)
start_model(min_inference_units, model_version, project_name, params::Dict{String,<:Any})
Starts the running of the version of an Amazon Lookout for Vision model. Starting a model
takes a while to complete. To check the current state of the model, use DescribeModel. A
model is ready to use when its status is HOSTED. Once the model is running, you can detect
custom labels in new images by calling DetectAnomalies. You are charged for the amount of
time that the model is running. To stop a running model, call StopModel. This operation
requires permissions to perform the lookoutvision:StartModel operation.
# Arguments
- `min_inference_units`: The minimum number of inference units to use. A single inference
unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of
your model. You are charged for the number of inference units that you use.
- `model_version`: The version of the model that you want to start.
- `project_name`: The name of the project that contains the model that you want to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxInferenceUnits"`: The maximum number of inference units to use for auto-scaling the
model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
StartModel completes only once. You choose the value to pass. For example, An issue might
prevent you from getting a response from StartModel. In this case, safely retry your call
to StartModel by using the same ClientToken parameter value. If you don't supply a value
for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries
after a network error from making multiple start requests. You'll need to provide your own
value for other use cases. An error occurs if the other input parameters are not the same
as in the first request. Using a different value for ClientToken is considered a new call
to StartModel. An idempotency token is active for 8 hours.
"""
function start_model(
MinInferenceUnits,
modelVersion,
projectName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)/start",
Dict{String,Any}(
"MinInferenceUnits" => MinInferenceUnits,
"X-Amzn-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_model(
MinInferenceUnits,
modelVersion,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)/start",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MinInferenceUnits" => MinInferenceUnits,
"X-Amzn-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_model_packaging_job(configuration, model_version, project_name)
start_model_packaging_job(configuration, model_version, project_name, params::Dict{String,<:Any})
Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an
AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to
deploy your model to an edge device managed by Greengrass. Use the
DescribeModelPackagingJob API to determine the current status of the job. The model
packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to
the target device, use the component name and component version with the AWS IoT Greengrass
CreateDeployment API. This operation requires the following permissions:
lookoutvision:StartModelPackagingJob s3:PutObject s3:GetBucketLocation
kms:GenerateDataKey greengrass:CreateComponentVersion greengrass:DescribeComponent
(Optional) greengrass:TagResource. Only required if you want to tag the component. For
more information, see Using your Amazon Lookout for Vision model on an edge device in the
Amazon Lookout for Vision Developer Guide.
# Arguments
- `configuration`: The configuration for the model packaging job.
- `model_version`: The version of the model within the project that you want to package.
- `project_name`: The name of the project which contains the version of the model that you
want to package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the model packaging job.
- `"JobName"`: A name for the model packaging job. If you don't supply a value, the service
creates a job name for you.
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
StartModelPackagingJob completes only once. You choose the value to pass. For example, An
issue might prevent you from getting a response from StartModelPackagingJob. In this case,
safely retry your call to StartModelPackagingJob by using the same ClientToken parameter
value. If you don't supply a value for ClientToken, the AWS SDK you are using inserts a
value for you. This prevents retries after a network error from making multiple dataset
creation requests. You'll need to provide your own value for other use cases. An error
occurs if the other input parameters are not the same as in the first request. Using a
different value for ClientToken is considered a new call to StartModelPackagingJob. An
idempotency token is active for 8 hours.
"""
function start_model_packaging_job(
Configuration,
ModelVersion,
projectName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/modelpackagingjobs",
Dict{String,Any}(
"Configuration" => Configuration,
"ModelVersion" => ModelVersion,
"X-Amzn-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_model_packaging_job(
Configuration,
ModelVersion,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/modelpackagingjobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Configuration" => Configuration,
"ModelVersion" => ModelVersion,
"X-Amzn-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_model(model_version, project_name)
stop_model(model_version, project_name, params::Dict{String,<:Any})
Stops the hosting of a running model. The operation might take a while to complete. To
check the current status, call DescribeModel. After the model hosting stops, the Status of
the model is TRAINED. This operation requires permissions to perform the
lookoutvision:StopModel operation.
# Arguments
- `model_version`: The version of the model that you want to stop.
- `project_name`: The name of the project that contains the model that you want to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
StopModel completes only once. You choose the value to pass. For example, An issue might
prevent you from getting a response from StopModel. In this case, safely retry your call to
StopModel by using the same ClientToken parameter value. If you don't supply a value for
ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after
a network error from making multiple stop requests. You'll need to provide your own value
for other use cases. An error occurs if the other input parameters are not the same as in
the first request. Using a different value for ClientToken is considered a new call to
StopModel. An idempotency token is active for 8 hours.
"""
function stop_model(
modelVersion, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)/stop",
Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_model(
modelVersion,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/projects/$(projectName)/models/$(modelVersion)/stop",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amzn-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})
Adds one or more key-value tags to an Amazon Lookout for Vision model. For more
information, see Tagging a model in the Amazon Lookout for Vision Developer Guide. This
operation requires permissions to perform the lookoutvision:TagResource operation.
# Arguments
- `tags`: The key-value tags to assign to the model.
- `resource_arn`: The Amazon Resource Name (ARN) of the model to assign the tags.
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return lookoutvision(
"POST",
"/2020-11-20/tags/$(resourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Tags,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"POST",
"/2020-11-20/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from an Amazon Lookout for Vision model. For more information, see
Tagging a model in the Amazon Lookout for Vision Developer Guide. This operation requires
permissions to perform the lookoutvision:UntagResource operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the model from which you want to remove
tags.
- `tag_keys`: A list of the keys of the tags that you want to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"DELETE",
"/2020-11-20/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"DELETE",
"/2020-11-20/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dataset_entries(changes, dataset_type, project_name)
update_dataset_entries(changes, dataset_type, project_name, params::Dict{String,<:Any})
Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes
information about an image used for training or testing an Amazon Lookout for Vision model.
To update an existing JSON Line, use the source-ref field to identify the JSON Line. The
JSON line that you supply replaces the existing JSON line. Any existing annotations that
are not in the new JSON line are removed from the dataset. For more information, see
Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer
Guide. The images you reference in the source-ref field of a JSON line, must be in the
same S3 bucket as the existing images in the dataset. Updating a dataset might take a
while to complete. To check the current status, call DescribeDataset and check the Status
field in the response. This operation requires permissions to perform the
lookoutvision:UpdateDatasetEntries operation.
# Arguments
- `changes`: The entries to add to the dataset.
- `dataset_type`: The type of the dataset that you want to update. Specify train to update
the training dataset. Specify test to update the test dataset. If you have a single dataset
project, specify train.
- `project_name`: The name of the project that contains the dataset that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to
UpdateDatasetEntries completes only once. You choose the value to pass. For example, An
issue might prevent you from getting a response from UpdateDatasetEntries. In this case,
safely retry your call to UpdateDatasetEntries by using the same ClientToken parameter
value. If you don't supply a value for ClientToken, the AWS SDK you are using inserts a
value for you. This prevents retries after a network error from making multiple updates
with the same dataset entries. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request.
Using a different value for ClientToken is considered a new call to UpdateDatasetEntries.
An idempotency token is active for 8 hours.
"""
function update_dataset_entries(
Changes, datasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return lookoutvision(
"PATCH",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)/entries",
Dict{String,Any}("Changes" => Changes, "X-Amzn-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset_entries(
Changes,
datasetType,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return lookoutvision(
"PATCH",
"/2020-11-20/projects/$(projectName)/datasets/$(datasetType)/entries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Changes" => Changes, "X-Amzn-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 45203 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: m2
using AWS.Compat
using AWS.UUIDs
"""
cancel_batch_job_execution(application_id, execution_id)
cancel_batch_job_execution(application_id, execution_id, params::Dict{String,<:Any})
Cancels the running of a specific batch job execution.
# Arguments
- `application_id`: The unique identifier of the application.
- `execution_id`: The unique identifier of the batch job execution.
"""
function cancel_batch_job_execution(
applicationId, executionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications/$(applicationId)/batch-job-executions/$(executionId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_batch_job_execution(
applicationId,
executionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/batch-job-executions/$(executionId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(definition, engine_type, name)
create_application(definition, engine_type, name, params::Dict{String,<:Any})
Creates a new application with given parameters. Requires an existing runtime environment
and application definition file.
# Arguments
- `definition`: The application definition for this application. You can specify either
inline JSON or an S3 bucket location.
- `engine_type`: The type of the target platform for this application.
- `name`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier the service generates to ensure the
idempotency of the request to create an application. The service generates the clientToken
when the API call is triggered. The token expires after one hour, so if you retry the API
within this timeframe with the same clientToken, you will get the same response. The
service also handles deleting the clientToken after it expires.
- `"description"`: The description of the application.
- `"kmsKeyId"`: The identifier of a customer managed key.
- `"roleArn"`: The Amazon Resource Name (ARN) that identifies a role that the application
uses to access Amazon Web Services resources that are not part of the application or are in
a different Amazon Web Services account.
- `"tags"`: A list of tags to apply to the application.
"""
function create_application(
definition, engineType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications",
Dict{String,Any}(
"definition" => definition,
"engineType" => engineType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
definition,
engineType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"definition" => definition,
"engineType" => engineType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_set_import_task(application_id, import_config)
create_data_set_import_task(application_id, import_config, params::Dict{String,<:Any})
Starts a data set import task for a specific application.
# Arguments
- `application_id`: The unique identifier of the application for which you want to import
data sets.
- `import_config`: The data set import task configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request to create a data set import. The service generates the clientToken when the
API call is triggered. The token expires after one hour, so if you retry the API within
this timeframe with the same clientToken, you will get the same response. The service also
handles deleting the clientToken after it expires.
"""
function create_data_set_import_task(
applicationId, importConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications/$(applicationId)/dataset-import-task",
Dict{String,Any}("importConfig" => importConfig, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_set_import_task(
applicationId,
importConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/dataset-import-task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"importConfig" => importConfig, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment(application_id, application_version, environment_id)
create_deployment(application_id, application_version, environment_id, params::Dict{String,<:Any})
Creates and starts a deployment to deploy an application into a runtime environment.
# Arguments
- `application_id`: The application identifier.
- `application_version`: The version of the application to deploy.
- `environment_id`: The identifier of the runtime environment where you want to deploy this
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request to create a deployment. The service generates the clientToken when the API
call is triggered. The token expires after one hour, so if you retry the API within this
timeframe with the same clientToken, you will get the same response. The service also
handles deleting the clientToken after it expires.
"""
function create_deployment(
applicationId,
applicationVersion,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/deployments",
Dict{String,Any}(
"applicationVersion" => applicationVersion,
"environmentId" => environmentId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
applicationId,
applicationVersion,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/deployments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicationVersion" => applicationVersion,
"environmentId" => environmentId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(engine_type, instance_type, name)
create_environment(engine_type, instance_type, name, params::Dict{String,<:Any})
Creates a runtime environment for a given runtime engine.
# Arguments
- `engine_type`: The engine type for the runtime environment.
- `instance_type`: The type of instance for the runtime environment.
- `name`: The name of the runtime environment. Must be unique within the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request to create an environment. The service generates the clientToken when the API
call is triggered. The token expires after one hour, so if you retry the API within this
timeframe with the same clientToken, you will get the same response. The service also
handles deleting the clientToken after it expires.
- `"description"`: The description of the runtime environment.
- `"engineVersion"`: The version of the engine type for the runtime environment.
- `"highAvailabilityConfig"`: The details of a high availability configuration for this
runtime environment.
- `"kmsKeyId"`: The identifier of a customer managed key.
- `"preferredMaintenanceWindow"`: Configures the maintenance window that you want for the
runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi
and must be less than 24 hours. The following two examples are valid maintenance windows:
sun:23:45-mon:00:15 or sat:01:00-sat:03:00. If you do not provide a value, a random
system-generated value will be assigned.
- `"publiclyAccessible"`: Specifies whether the runtime environment is publicly accessible.
- `"securityGroupIds"`: The list of security groups for the VPC associated with this
runtime environment.
- `"storageConfigurations"`: Optional. The storage configurations for this runtime
environment.
- `"subnetIds"`: The list of subnets associated with the VPC for this runtime environment.
- `"tags"`: The tags for the runtime environment.
"""
function create_environment(
engineType, instanceType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/environments",
Dict{String,Any}(
"engineType" => engineType,
"instanceType" => instanceType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
engineType,
instanceType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/environments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"engineType" => engineType,
"instanceType" => instanceType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Deletes a specific application. You cannot delete a running application.
# Arguments
- `application_id`: The unique identifier of the application you want to delete.
"""
function delete_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_from_environment(application_id, environment_id)
delete_application_from_environment(application_id, environment_id, params::Dict{String,<:Any})
Deletes a specific application from the specific runtime environment where it was
previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any
application has ever been deployed to it. This API removes the association of the
application with the runtime environment so you can delete the environment smoothly.
# Arguments
- `application_id`: The unique identifier of the application you want to delete.
- `environment_id`: The unique identifier of the runtime environment where the application
was previously deployed.
"""
function delete_application_from_environment(
applicationId, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/applications/$(applicationId)/environment/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_from_environment(
applicationId,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/applications/$(applicationId)/environment/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(environment_id)
delete_environment(environment_id, params::Dict{String,<:Any})
Deletes a specific runtime environment. The environment cannot contain deployed
applications. If it does, you must delete those applications before you delete the
environment.
# Arguments
- `environment_id`: The unique identifier of the runtime environment you want to delete.
"""
function delete_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/environments/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/environments/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application(application_id)
get_application(application_id, params::Dict{String,<:Any})
Describes the details of a specific application.
# Arguments
- `application_id`: The identifier of the application.
"""
function get_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_version(application_id, application_version)
get_application_version(application_id, application_version, params::Dict{String,<:Any})
Returns details about a specific version of a specific application.
# Arguments
- `application_id`: The unique identifier of the application.
- `application_version`: The specific version of the application.
"""
function get_application_version(
applicationId, applicationVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/versions/$(applicationVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_version(
applicationId,
applicationVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/versions/$(applicationVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_batch_job_execution(application_id, execution_id)
get_batch_job_execution(application_id, execution_id, params::Dict{String,<:Any})
Gets the details of a specific batch job execution for a specific application.
# Arguments
- `application_id`: The identifier of the application.
- `execution_id`: The unique identifier of the batch job execution.
"""
function get_batch_job_execution(
applicationId, executionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions/$(executionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_batch_job_execution(
applicationId,
executionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions/$(executionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_set_details(application_id, data_set_name)
get_data_set_details(application_id, data_set_name, params::Dict{String,<:Any})
Gets the details of a specific data set.
# Arguments
- `application_id`: The unique identifier of the application that this data set is
associated with.
- `data_set_name`: The name of the data set.
"""
function get_data_set_details(
applicationId, dataSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/datasets/$(dataSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_set_details(
applicationId,
dataSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/datasets/$(dataSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_set_import_task(application_id, task_id)
get_data_set_import_task(application_id, task_id, params::Dict{String,<:Any})
Gets the status of a data set import task initiated with the CreateDataSetImportTask
operation.
# Arguments
- `application_id`: The application identifier.
- `task_id`: The task identifier returned by the CreateDataSetImportTask operation.
"""
function get_data_set_import_task(
applicationId, taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_set_import_task(
applicationId,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployment(application_id, deployment_id)
get_deployment(application_id, deployment_id, params::Dict{String,<:Any})
Gets details of a specific deployment with a given deployment identifier.
# Arguments
- `application_id`: The unique identifier of the application.
- `deployment_id`: The unique identifier for the deployment.
"""
function get_deployment(
applicationId, deploymentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/deployments/$(deploymentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployment(
applicationId,
deploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/deployments/$(deploymentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(environment_id)
get_environment(environment_id, params::Dict{String,<:Any})
Describes a specific runtime environment.
# Arguments
- `environment_id`: The unique identifier of the runtime environment.
"""
function get_environment(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/environments/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/environments/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signed_bluinsights_url()
get_signed_bluinsights_url(params::Dict{String,<:Any})
Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
"""
function get_signed_bluinsights_url(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/signed-bi-url"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_signed_bluinsights_url(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/signed-bi-url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_versions(application_id)
list_application_versions(application_id, params::Dict{String,<:Any})
Returns a list of the application versions for a specific application.
# Arguments
- `application_id`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of application versions to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_application_versions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_versions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Lists the applications associated with a specific Amazon Web Services account. You can
provide the unique identifier of a specific runtime environment in a query parameter to see
all applications associated with that environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentId"`: The unique identifier of the runtime environment where the
applications are deployed.
- `"maxResults"`: The maximum number of applications to return.
- `"names"`: The names of the applications.
- `"nextToken"`: A pagination token to control the number of applications displayed in the
list.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/applications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_job_definitions(application_id)
list_batch_job_definitions(application_id, params::Dict{String,<:Any})
Lists all the available batch job definitions based on the batch job resources uploaded
during the application creation. You can use the batch job definitions in the list to start
a batch job.
# Arguments
- `application_id`: The identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of batch job definitions to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
- `"prefix"`: If the batch job definition is a FileBatchJobDefinition, the prefix allows
you to search on the file names of FileBatchJobDefinitions.
"""
function list_batch_job_definitions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-definitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_batch_job_definitions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-definitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_job_executions(application_id)
list_batch_job_executions(application_id, params::Dict{String,<:Any})
Lists historical, current, and scheduled batch job executions for a specific application.
# Arguments
- `application_id`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionIds"`: The unique identifier of each batch job execution.
- `"jobName"`: The name of each batch job execution.
- `"maxResults"`: The maximum number of batch job executions to return.
- `"nextToken"`: A pagination token to control the number of batch job executions displayed
in the list.
- `"startedAfter"`: The time after which the batch job executions started.
- `"startedBefore"`: The time before the batch job executions started.
- `"status"`: The status of the batch job executions.
"""
function list_batch_job_executions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_batch_job_executions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_job_restart_points(application_id, execution_id)
list_batch_job_restart_points(application_id, execution_id, params::Dict{String,<:Any})
Lists all the job steps for JCL files to restart a batch job. This is only applicable for
Micro Focus engine with versions 8.0.6 and above.
# Arguments
- `application_id`: The unique identifier of the application.
- `execution_id`: The unique identifier of each batch job execution.
"""
function list_batch_job_restart_points(
applicationId, executionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions/$(executionId)/steps";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_batch_job_restart_points(
applicationId,
executionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions/$(executionId)/steps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_set_import_history(application_id)
list_data_set_import_history(application_id, params::Dict{String,<:Any})
Lists the data set imports for the specified application.
# Arguments
- `application_id`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_data_set_import_history(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_set_import_history(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sets(application_id)
list_data_sets(application_id, params::Dict{String,<:Any})
Lists the data sets imported for a specific application. In Amazon Web Services Mainframe
Modernization, data sets are associated with applications deployed on runtime environments.
This is known as importing data sets. Currently, Amazon Web Services Mainframe
Modernization can import data sets into catalogs using CreateDataSetImportTask.
# Arguments
- `application_id`: The unique identifier of the application for which you want to list the
associated data sets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return.
- `"nameFilter"`: Filter dataset name matching the specified pattern. Can use * and % as
wild cards.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
- `"prefix"`: The prefix of the data set name, which you can use to filter the list of data
sets.
"""
function list_data_sets(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/applications/$(applicationId)/datasets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sets(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/datasets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployments(application_id)
list_deployments(application_id, params::Dict{String,<:Any})
Returns a list of all deployments of a specific application. A deployment is a combination
of a specific application and a specific version of that application. Each deployment is
mapped to a particular application version.
# Arguments
- `application_id`: The application identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_deployments(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/applications/$(applicationId)/deployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deployments(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/deployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_engine_versions()
list_engine_versions(params::Dict{String,<:Any})
Lists the available engine versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: The type of target platform.
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_engine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/engine-versions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_engine_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/engine-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments()
list_environments(params::Dict{String,<:Any})
Lists the runtime environments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: The engine type for the runtime environment.
- `"maxResults"`: The maximum number of runtime environments to return.
- `"names"`: The names of the runtime environments. Must be unique within the account.
- `"nextToken"`: A pagination token to control the number of runtime environments displayed
in the list.
"""
function list_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/environments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/environments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_application(application_id)
start_application(application_id, params::Dict{String,<:Any})
Starts an application that is currently stopped.
# Arguments
- `application_id`: The unique identifier of the application you want to start.
"""
function start_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"POST",
"/applications/$(applicationId)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_batch_job(application_id, batch_job_identifier)
start_batch_job(application_id, batch_job_identifier, params::Dict{String,<:Any})
Starts a batch job and returns the unique identifier of this execution of the batch job.
The associated application must be running in order to start the batch job.
# Arguments
- `application_id`: The unique identifier of the application associated with this batch job.
- `batch_job_identifier`: The unique identifier of the batch job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobParams"`: The collection of batch job parameters. For details about limits for keys
and values, see Coding variables in JCL.
"""
function start_batch_job(
applicationId, batchJobIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications/$(applicationId)/batch-job",
Dict{String,Any}("batchJobIdentifier" => batchJobIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_batch_job(
applicationId,
batchJobIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/batch-job",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("batchJobIdentifier" => batchJobIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_application(application_id)
stop_application(application_id, params::Dict{String,<:Any})
Stops a running application.
# Arguments
- `application_id`: The unique identifier of the application you want to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"forceStop"`: Stopping an application process can take a long time. Setting this
parameter to true lets you force stop the application so you don't need to wait until the
process finishes to apply another action on the application. The default value is false.
"""
function stop_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"POST",
"/applications/$(applicationId)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags to add to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The keys of the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_id, current_application_version)
update_application(application_id, current_application_version, params::Dict{String,<:Any})
Updates an application and creates a new version.
# Arguments
- `application_id`: The unique identifier of the application you want to update.
- `current_application_version`: The current version of the application to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"definition"`: The application definition for this application. You can specify either
inline JSON or an S3 bucket location.
- `"description"`: The description of the application to update.
"""
function update_application(
applicationId,
currentApplicationVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"PATCH",
"/applications/$(applicationId)",
Dict{String,Any}("currentApplicationVersion" => currentApplicationVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
applicationId,
currentApplicationVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"PATCH",
"/applications/$(applicationId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("currentApplicationVersion" => currentApplicationVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment(environment_id)
update_environment(environment_id, params::Dict{String,<:Any})
Updates the configuration details for a specific runtime environment.
# Arguments
- `environment_id`: The unique identifier of the runtime environment that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applyDuringMaintenanceWindow"`: Indicates whether to update the runtime environment
during the maintenance window. The default is false. Currently, Amazon Web Services
Mainframe Modernization accepts the engineVersion parameter only if
applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided
in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.
- `"desiredCapacity"`: The desired capacity for the runtime environment to update. The
minimum possible value is 0 and the maximum is 100.
- `"engineVersion"`: The version of the runtime engine for the runtime environment.
- `"forceUpdate"`: Forces the updates on the environment. This option is needed if the
applications in the environment are not stopped or if there are ongoing application-related
activities in the environment. If you use this option, be aware that it could lead to data
corruption in the applications, and that you might need to perform repair and recovery
procedures for the applications. This option is not needed if the attribute being updated
is preferredMaintenanceWindow.
- `"instanceType"`: The instance type for the runtime environment to update.
- `"preferredMaintenanceWindow"`: Configures the maintenance window that you want for the
runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi
and must be less than 24 hours. The following two examples are valid maintenance windows:
sun:23:45-mon:00:15 or sat:01:00-sat:03:00. If you do not provide a value, a random
system-generated value will be assigned.
"""
function update_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"PATCH",
"/environments/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"PATCH",
"/environments/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 61516 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: machine_learning
using AWS.Compat
using AWS.UUIDs
"""
add_tags(resource_id, resource_type, tags)
add_tags(resource_id, resource_type, tags, params::Dict{String,<:Any})
Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an
optional value. If you add a tag using a key that is already associated with the ML object,
AddTags updates the tag's value.
# Arguments
- `resource_id`: The ID of the ML object to tag. For example, exampleModelId.
- `resource_type`: The type of the ML object to tag.
- `tags`: The key-value pairs to use to create tags. If you specify a key without
specifying a value, Amazon ML creates a tag with the specified key and a value of null.
"""
function add_tags(
ResourceId, ResourceType, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"AddTags",
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType, "Tags" => Tags
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
ResourceId,
ResourceType,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"AddTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
"Tags" => Tags,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_batch_prediction(batch_prediction_data_source_id, batch_prediction_id, mlmodel_id, output_uri)
create_batch_prediction(batch_prediction_data_source_id, batch_prediction_id, mlmodel_id, output_uri, params::Dict{String,<:Any})
Generates predictions for a group of observations. The observations to process exist in one
or more data files referenced by a DataSource. This operation creates a new
BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as
information sources. CreateBatchPrediction is an asynchronous operation. In response to
CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the
BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the
status to COMPLETED. You can poll for status updates by using the GetBatchPrediction
operation and checking the Status parameter of the result. After the COMPLETED status
appears, the results are available in the location specified by the OutputUri parameter.
# Arguments
- `batch_prediction_data_source_id`: The ID of the DataSource that points to the group of
observations to predict.
- `batch_prediction_id`: A user-supplied ID that uniquely identifies the BatchPrediction.
- `mlmodel_id`: The ID of the MLModel that will generate predictions for the group of
observations.
- `output_uri`: The location of an Amazon Simple Storage Service (Amazon S3) bucket or
directory to store the batch prediction results. The following substrings are not allowed
in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'. Amazon ML needs
permissions to store and retrieve the logs on your behalf. For information about how to set
permissions, see the Amazon Machine Learning Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BatchPredictionName"`: A user-supplied name or description of the BatchPrediction.
BatchPredictionName can only use the UTF-8 character set.
"""
function create_batch_prediction(
BatchPredictionDataSourceId,
BatchPredictionId,
MLModelId,
OutputUri;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateBatchPrediction",
Dict{String,Any}(
"BatchPredictionDataSourceId" => BatchPredictionDataSourceId,
"BatchPredictionId" => BatchPredictionId,
"MLModelId" => MLModelId,
"OutputUri" => OutputUri,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_batch_prediction(
BatchPredictionDataSourceId,
BatchPredictionId,
MLModelId,
OutputUri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateBatchPrediction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BatchPredictionDataSourceId" => BatchPredictionDataSourceId,
"BatchPredictionId" => BatchPredictionId,
"MLModelId" => MLModelId,
"OutputUri" => OutputUri,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source_from_rds(data_source_id, rdsdata, role_arn)
create_data_source_from_rds(data_source_id, rdsdata, role_arn, params::Dict{String,<:Any})
Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A
DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or
CreateBatchPrediction operations. CreateDataSourceFromRDS is an asynchronous operation. In
response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately
returns and sets the DataSource status to PENDING. After the DataSource is created and
ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the
COMPLETED or PENDING state can be used only to perform >CreateMLModel>,
CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML cannot accept the
input source, it sets the Status parameter to FAILED and includes an error message in the
Message attribute of the GetDataSource operation response.
# Arguments
- `data_source_id`: A user-supplied ID that uniquely identifies the DataSource. Typically,
an Amazon Resource Number (ARN) becomes the ID for a DataSource.
- `rdsdata`: The data specification of an Amazon RDS DataSource: DatabaseInformation -
DatabaseName - The name of the Amazon RDS database. InstanceIdentifier - A unique
identifier for the Amazon RDS database instance. DatabaseCredentials - AWS Identity and
Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry
out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more
information, see Role templates for data pipelines. ServiceRole - A role
(DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress
of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for
data pipelines. SecurityInfo - The security information to use to access an RDS DB
instance. You need to set up appropriate ingress rules for the security entity IDs provided
to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for
a VPC-based RDS DB instance. SelectSqlQuery - A query that is used to retrieve the
observation data for the Datasource. S3StagingLocation - The Amazon S3 location for
staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored
in this location. DataSchemaUri - The Amazon S3 location of the DataSchema. DataSchema
- A JSON string representing the schema. This is not required if DataSchemaUri is
specified. DataRearrangement - A JSON string that represents the splitting and
rearrangement requirements for the Datasource. Sample -
\"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}\"
- `role_arn`: The role that Amazon ML assumes on behalf of the user to create and activate
a data pipeline in the user's account and copy data using the SelectSqlQuery query from
Amazon RDS to Amazon S3.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComputeStatistics"`: The compute statistics for a DataSource. The statistics are
generated from the observation data referenced by a DataSource. Amazon ML uses the
statistics internally during MLModel training. This parameter must be set to true if the
DataSource needs to be used for MLModel training.
- `"DataSourceName"`: A user-supplied name or description of the DataSource.
"""
function create_data_source_from_rds(
DataSourceId, RDSData, RoleARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"CreateDataSourceFromRDS",
Dict{String,Any}(
"DataSourceId" => DataSourceId, "RDSData" => RDSData, "RoleARN" => RoleARN
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source_from_rds(
DataSourceId,
RDSData,
RoleARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateDataSourceFromRDS",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSourceId" => DataSourceId,
"RDSData" => RDSData,
"RoleARN" => RoleARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source_from_redshift(data_source_id, data_spec, role_arn)
create_data_source_from_redshift(data_source_id, data_spec, role_arn, params::Dict{String,<:Any})
Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource
references data that can be used to perform either CreateMLModel, CreateEvaluation, or
CreateBatchPrediction operations. CreateDataSourceFromRedshift is an asynchronous
operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML)
immediately returns and sets the DataSource status to PENDING. After the DataSource is
created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in
COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or
CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the
Status parameter to FAILED and includes an error message in the Message attribute of the
GetDataSource operation response. The observations should be contained in the database
hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query.
Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the
SelectSqlQuery query to S3StagingLocation. After the DataSource has been created, it's
ready for use in evaluations and batch predictions. If you plan to use the DataSource to
train an MLModel, the DataSource also requires a recipe. A recipe describes how each input
variable will be used in training an MLModel. Will the variable be included or excluded
from training? Will the variable be manipulated; for example, will it be combined with
another variable or will it be split apart into word combinations? The recipe provides
answers to these questions. You can't change an existing datasource, but you can copy and
modify the settings from an existing Amazon Redshift datasource to create a new datasource.
To do so, call GetDataSource for an existing datasource and copy the values to a
CreateDataSource call. Change the settings that you want to change and make sure that all
required fields have the appropriate values.
# Arguments
- `data_source_id`: A user-supplied ID that uniquely identifies the DataSource.
- `data_spec`: The data specification of an Amazon Redshift DataSource:
DatabaseInformation - DatabaseName - The name of the Amazon Redshift database.
ClusterIdentifier - The unique ID for the Amazon Redshift cluster. DatabaseCredentials
- The AWS Identity and Access Management (IAM) credentials that are used to connect to the
Amazon Redshift database. SelectSqlQuery - The query that is used to retrieve the
observation data for the Datasource. S3StagingLocation - The Amazon Simple Storage
Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from
Amazon Redshift using the SelectSqlQuery query is stored in this location. DataSchemaUri
- The Amazon S3 location of the DataSchema. DataSchema - A JSON string representing the
schema. This is not required if DataSchemaUri is specified. DataRearrangement - A JSON
string that represents the splitting and rearrangement requirements for the DataSource.
Sample - \"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}\"
- `role_arn`: A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role
on behalf of the user to create the following: A security group to allow Amazon ML to
execute the SelectSqlQuery query on an Amazon Redshift cluster An Amazon S3 bucket policy
to grant Amazon ML read/write permissions on the S3StagingLocation
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComputeStatistics"`: The compute statistics for a DataSource. The statistics are
generated from the observation data referenced by a DataSource. Amazon ML uses the
statistics internally during MLModel training. This parameter must be set to true if the
DataSource needs to be used for MLModel training.
- `"DataSourceName"`: A user-supplied name or description of the DataSource.
"""
function create_data_source_from_redshift(
DataSourceId, DataSpec, RoleARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"CreateDataSourceFromRedshift",
Dict{String,Any}(
"DataSourceId" => DataSourceId, "DataSpec" => DataSpec, "RoleARN" => RoleARN
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source_from_redshift(
DataSourceId,
DataSpec,
RoleARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateDataSourceFromRedshift",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSourceId" => DataSourceId,
"DataSpec" => DataSpec,
"RoleARN" => RoleARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source_from_s3(data_source_id, data_spec)
create_data_source_from_s3(data_source_id, data_spec, params::Dict{String,<:Any})
Creates a DataSource object. A DataSource references data that can be used to perform
CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3,
Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to
PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the
Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to
perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations. If
Amazon ML can't accept the input source, it sets the Status parameter to FAILED and
includes an error message in the Message attribute of the GetDataSource operation response.
The observation data used in a DataSource should be ready to use; that is, it should have
a consistent structure, and missing data values should be kept to a minimum. The
observation data must reside in one or more .csv files in an Amazon Simple Storage Service
(Amazon S3) location, along with a schema that describes the data items by name and type.
The same schema must be used for all of the data files referenced by the DataSource. After
the DataSource has been created, it's ready to use in evaluations and batch predictions. If
you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A
recipe describes how each input variable will be used in training an MLModel. Will the
variable be included or excluded from training? Will the variable be manipulated; for
example, will it be combined with another variable or will it be split apart into word
combinations? The recipe provides answers to these questions.
# Arguments
- `data_source_id`: A user-supplied identifier that uniquely identifies the DataSource.
- `data_spec`: The data specification of a DataSource: DataLocationS3 - The Amazon S3
location of the observation data. DataSchemaLocationS3 - The Amazon S3 location of the
DataSchema. DataSchema - A JSON string representing the schema. This is not required if
DataSchemaUri is specified. DataRearrangement - A JSON string that represents the
splitting and rearrangement requirements for the Datasource. Sample -
\"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}\"
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComputeStatistics"`: The compute statistics for a DataSource. The statistics are
generated from the observation data referenced by a DataSource. Amazon ML uses the
statistics internally during MLModel training. This parameter must be set to true if the
DataSource needs to be used for MLModel training.
- `"DataSourceName"`: A user-supplied name or description of the DataSource.
"""
function create_data_source_from_s3(
DataSourceId, DataSpec; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"CreateDataSourceFromS3",
Dict{String,Any}("DataSourceId" => DataSourceId, "DataSpec" => DataSpec);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source_from_s3(
DataSourceId,
DataSpec,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateDataSourceFromS3",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataSourceId" => DataSourceId, "DataSpec" => DataSpec),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_evaluation(evaluation_data_source_id, evaluation_id, mlmodel_id)
create_evaluation(evaluation_data_source_id, evaluation_id, mlmodel_id, params::Dict{String,<:Any})
Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations
associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an
Evaluation contains values for the Target Variable. The Evaluation compares the predicted
result for each observation to the actual outcome and provides a summary so that you know
how effective the MLModel functions on the test data. Evaluation generates a relevant
performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the
corresponding MLModelType: BINARY, REGRESSION or MULTICLASS. CreateEvaluation is an
asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon
ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is
created and ready for use, Amazon ML sets the status to COMPLETED. You can use the
GetEvaluation operation to check progress of the evaluation during the creation operation.
# Arguments
- `evaluation_data_source_id`: The ID of the DataSource for the evaluation. The schema of
the DataSource must match the schema used to create the MLModel.
- `evaluation_id`: A user-supplied ID that uniquely identifies the Evaluation.
- `mlmodel_id`: The ID of the MLModel to evaluate. The schema used in creating the MLModel
must match the schema of the DataSource used in the Evaluation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EvaluationName"`: A user-supplied name or description of the Evaluation.
"""
function create_evaluation(
EvaluationDataSourceId,
EvaluationId,
MLModelId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateEvaluation",
Dict{String,Any}(
"EvaluationDataSourceId" => EvaluationDataSourceId,
"EvaluationId" => EvaluationId,
"MLModelId" => MLModelId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_evaluation(
EvaluationDataSourceId,
EvaluationId,
MLModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateEvaluation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EvaluationDataSourceId" => EvaluationDataSourceId,
"EvaluationId" => EvaluationId,
"MLModelId" => MLModelId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mlmodel(mlmodel_id, mlmodel_type, training_data_source_id)
create_mlmodel(mlmodel_id, mlmodel_type, training_data_source_id, params::Dict{String,<:Any})
Creates a new MLModel using the DataSource and the recipe as information sources. An
MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold
in an MLModel without creating a new MLModel. CreateMLModel is an asynchronous operation.
In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and
sets the MLModel status to PENDING. After the MLModel has been created and ready is for
use, Amazon ML sets the status to COMPLETED. You can use the GetMLModel operation to check
the progress of the MLModel during the creation operation. CreateMLModel requires a
DataSource with computed statistics, which can be created by setting ComputeStatistics to
true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift
operations.
# Arguments
- `mlmodel_id`: A user-supplied ID that uniquely identifies the MLModel.
- `mlmodel_type`: The category of supervised learning that this MLModel will address.
Choose from the following types: Choose REGRESSION if the MLModel will be used to predict
a numeric value. Choose BINARY if the MLModel result has two possible values. Choose
MULTICLASS if the MLModel result has a limited number of values. For more information,
see the Amazon Machine Learning Developer Guide.
- `training_data_source_id`: The DataSource that points to the training data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MLModelName"`: A user-supplied name or description of the MLModel.
- `"Parameters"`: A list of the training parameters in the MLModel. The list is implemented
as a map of key-value pairs. The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input
data, the size of the model might affect its performance. The value is an integer that
ranges from 100000 to 2147483648. The default value is 33554432. sgd.maxPasses - The
number of times that the training process traverses the observations to build the MLModel.
The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves
a model's ability to find the optimal solution for a variety of data types. The valid
values are auto and none. The default value is none. We strongly recommend that you shuffle
your data. sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It
controls overfitting the data by penalizing large coefficients. This tends to drive
coefficients to zero, resulting in a sparse feature set. If you use this parameter, start
by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to
MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when
L2 is specified. Use this parameter sparingly. sgd.l2RegularizationAmount - The
coefficient regularization L2 norm. It controls overfitting the data by penalizing large
coefficients. This tends to drive coefficients to small, nonzero values. If you use this
parameter, start by specifying a small value, such as 1.0E-08. The value is a double that
ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter
can't be used when L1 is specified. Use this parameter sparingly.
- `"Recipe"`: The data recipe for creating the MLModel. You must specify either the recipe
or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.
- `"RecipeUri"`: The Amazon Simple Storage Service (Amazon S3) location and file name that
contains the MLModel recipe. You must specify either the recipe or its URI. If you don't
specify a recipe or its URI, Amazon ML creates a default.
"""
function create_mlmodel(
MLModelId,
MLModelType,
TrainingDataSourceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateMLModel",
Dict{String,Any}(
"MLModelId" => MLModelId,
"MLModelType" => MLModelType,
"TrainingDataSourceId" => TrainingDataSourceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_mlmodel(
MLModelId,
MLModelType,
TrainingDataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateMLModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MLModelId" => MLModelId,
"MLModelType" => MLModelType,
"TrainingDataSourceId" => TrainingDataSourceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_realtime_endpoint(mlmodel_id)
create_realtime_endpoint(mlmodel_id, params::Dict{String,<:Any})
Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel;
that is, the location to send real-time prediction requests for the specified MLModel.
# Arguments
- `mlmodel_id`: The ID assigned to the MLModel during creation.
"""
function create_realtime_endpoint(
MLModelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"CreateRealtimeEndpoint",
Dict{String,Any}("MLModelId" => MLModelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_realtime_endpoint(
MLModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"CreateRealtimeEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MLModelId" => MLModelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_batch_prediction(batch_prediction_id)
delete_batch_prediction(batch_prediction_id, params::Dict{String,<:Any})
Assigns the DELETED status to a BatchPrediction, rendering it unusable. After using the
DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify
that the status of the BatchPrediction changed to DELETED. Caution: The result of the
DeleteBatchPrediction operation is irreversible.
# Arguments
- `batch_prediction_id`: A user-supplied ID that uniquely identifies the BatchPrediction.
"""
function delete_batch_prediction(
BatchPredictionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DeleteBatchPrediction",
Dict{String,Any}("BatchPredictionId" => BatchPredictionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_batch_prediction(
BatchPredictionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DeleteBatchPrediction",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("BatchPredictionId" => BatchPredictionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_source(data_source_id)
delete_data_source(data_source_id, params::Dict{String,<:Any})
Assigns the DELETED status to a DataSource, rendering it unusable. After using the
DeleteDataSource operation, you can use the GetDataSource operation to verify that the
status of the DataSource changed to DELETED. Caution: The results of the DeleteDataSource
operation are irreversible.
# Arguments
- `data_source_id`: A user-supplied ID that uniquely identifies the DataSource.
"""
function delete_data_source(DataSourceId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DeleteDataSource",
Dict{String,Any}("DataSourceId" => DataSourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_source(
DataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DeleteDataSource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSourceId" => DataSourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_evaluation(evaluation_id)
delete_evaluation(evaluation_id, params::Dict{String,<:Any})
Assigns the DELETED status to an Evaluation, rendering it unusable. After invoking the
DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the
status of the Evaluation changed to DELETED. Caution: The results of the DeleteEvaluation
operation are irreversible.
# Arguments
- `evaluation_id`: A user-supplied ID that uniquely identifies the Evaluation to delete.
"""
function delete_evaluation(EvaluationId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DeleteEvaluation",
Dict{String,Any}("EvaluationId" => EvaluationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_evaluation(
EvaluationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DeleteEvaluation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EvaluationId" => EvaluationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mlmodel(mlmodel_id)
delete_mlmodel(mlmodel_id, params::Dict{String,<:Any})
Assigns the DELETED status to an MLModel, rendering it unusable. After using the
DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of
the MLModel changed to DELETED. Caution: The result of the DeleteMLModel operation is
irreversible.
# Arguments
- `mlmodel_id`: A user-supplied ID that uniquely identifies the MLModel.
"""
function delete_mlmodel(MLModelId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DeleteMLModel",
Dict{String,Any}("MLModelId" => MLModelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mlmodel(
MLModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DeleteMLModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MLModelId" => MLModelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_realtime_endpoint(mlmodel_id)
delete_realtime_endpoint(mlmodel_id, params::Dict{String,<:Any})
Deletes a real time endpoint of an MLModel.
# Arguments
- `mlmodel_id`: The ID assigned to the MLModel during creation.
"""
function delete_realtime_endpoint(
MLModelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DeleteRealtimeEndpoint",
Dict{String,Any}("MLModelId" => MLModelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_realtime_endpoint(
MLModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DeleteRealtimeEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MLModelId" => MLModelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(resource_id, resource_type, tag_keys)
delete_tags(resource_id, resource_type, tag_keys, params::Dict{String,<:Any})
Deletes the specified tags associated with an ML object. After this operation is complete,
you can't recover deleted tags. If you specify a tag that doesn't exist, Amazon ML ignores
it.
# Arguments
- `resource_id`: The ID of the tagged ML object. For example, exampleModelId.
- `resource_type`: The type of the tagged ML object.
- `tag_keys`: One or more tags to delete.
"""
function delete_tags(
ResourceId, ResourceType, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DeleteTags",
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType, "TagKeys" => TagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
ResourceId,
ResourceType,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DeleteTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
"TagKeys" => TagKeys,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_batch_predictions()
describe_batch_predictions(params::Dict{String,<:Any})
Returns a list of BatchPrediction operations that match the search criteria in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EQ"`: The equal to operator. The BatchPrediction results will have FilterVariable
values that exactly match the value specified with EQ.
- `"FilterVariable"`: Use one of the following variables to filter a list of
BatchPrediction: CreatedAt - Sets the search criteria to the BatchPrediction creation
date. Status - Sets the search criteria to the BatchPrediction status. Name - Sets
the search criteria to the contents of the BatchPrediction Name. IAMUser - Sets the
search criteria to the user account that invoked the BatchPrediction creation. MLModelId
- Sets the search criteria to the MLModel used in the BatchPrediction. DataSourceId -
Sets the search criteria to the DataSource used in the BatchPrediction. DataURI - Sets
the search criteria to the data file(s) used in the BatchPrediction. The URL can identify
either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
- `"GE"`: The greater than or equal to operator. The BatchPrediction results will have
FilterVariable values that are greater than or equal to the value specified with GE.
- `"GT"`: The greater than operator. The BatchPrediction results will have FilterVariable
values that are greater than the value specified with GT.
- `"LE"`: The less than or equal to operator. The BatchPrediction results will have
FilterVariable values that are less than or equal to the value specified with LE.
- `"LT"`: The less than operator. The BatchPrediction results will have FilterVariable
values that are less than the value specified with LT.
- `"Limit"`: The number of pages of information to include in the result. The range of
acceptable values is 1 through 100. The default value is 100.
- `"NE"`: The not equal to operator. The BatchPrediction results will have FilterVariable
values not equal to the value specified with NE.
- `"NextToken"`: An ID of the page in the paginated results.
- `"Prefix"`: A string that is found at the beginning of a variable, such as Name or Id.
For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer.
To search for this BatchPrediction, select Name for the FilterVariable and any of the
following strings for the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday
- `"SortOrder"`: A two-value parameter that determines the sequence of the resulting list
of MLModels. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges
the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable.
"""
function describe_batch_predictions(; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DescribeBatchPredictions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_batch_predictions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DescribeBatchPredictions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_sources()
describe_data_sources(params::Dict{String,<:Any})
Returns a list of DataSource that match the search criteria in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EQ"`: The equal to operator. The DataSource results will have FilterVariable values
that exactly match the value specified with EQ.
- `"FilterVariable"`: Use one of the following variables to filter a list of DataSource:
CreatedAt - Sets the search criteria to DataSource creation dates. Status - Sets the
search criteria to DataSource statuses. Name - Sets the search criteria to the contents
of DataSource Name. DataUri - Sets the search criteria to the URI of data files used to
create the DataSource. The URI can identify either a file or an Amazon Simple Storage
Service (Amazon S3) bucket or directory. IAMUser - Sets the search criteria to the user
account that invoked the DataSource creation.
- `"GE"`: The greater than or equal to operator. The DataSource results will have
FilterVariable values that are greater than or equal to the value specified with GE.
- `"GT"`: The greater than operator. The DataSource results will have FilterVariable values
that are greater than the value specified with GT.
- `"LE"`: The less than or equal to operator. The DataSource results will have
FilterVariable values that are less than or equal to the value specified with LE.
- `"LT"`: The less than operator. The DataSource results will have FilterVariable values
that are less than the value specified with LT.
- `"Limit"`: The maximum number of DataSource to include in the result.
- `"NE"`: The not equal to operator. The DataSource results will have FilterVariable values
not equal to the value specified with NE.
- `"NextToken"`: The ID of the page in the paginated results.
- `"Prefix"`: A string that is found at the beginning of a variable, such as Name or Id.
For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for
this DataSource, select Name for the FilterVariable and any of the following strings for
the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday
- `"SortOrder"`: A two-value parameter that determines the sequence of the resulting list
of DataSource. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges
the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable.
"""
function describe_data_sources(; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DescribeDataSources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_data_sources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DescribeDataSources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_evaluations()
describe_evaluations(params::Dict{String,<:Any})
Returns a list of DescribeEvaluations that match the search criteria in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EQ"`: The equal to operator. The Evaluation results will have FilterVariable values
that exactly match the value specified with EQ.
- `"FilterVariable"`: Use one of the following variable to filter a list of Evaluation
objects: CreatedAt - Sets the search criteria to the Evaluation creation date. Status
- Sets the search criteria to the Evaluation status. Name - Sets the search criteria to
the contents of Evaluation Name. IAMUser - Sets the search criteria to the user
account that invoked an Evaluation. MLModelId - Sets the search criteria to the MLModel
that was evaluated. DataSourceId - Sets the search criteria to the DataSource used in
Evaluation. DataUri - Sets the search criteria to the data file(s) used in Evaluation.
The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket
or directory.
- `"GE"`: The greater than or equal to operator. The Evaluation results will have
FilterVariable values that are greater than or equal to the value specified with GE.
- `"GT"`: The greater than operator. The Evaluation results will have FilterVariable values
that are greater than the value specified with GT.
- `"LE"`: The less than or equal to operator. The Evaluation results will have
FilterVariable values that are less than or equal to the value specified with LE.
- `"LT"`: The less than operator. The Evaluation results will have FilterVariable values
that are less than the value specified with LT.
- `"Limit"`: The maximum number of Evaluation to include in the result.
- `"NE"`: The not equal to operator. The Evaluation results will have FilterVariable values
not equal to the value specified with NE.
- `"NextToken"`: The ID of the page in the paginated results.
- `"Prefix"`: A string that is found at the beginning of a variable, such as Name or Id.
For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for
this Evaluation, select Name for the FilterVariable and any of the following strings for
the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday
- `"SortOrder"`: A two-value parameter that determines the sequence of the resulting list
of Evaluation. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges
the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable.
"""
function describe_evaluations(; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DescribeEvaluations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_evaluations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DescribeEvaluations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mlmodels()
describe_mlmodels(params::Dict{String,<:Any})
Returns a list of MLModel that match the search criteria in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EQ"`: The equal to operator. The MLModel results will have FilterVariable values that
exactly match the value specified with EQ.
- `"FilterVariable"`: Use one of the following variables to filter a list of MLModel:
CreatedAt - Sets the search criteria to MLModel creation date. Status - Sets the search
criteria to MLModel status. Name - Sets the search criteria to the contents of MLModel
Name. IAMUser - Sets the search criteria to the user account that invoked the MLModel
creation. TrainingDataSourceId - Sets the search criteria to the DataSource used to
train one or more MLModel. RealtimeEndpointStatus - Sets the search criteria to the
MLModel real-time endpoint status. MLModelType - Sets the search criteria to MLModel
type: binary, regression, or multi-class. Algorithm - Sets the search criteria to the
algorithm that the MLModel uses. TrainingDataURI - Sets the search criteria to the data
file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple
Storage Service (Amazon S3) bucket or directory.
- `"GE"`: The greater than or equal to operator. The MLModel results will have
FilterVariable values that are greater than or equal to the value specified with GE.
- `"GT"`: The greater than operator. The MLModel results will have FilterVariable values
that are greater than the value specified with GT.
- `"LE"`: The less than or equal to operator. The MLModel results will have FilterVariable
values that are less than or equal to the value specified with LE.
- `"LT"`: The less than operator. The MLModel results will have FilterVariable values that
are less than the value specified with LT.
- `"Limit"`: The number of pages of information to include in the result. The range of
acceptable values is 1 through 100. The default value is 100.
- `"NE"`: The not equal to operator. The MLModel results will have FilterVariable values
not equal to the value specified with NE.
- `"NextToken"`: The ID of the page in the paginated results.
- `"Prefix"`: A string that is found at the beginning of a variable, such as Name or Id.
For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for
this MLModel, select Name for the FilterVariable and any of the following strings for the
Prefix: 2014-09 2014-09-09 2014-09-09-Holiday
- `"SortOrder"`: A two-value parameter that determines the sequence of the resulting list
of MLModel. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges the
list in descending order (Z-A, 9-0). Results are sorted by FilterVariable.
"""
function describe_mlmodels(; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"DescribeMLModels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_mlmodels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DescribeMLModels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_tags(resource_id, resource_type)
describe_tags(resource_id, resource_type, params::Dict{String,<:Any})
Describes one or more of the tags for your Amazon ML object.
# Arguments
- `resource_id`: The ID of the ML object. For example, exampleModelId.
- `resource_type`: The type of the ML object.
"""
function describe_tags(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"DescribeTags",
Dict{String,Any}("ResourceId" => ResourceId, "ResourceType" => ResourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tags(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"DescribeTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_batch_prediction(batch_prediction_id)
get_batch_prediction(batch_prediction_id, params::Dict{String,<:Any})
Returns a BatchPrediction that includes detailed metadata, status, and data file
information for a Batch Prediction request.
# Arguments
- `batch_prediction_id`: An ID assigned to the BatchPrediction at creation.
"""
function get_batch_prediction(
BatchPredictionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"GetBatchPrediction",
Dict{String,Any}("BatchPredictionId" => BatchPredictionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_batch_prediction(
BatchPredictionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"GetBatchPrediction",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("BatchPredictionId" => BatchPredictionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_source(data_source_id)
get_data_source(data_source_id, params::Dict{String,<:Any})
Returns a DataSource that includes metadata and data file information, as well as the
current status of the DataSource. GetDataSource provides results in normal or verbose
format. The verbose format adds the schema description and the list of files pointed to by
the DataSource to the normal format.
# Arguments
- `data_source_id`: The ID assigned to the DataSource at creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Verbose"`: Specifies whether the GetDataSource operation should return
DataSourceSchema. If true, DataSourceSchema is returned. If false, DataSourceSchema is not
returned.
"""
function get_data_source(DataSourceId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"GetDataSource",
Dict{String,Any}("DataSourceId" => DataSourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_source(
DataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"GetDataSource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSourceId" => DataSourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_evaluation(evaluation_id)
get_evaluation(evaluation_id, params::Dict{String,<:Any})
Returns an Evaluation that includes metadata as well as the current status of the
Evaluation.
# Arguments
- `evaluation_id`: The ID of the Evaluation to retrieve. The evaluation of each MLModel is
recorded and cataloged. The ID provides the means to access the information.
"""
function get_evaluation(EvaluationId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"GetEvaluation",
Dict{String,Any}("EvaluationId" => EvaluationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_evaluation(
EvaluationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"GetEvaluation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EvaluationId" => EvaluationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mlmodel(mlmodel_id)
get_mlmodel(mlmodel_id, params::Dict{String,<:Any})
Returns an MLModel that includes detailed metadata, data source information, and the
current status of the MLModel. GetMLModel provides results in normal or verbose format.
# Arguments
- `mlmodel_id`: The ID assigned to the MLModel at creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Verbose"`: Specifies whether the GetMLModel operation should return Recipe. If true,
Recipe is returned. If false, Recipe is not returned.
"""
function get_mlmodel(MLModelId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"GetMLModel",
Dict{String,Any}("MLModelId" => MLModelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mlmodel(
MLModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"GetMLModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MLModelId" => MLModelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
predict(mlmodel_id, predict_endpoint, record)
predict(mlmodel_id, predict_endpoint, record, params::Dict{String,<:Any})
Generates a prediction for the observation using the specified ML Model. Note: Not all
response parameters will be populated. Whether a response parameter is populated depends on
the type of model requested.
# Arguments
- `mlmodel_id`: A unique identifier of the MLModel.
- `predict_endpoint`:
- `record`:
"""
function predict(
MLModelId, PredictEndpoint, Record; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"Predict",
Dict{String,Any}(
"MLModelId" => MLModelId,
"PredictEndpoint" => PredictEndpoint,
"Record" => Record,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function predict(
MLModelId,
PredictEndpoint,
Record,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"Predict",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MLModelId" => MLModelId,
"PredictEndpoint" => PredictEndpoint,
"Record" => Record,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_batch_prediction(batch_prediction_id, batch_prediction_name)
update_batch_prediction(batch_prediction_id, batch_prediction_name, params::Dict{String,<:Any})
Updates the BatchPredictionName of a BatchPrediction. You can use the GetBatchPrediction
operation to view the contents of the updated data element.
# Arguments
- `batch_prediction_id`: The ID assigned to the BatchPrediction during creation.
- `batch_prediction_name`: A new user-supplied name or description of the BatchPrediction.
"""
function update_batch_prediction(
BatchPredictionId,
BatchPredictionName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"UpdateBatchPrediction",
Dict{String,Any}(
"BatchPredictionId" => BatchPredictionId,
"BatchPredictionName" => BatchPredictionName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_batch_prediction(
BatchPredictionId,
BatchPredictionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"UpdateBatchPrediction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BatchPredictionId" => BatchPredictionId,
"BatchPredictionName" => BatchPredictionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_source(data_source_id, data_source_name)
update_data_source(data_source_id, data_source_name, params::Dict{String,<:Any})
Updates the DataSourceName of a DataSource. You can use the GetDataSource operation to view
the contents of the updated data element.
# Arguments
- `data_source_id`: The ID assigned to the DataSource during creation.
- `data_source_name`: A new user-supplied name or description of the DataSource that will
replace the current description.
"""
function update_data_source(
DataSourceId, DataSourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"UpdateDataSource",
Dict{String,Any}(
"DataSourceId" => DataSourceId, "DataSourceName" => DataSourceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source(
DataSourceId,
DataSourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"UpdateDataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSourceId" => DataSourceId, "DataSourceName" => DataSourceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_evaluation(evaluation_id, evaluation_name)
update_evaluation(evaluation_id, evaluation_name, params::Dict{String,<:Any})
Updates the EvaluationName of an Evaluation. You can use the GetEvaluation operation to
view the contents of the updated data element.
# Arguments
- `evaluation_id`: The ID assigned to the Evaluation during creation.
- `evaluation_name`: A new user-supplied name or description of the Evaluation that will
replace the current content.
"""
function update_evaluation(
EvaluationId, EvaluationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return machine_learning(
"UpdateEvaluation",
Dict{String,Any}(
"EvaluationId" => EvaluationId, "EvaluationName" => EvaluationName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_evaluation(
EvaluationId,
EvaluationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"UpdateEvaluation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EvaluationId" => EvaluationId, "EvaluationName" => EvaluationName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_mlmodel(mlmodel_id)
update_mlmodel(mlmodel_id, params::Dict{String,<:Any})
Updates the MLModelName and the ScoreThreshold of an MLModel. You can use the GetMLModel
operation to view the contents of the updated data element.
# Arguments
- `mlmodel_id`: The ID assigned to the MLModel during creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MLModelName"`: A user-supplied name or description of the MLModel.
- `"ScoreThreshold"`: The ScoreThreshold used in binary classification MLModel that marks
the boundary between a positive prediction and a negative prediction. Output values greater
than or equal to the ScoreThreshold receive a positive result from the MLModel, such as
true. Output values less than the ScoreThreshold receive a negative response from the
MLModel, such as false.
"""
function update_mlmodel(MLModelId; aws_config::AbstractAWSConfig=global_aws_config())
return machine_learning(
"UpdateMLModel",
Dict{String,Any}("MLModelId" => MLModelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_mlmodel(
MLModelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return machine_learning(
"UpdateMLModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MLModelId" => MLModelId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 102811 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: macie2
using AWS.Compat
using AWS.UUIDs
"""
accept_invitation(invitation_id)
accept_invitation(invitation_id, params::Dict{String,<:Any})
Accepts an Amazon Macie membership invitation that was received from a specific account.
# Arguments
- `invitation_id`: The unique identifier for the invitation to accept.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"administratorAccountId"`: The Amazon Web Services account ID for the account that sent
the invitation.
- `"masterAccount"`: (Deprecated) The Amazon Web Services account ID for the account that
sent the invitation. This property has been replaced by the administratorAccountId property
and is retained only for backward compatibility.
"""
function accept_invitation(invitationId; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/invitations/accept",
Dict{String,Any}("invitationId" => invitationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_invitation(
invitationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/invitations/accept",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("invitationId" => invitationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_custom_data_identifiers()
batch_get_custom_data_identifiers(params::Dict{String,<:Any})
Retrieves information about one or more custom data identifiers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ids"`: An array of custom data identifier IDs, one for each custom data identifier to
retrieve information about.
"""
function batch_get_custom_data_identifiers(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/custom-data-identifiers/get";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_custom_data_identifiers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/custom-data-identifiers/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_automated_discovery_accounts()
batch_update_automated_discovery_accounts(params::Dict{String,<:Any})
Changes the status of automated sensitive data discovery for one or more accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accounts"`: An array of objects, one for each account to change the status of automated
sensitive data discovery for. Each object specifies the Amazon Web Services account ID for
an account and a new status for that account.
"""
function batch_update_automated_discovery_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/automated-discovery/accounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_automated_discovery_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/automated-discovery/accounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_allow_list(client_token, criteria, name)
create_allow_list(client_token, criteria, name, params::Dict{String,<:Any})
Creates and defines the settings for an allow list.
# Arguments
- `client_token`: A unique, case-sensitive token that you provide to ensure the idempotency
of the request.
- `criteria`: The criteria that specify the text or text pattern to ignore. The criteria
can be the location and name of an S3 object that lists specific text to ignore
(s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.
- `name`: A custom name for the allow list. The name can contain as many as 128 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A custom description of the allow list. The description can contain as
many as 512 characters.
- `"tags"`: A map of key-value pairs that specifies the tags to associate with the allow
list. An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an
associated tag value. The maximum length of a tag key is 128 characters. The maximum length
of a tag value is 256 characters.
"""
function create_allow_list(
clientToken, criteria, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/allow-lists",
Dict{String,Any}(
"clientToken" => clientToken, "criteria" => criteria, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_allow_list(
clientToken,
criteria,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/allow-lists",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken, "criteria" => criteria, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_classification_job(client_token, job_type, name, s3_job_definition)
create_classification_job(client_token, job_type, name, s3_job_definition, params::Dict{String,<:Any})
Creates and defines the settings for a classification job.
# Arguments
- `client_token`: A unique, case-sensitive token that you provide to ensure the idempotency
of the request.
- `job_type`: The schedule for running the job. Valid values are: ONE_TIME - Run the job
only once. If you specify this value, don't specify a value for the scheduleFrequency
property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this
value, use the scheduleFrequency property to specify the recurrence pattern for the job.
- `name`: A custom name for the job. The name can contain as many as 500 characters.
- `s3_job_definition`: The S3 buckets that contain the objects to analyze, and the scope of
that analysis.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"allowListIds"`: An array of unique identifiers, one for each allow list for the job to
use when it analyzes data.
- `"customDataIdentifierIds"`: An array of unique identifiers, one for each custom data
identifier for the job to use when it analyzes data. To use only managed data identifiers,
don't specify a value for this property and specify a value other than NONE for the
managedDataIdentifierSelector property.
- `"description"`: A custom description of the job. The description can contain as many as
200 characters.
- `"initialRun"`: For a recurring job, specifies whether to analyze all existing, eligible
objects immediately after the job is created (true). To analyze only those objects that are
created or changed after you create the job and before the job's first scheduled run, set
this value to false. If you configure the job to run only once, don't specify a value for
this property.
- `"managedDataIdentifierIds"`: An array of unique identifiers, one for each managed data
identifier for the job to include (use) or exclude (not use) when it analyzes data.
Inclusion or exclusion depends on the managed data identifier selection type that you
specify for the job (managedDataIdentifierSelector). To retrieve a list of valid values for
this property, use the ListManagedDataIdentifiers operation.
- `"managedDataIdentifierSelector"`: The selection type to apply when determining which
managed data identifiers the job uses to analyze data. Valid values are: ALL - Use all
managed data identifiers. If you specify this value, don't specify any values for the
managedDataIdentifierIds property. EXCLUDE - Use all managed data identifiers except the
ones specified by the managedDataIdentifierIds property. INCLUDE - Use only the managed
data identifiers specified by the managedDataIdentifierIds property. NONE - Don't use any
managed data identifiers. If you specify this value, specify at least one value for the
customDataIdentifierIds property and don't specify any values for the
managedDataIdentifierIds property. RECOMMENDED (default) - Use the recommended set of
managed data identifiers. If you specify this value, don't specify any values for the
managedDataIdentifierIds property. If you don't specify a value for this property, the job
uses the recommended set of managed data identifiers. If the job is a recurring job and you
specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that
are released. If you don't specify a value for this property or you specify RECOMMENDED for
a recurring job, each job run automatically uses all the managed data identifiers that are
in the recommended set when the run starts. To learn about individual managed data
identifiers or determine which ones are in the recommended set, see Using managed data
identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
- `"samplingPercentage"`: The sampling depth, as a percentage, for the job to apply when
processing objects. This value determines the percentage of eligible objects that the job
analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at
random, up to the specified percentage, and analyzes all the data in those objects.
- `"scheduleFrequency"`: The recurrence pattern for running the job. To run the job only
once, don't specify a value for this property and set the value for the jobType property to
ONE_TIME.
- `"tags"`: A map of key-value pairs that specifies the tags to associate with the job. A
job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag
value. The maximum length of a tag key is 128 characters. The maximum length of a tag value
is 256 characters.
"""
function create_classification_job(
clientToken,
jobType,
name,
s3JobDefinition;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/jobs",
Dict{String,Any}(
"clientToken" => clientToken,
"jobType" => jobType,
"name" => name,
"s3JobDefinition" => s3JobDefinition,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_classification_job(
clientToken,
jobType,
name,
s3JobDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"jobType" => jobType,
"name" => name,
"s3JobDefinition" => s3JobDefinition,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_data_identifier(name, regex)
create_custom_data_identifier(name, regex, params::Dict{String,<:Any})
Creates and defines the criteria and other settings for a custom data identifier.
# Arguments
- `name`: A custom name for the custom data identifier. The name can contain as many as 128
characters. We strongly recommend that you avoid including any sensitive data in the name
of a custom data identifier. Other users of your account might be able to see this name,
depending on the actions that they're allowed to perform in Amazon Macie.
- `regex`: The regular expression (regex) that defines the pattern to match. The expression
can contain as many as 512 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
- `"description"`: A custom description of the custom data identifier. The description can
contain as many as 512 characters. We strongly recommend that you avoid including any
sensitive data in the description of a custom data identifier. Other users of your account
might be able to see this description, depending on the actions that they're allowed to
perform in Amazon Macie.
- `"ignoreWords"`: An array that lists specific character sequences (ignore words) to
exclude from the results. If the text matched by the regular expression contains any string
in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words.
Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
- `"keywords"`: An array that lists specific character sequences (keywords), one of which
must precede and be within proximity (maximumMatchDistance) of the regular expression to
match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8
characters. Keywords aren't case sensitive.
- `"maximumMatchDistance"`: The maximum number of characters that can exist between the end
of at least one complete character sequence specified by the keywords array and the end of
the text that matches the regex pattern. If a complete keyword precedes all the text that
matches the pattern and the keyword is within the specified distance, Amazon Macie includes
the result. The distance can be 1-300 characters. The default value is 50.
- `"severityLevels"`: The severity to assign to findings that the custom data identifier
produces, based on the number of occurrences of text that match the custom data
identifier's detection criteria. You can specify as many as three SeverityLevel objects in
this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the
occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For
example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer
occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding. If
you don't specify any values for this array, Macie creates findings for S3 objects that
contain at least one occurrence of text that matches the detection criteria, and Macie
assigns the MEDIUM severity to those findings.
- `"tags"`: A map of key-value pairs that specifies the tags to associate with the custom
data identifier. A custom data identifier can have a maximum of 50 tags. Each tag consists
of a tag key and an associated tag value. The maximum length of a tag key is 128
characters. The maximum length of a tag value is 256 characters.
"""
function create_custom_data_identifier(
name, regex; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/custom-data-identifiers",
Dict{String,Any}(
"name" => name, "regex" => regex, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_data_identifier(
name,
regex,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/custom-data-identifiers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "regex" => regex, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_findings_filter(action, finding_criteria, name)
create_findings_filter(action, finding_criteria, name, params::Dict{String,<:Any})
Creates and defines the criteria and other settings for a findings filter.
# Arguments
- `action`: The action to perform on findings that match the filter criteria
(findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the
findings; and, NOOP, don't perform any action on the findings.
- `finding_criteria`: The criteria to use to filter findings.
- `name`: A custom name for the filter. The name must contain at least 3 characters and can
contain as many as 64 characters. We strongly recommend that you avoid including any
sensitive data in the name of a filter. Other users of your account might be able to see
this name, depending on the actions that they're allowed to perform in Amazon Macie.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
- `"description"`: A custom description of the filter. The description can contain as many
as 512 characters. We strongly recommend that you avoid including any sensitive data in the
description of a filter. Other users of your account might be able to see this description,
depending on the actions that they're allowed to perform in Amazon Macie.
- `"position"`: The position of the filter in the list of saved filters on the Amazon Macie
console. This value also determines the order in which the filter is applied to findings,
relative to other filters that are also applied to the findings.
- `"tags"`: A map of key-value pairs that specifies the tags to associate with the filter.
A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an
associated tag value. The maximum length of a tag key is 128 characters. The maximum length
of a tag value is 256 characters.
"""
function create_findings_filter(
action, findingCriteria, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/findingsfilters",
Dict{String,Any}(
"action" => action,
"findingCriteria" => findingCriteria,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_findings_filter(
action,
findingCriteria,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/findingsfilters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action,
"findingCriteria" => findingCriteria,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_invitations(account_ids)
create_invitations(account_ids, params::Dict{String,<:Any})
Sends an Amazon Macie membership invitation to one or more accounts.
# Arguments
- `account_ids`: An array that lists Amazon Web Services account IDs, one for each account
to send the invitation to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"disableEmailNotification"`: Specifies whether to send the invitation as an email
message. If this value is false, Amazon Macie sends the invitation (as an email message) to
the email address that you specified for the recipient's account when you associated the
account with your account. The default value is false.
- `"message"`: Custom text to include in the email message that contains the invitation.
The text can contain as many as 80 alphanumeric characters.
"""
function create_invitations(accountIds; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/invitations",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_invitations(
accountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/invitations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_member(account)
create_member(account, params::Dict{String,<:Any})
Associates an account with an Amazon Macie administrator account.
# Arguments
- `account`: The details of the account to associate with the administrator account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A map of key-value pairs that specifies the tags to associate with the account
in Amazon Macie. An account can have a maximum of 50 tags. Each tag consists of a tag key
and an associated tag value. The maximum length of a tag key is 128 characters. The maximum
length of a tag value is 256 characters.
"""
function create_member(account; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/members",
Dict{String,Any}("account" => account);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_member(
account, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/members",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("account" => account), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sample_findings()
create_sample_findings(params::Dict{String,<:Any})
Creates sample findings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingTypes"`: An array of finding types, one for each type of sample finding to
create. To create a sample of every type of finding that Amazon Macie supports, don't
include this array in your request.
"""
function create_sample_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST", "/findings/sample"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_sample_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/findings/sample",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decline_invitations(account_ids)
decline_invitations(account_ids, params::Dict{String,<:Any})
Declines Amazon Macie membership invitations that were received from specific accounts.
# Arguments
- `account_ids`: An array that lists Amazon Web Services account IDs, one for each account
that sent an invitation to decline.
"""
function decline_invitations(accountIds; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/invitations/decline",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decline_invitations(
accountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/invitations/decline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_allow_list(id)
delete_allow_list(id, params::Dict{String,<:Any})
Deletes an allow list.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ignoreJobChecks"`: Specifies whether to force deletion of the allow list, even if
active classification jobs are configured to use the list. When you try to delete an allow
list, Amazon Macie checks for classification jobs that use the list and have a status other
than COMPLETE or CANCELLED. By default, Macie rejects your request if any jobs meet these
criteria. To skip these checks and delete the list, set this value to true. To delete the
list only if no active jobs are configured to use it, set this value to false.
"""
function delete_allow_list(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"DELETE",
"/allow-lists/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_allow_list(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/allow-lists/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_data_identifier(id)
delete_custom_data_identifier(id, params::Dict{String,<:Any})
Soft deletes a custom data identifier.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function delete_custom_data_identifier(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/custom-data-identifiers/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_data_identifier(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/custom-data-identifiers/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_findings_filter(id)
delete_findings_filter(id, params::Dict{String,<:Any})
Deletes a findings filter.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function delete_findings_filter(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"DELETE",
"/findingsfilters/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_findings_filter(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/findingsfilters/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_invitations(account_ids)
delete_invitations(account_ids, params::Dict{String,<:Any})
Deletes Amazon Macie membership invitations that were received from specific accounts.
# Arguments
- `account_ids`: An array that lists Amazon Web Services account IDs, one for each account
that sent an invitation to delete.
"""
function delete_invitations(accountIds; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/invitations/delete",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_invitations(
accountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/invitations/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_member(id)
delete_member(id, params::Dict{String,<:Any})
Deletes the association between an Amazon Macie administrator account and an account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function delete_member(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"DELETE", "/members/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_member(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/members/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_buckets()
describe_buckets(params::Dict{String,<:Any})
Retrieves (queries) statistical data and other information about one or more S3 buckets
that Amazon Macie monitors and analyzes for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"criteria"`: The criteria to use to filter the query results.
- `"maxResults"`: The maximum number of items to include in each page of the response. The
default value is 50.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
- `"sortCriteria"`: The criteria to use to sort the query results.
"""
function describe_buckets(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST", "/datasources/s3"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_buckets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/datasources/s3",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_classification_job(job_id)
describe_classification_job(job_id, params::Dict{String,<:Any})
Retrieves the status and settings for a classification job.
# Arguments
- `job_id`: The unique identifier for the classification job.
"""
function describe_classification_job(
jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET", "/jobs/$(jobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_classification_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_configuration()
describe_organization_configuration(params::Dict{String,<:Any})
Retrieves the Amazon Macie configuration settings for an organization in Organizations.
"""
function describe_organization_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/admin/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/admin/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_macie()
disable_macie(params::Dict{String,<:Any})
Disables Amazon Macie and deletes all settings and resources for a Macie account.
"""
function disable_macie(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"DELETE", "/macie"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disable_macie(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE", "/macie", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
disable_organization_admin_account(admin_account_id)
disable_organization_admin_account(admin_account_id, params::Dict{String,<:Any})
Disables an account as the delegated Amazon Macie administrator account for an organization
in Organizations.
# Arguments
- `admin_account_id`: The Amazon Web Services account ID of the delegated Amazon Macie
administrator account.
"""
function disable_organization_admin_account(
adminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/admin",
Dict{String,Any}("adminAccountId" => adminAccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_organization_admin_account(
adminAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"DELETE",
"/admin",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("adminAccountId" => adminAccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_from_administrator_account()
disassociate_from_administrator_account(params::Dict{String,<:Any})
Disassociates a member account from its Amazon Macie administrator account.
"""
function disassociate_from_administrator_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/administrator/disassociate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_from_administrator_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/administrator/disassociate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_from_master_account()
disassociate_from_master_account(params::Dict{String,<:Any})
(Deprecated) Disassociates a member account from its Amazon Macie administrator account.
This operation has been replaced by the DisassociateFromAdministratorAccount operation.
"""
function disassociate_from_master_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/master/disassociate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_from_master_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/master/disassociate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_member(id)
disassociate_member(id, params::Dict{String,<:Any})
Disassociates an Amazon Macie administrator account from a member account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function disassociate_member(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/members/disassociate/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_member(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/members/disassociate/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_macie()
enable_macie(params::Dict{String,<:Any})
Enables Amazon Macie and specifies the configuration settings for a Macie account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
- `"findingPublishingFrequency"`: Specifies how often to publish updates to policy findings
for the account. This includes publishing updates to Security Hub and Amazon EventBridge
(formerly Amazon CloudWatch Events).
- `"status"`: Specifies the new status for the account. To enable Amazon Macie and start
all Macie activities for the account, set this value to ENABLED.
"""
function enable_macie(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/macie",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_macie(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/macie",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_organization_admin_account(admin_account_id)
enable_organization_admin_account(admin_account_id, params::Dict{String,<:Any})
Designates an account as the delegated Amazon Macie administrator account for an
organization in Organizations.
# Arguments
- `admin_account_id`: The Amazon Web Services account ID for the account to designate as
the delegated Amazon Macie administrator account for the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
"""
function enable_organization_admin_account(
adminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/admin",
Dict{String,Any}(
"adminAccountId" => adminAccountId, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_organization_admin_account(
adminAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/admin",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"adminAccountId" => adminAccountId, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_administrator_account()
get_administrator_account(params::Dict{String,<:Any})
Retrieves information about the Amazon Macie administrator account for an account.
"""
function get_administrator_account(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/administrator"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_administrator_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/administrator",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_allow_list(id)
get_allow_list(id, params::Dict{String,<:Any})
Retrieves the settings and status of an allow list.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function get_allow_list(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/allow-lists/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_allow_list(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/allow-lists/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_automated_discovery_configuration()
get_automated_discovery_configuration(params::Dict{String,<:Any})
Retrieves the configuration settings and status of automated sensitive data discovery for
an organization or standalone account.
"""
function get_automated_discovery_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/automated-discovery/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_automated_discovery_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/automated-discovery/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_statistics()
get_bucket_statistics(params::Dict{String,<:Any})
Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie
monitors and analyzes for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: The unique identifier for the Amazon Web Services account.
"""
function get_bucket_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/datasources/s3/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/datasources/s3/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_classification_export_configuration()
get_classification_export_configuration(params::Dict{String,<:Any})
Retrieves the configuration settings for storing data classification results.
"""
function get_classification_export_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/classification-export-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_classification_export_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/classification-export-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_classification_scope(id)
get_classification_scope(id, params::Dict{String,<:Any})
Retrieves the classification scope settings for an account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function get_classification_scope(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET",
"/classification-scopes/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_classification_scope(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/classification-scopes/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_custom_data_identifier(id)
get_custom_data_identifier(id, params::Dict{String,<:Any})
Retrieves the criteria and other settings for a custom data identifier.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function get_custom_data_identifier(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET",
"/custom-data-identifiers/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_custom_data_identifier(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/custom-data-identifiers/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_finding_statistics(group_by)
get_finding_statistics(group_by, params::Dict{String,<:Any})
Retrieves (queries) aggregated statistical data about findings.
# Arguments
- `group_by`: The finding property to use to group the query results. Valid values are:
classificationDetails.jobId - The unique identifier for the classification job that
produced the finding. resourcesAffected.s3Bucket.name - The name of the S3 bucket that the
finding applies to. severity.description - The severity level of the finding, such as High
or Medium. type - The type of finding, such as Policy:IAMUser/S3BucketPublic and
SensitiveData:S3Object/Personal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingCriteria"`: The criteria to use to filter the query results.
- `"size"`: The maximum number of items to include in each page of the response.
- `"sortCriteria"`: The criteria to use to sort the query results.
"""
function get_finding_statistics(groupBy; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/findings/statistics",
Dict{String,Any}("groupBy" => groupBy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_finding_statistics(
groupBy, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/findings/statistics",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("groupBy" => groupBy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings(finding_ids)
get_findings(finding_ids, params::Dict{String,<:Any})
Retrieves the details of one or more findings.
# Arguments
- `finding_ids`: An array of strings that lists the unique identifiers for the findings to
retrieve. You can specify as many as 50 unique identifiers in this array.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sortCriteria"`: The criteria for sorting the results of the request.
"""
function get_findings(findingIds; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/findings/describe",
Dict{String,Any}("findingIds" => findingIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings(
findingIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/findings/describe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingIds" => findingIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings_filter(id)
get_findings_filter(id, params::Dict{String,<:Any})
Retrieves the criteria and other settings for a findings filter.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function get_findings_filter(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET",
"/findingsfilters/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings_filter(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/findingsfilters/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings_publication_configuration()
get_findings_publication_configuration(params::Dict{String,<:Any})
Retrieves the configuration settings for publishing findings to Security Hub.
"""
function get_findings_publication_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/findings-publication-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings_publication_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/findings-publication-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_invitations_count()
get_invitations_count(params::Dict{String,<:Any})
Retrieves the count of Amazon Macie membership invitations that were received by an account.
"""
function get_invitations_count(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/invitations/count"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_invitations_count(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/invitations/count",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_macie_session()
get_macie_session(params::Dict{String,<:Any})
Retrieves the status and configuration settings for an Amazon Macie account.
"""
function get_macie_session(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2("GET", "/macie"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_macie_session(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET", "/macie", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_master_account()
get_master_account(params::Dict{String,<:Any})
(Deprecated) Retrieves information about the Amazon Macie administrator account for an
account. This operation has been replaced by the GetAdministratorAccount operation.
"""
function get_master_account(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2("GET", "/master"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_master_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET", "/master", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_member(id)
get_member(id, params::Dict{String,<:Any})
Retrieves information about an account that's associated with an Amazon Macie administrator
account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function get_member(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/members/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_member(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/members/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_profile(resource_arn)
get_resource_profile(resource_arn, params::Dict{String,<:Any})
Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3
bucket.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 bucket that the request applies
to.
"""
function get_resource_profile(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/resource-profiles",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_profile(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"GET",
"/resource-profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reveal_configuration()
get_reveal_configuration(params::Dict{String,<:Any})
Retrieves the status and configuration settings for retrieving occurrences of sensitive
data reported by findings.
"""
function get_reveal_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET",
"/reveal-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reveal_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/reveal-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sensitive_data_occurrences(finding_id)
get_sensitive_data_occurrences(finding_id, params::Dict{String,<:Any})
Retrieves occurrences of sensitive data reported by a finding.
# Arguments
- `finding_id`: The unique identifier for the finding.
"""
function get_sensitive_data_occurrences(
findingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/findings/$(findingId)/reveal";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sensitive_data_occurrences(
findingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"GET",
"/findings/$(findingId)/reveal",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sensitive_data_occurrences_availability(finding_id)
get_sensitive_data_occurrences_availability(finding_id, params::Dict{String,<:Any})
Checks whether occurrences of sensitive data can be retrieved for a finding.
# Arguments
- `finding_id`: The unique identifier for the finding.
"""
function get_sensitive_data_occurrences_availability(
findingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/findings/$(findingId)/reveal/availability";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sensitive_data_occurrences_availability(
findingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"GET",
"/findings/$(findingId)/reveal/availability",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sensitivity_inspection_template(id)
get_sensitivity_inspection_template(id, params::Dict{String,<:Any})
Retrieves the settings for the sensitivity inspection template for an account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
"""
function get_sensitivity_inspection_template(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/templates/sensitivity-inspections/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sensitivity_inspection_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/templates/sensitivity-inspections/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_usage_statistics()
get_usage_statistics(params::Dict{String,<:Any})
Retrieves (queries) quotas and aggregated usage data for one or more accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterBy"`: An array of objects, one for each condition to use to filter the query
results. If you specify more than one condition, Amazon Macie uses an AND operator to join
the conditions.
- `"maxResults"`: The maximum number of items to include in each page of the response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
- `"sortBy"`: The criteria to use to sort the query results.
- `"timeRange"`: The inclusive time period to query usage data for. Valid values are:
MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding
30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding
30 days.
"""
function get_usage_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST", "/usage/statistics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_usage_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/usage/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_usage_totals()
get_usage_totals(params::Dict{String,<:Any})
Retrieves (queries) aggregated usage data for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"timeRange"`: The inclusive time period to retrieve the data for. Valid values are:
MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding
30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated
usage data for the preceding 30 days.
"""
function get_usage_totals(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2("GET", "/usage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_usage_totals(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET", "/usage", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_allow_lists()
list_allow_lists(params::Dict{String,<:Any})
Retrieves a subset of information about all the allow lists for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_allow_lists(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/allow-lists"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_allow_lists(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/allow-lists",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_automated_discovery_accounts()
list_automated_discovery_accounts(params::Dict{String,<:Any})
Retrieves the status of automated sensitive data discovery for one or more accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The Amazon Web Services account ID for each account, for as many as 50
accounts. To retrieve the status for multiple accounts, append the accountIds parameter and
argument for each account, separated by an ampersand (&). To retrieve the status for
all the accounts in an organization, omit this parameter.
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_automated_discovery_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/automated-discovery/accounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_automated_discovery_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/automated-discovery/accounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_classification_jobs()
list_classification_jobs(params::Dict{String,<:Any})
Retrieves a subset of information about one or more classification jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: The criteria to use to filter the results.
- `"maxResults"`: The maximum number of items to include in each page of the response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
- `"sortCriteria"`: The criteria to use to sort the results.
"""
function list_classification_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST", "/jobs/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_classification_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST", "/jobs/list", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_classification_scopes()
list_classification_scopes(params::Dict{String,<:Any})
Retrieves a subset of information about the classification scope for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the classification scope to retrieve the unique identifier for.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_classification_scopes(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET",
"/classification-scopes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_classification_scopes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/classification-scopes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_data_identifiers()
list_custom_data_identifiers(params::Dict{String,<:Any})
Retrieves a subset of information about all the custom data identifiers for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of the response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_custom_data_identifiers(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/custom-data-identifiers/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_data_identifiers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/custom-data-identifiers/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_findings()
list_findings(params::Dict{String,<:Any})
Retrieves a subset of information about one or more findings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingCriteria"`: The criteria to use to filter the results.
- `"maxResults"`: The maximum number of items to include in each page of the response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
- `"sortCriteria"`: The criteria to use to sort the results.
"""
function list_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST", "/findings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST", "/findings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_findings_filters()
list_findings_filters(params::Dict{String,<:Any})
Retrieves a subset of information about all the findings filters for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_findings_filters(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/findingsfilters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_findings_filters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/findingsfilters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_invitations()
list_invitations(params::Dict{String,<:Any})
Retrieves information about Amazon Macie membership invitations that were received by an
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"GET", "/invitations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/invitations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_managed_data_identifiers()
list_managed_data_identifiers(params::Dict{String,<:Any})
Retrieves information about all the managed data identifiers that Amazon Macie currently
provides.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_managed_data_identifiers(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/managed-data-identifiers/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_managed_data_identifiers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/managed-data-identifiers/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_members()
list_members(params::Dict{String,<:Any})
Retrieves information about the accounts that are associated with an Amazon Macie
administrator account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
- `"onlyAssociated"`: Specifies which accounts to include in the response, based on the
status of an account's relationship with the administrator account. By default, the
response includes only current member accounts. To include all accounts, set this value to
false.
"""
function list_members(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2("GET", "/members"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_members(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET", "/members", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_organization_admin_accounts()
list_organization_admin_accounts(params::Dict{String,<:Any})
Retrieves information about the delegated Amazon Macie administrator account for an
organization in Organizations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_organization_admin_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2("GET", "/admin"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_organization_admin_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET", "/admin", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_resource_profile_artifacts(resource_arn)
list_resource_profile_artifacts(resource_arn, params::Dict{String,<:Any})
Retrieves information about objects that Amazon Macie selected from an S3 bucket for
automated sensitive data discovery.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 bucket that the request applies
to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_resource_profile_artifacts(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/resource-profiles/artifacts",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_profile_artifacts(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"GET",
"/resource-profiles/artifacts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_profile_detections(resource_arn)
list_resource_profile_detections(resource_arn, params::Dict{String,<:Any})
Retrieves information about the types and amount of sensitive data that Amazon Macie found
in an S3 bucket.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 bucket that the request applies
to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_resource_profile_detections(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/resource-profiles/detections",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_profile_detections(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"GET",
"/resource-profiles/detections",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sensitivity_inspection_templates()
list_sensitivity_inspection_templates(params::Dict{String,<:Any})
Retrieves a subset of information about the sensitivity inspection template for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in each page of a paginated
response.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
"""
function list_sensitivity_inspection_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/templates/sensitivity-inspections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sensitivity_inspection_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/templates/sensitivity-inspections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_classification_export_configuration(configuration)
put_classification_export_configuration(configuration, params::Dict{String,<:Any})
Adds or updates the configuration settings for storing data classification results.
# Arguments
- `configuration`: The location to store data classification results in, and the encryption
settings to use when storing results in that location.
"""
function put_classification_export_configuration(
configuration; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/classification-export-configuration",
Dict{String,Any}("configuration" => configuration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_classification_export_configuration(
configuration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PUT",
"/classification-export-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("configuration" => configuration), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_findings_publication_configuration()
put_findings_publication_configuration(params::Dict{String,<:Any})
Updates the configuration settings for publishing findings to Security Hub.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
- `"securityHubConfiguration"`: The configuration settings that determine which findings to
publish to Security Hub.
"""
function put_findings_publication_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/findings-publication-configuration",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_findings_publication_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/findings-publication-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_resources()
search_resources(params::Dict{String,<:Any})
Retrieves (queries) statistical data and other information about Amazon Web Services
resources that Amazon Macie monitors and analyzes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bucketCriteria"`: The filter conditions that determine which S3 buckets to include or
exclude from the query results.
- `"maxResults"`: The maximum number of items to include in each page of the response. The
default value is 50.
- `"nextToken"`: The nextToken string that specifies which page of results to return in a
paginated response.
- `"sortCriteria"`: The criteria to use to sort the results.
"""
function search_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/datasources/search-resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/datasources/search-resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie
resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: A map of key-value pairs that specifies the tags to associate with the resource.
A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated
tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag
value is 256 characters.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_custom_data_identifier(regex, sample_text)
test_custom_data_identifier(regex, sample_text, params::Dict{String,<:Any})
Tests criteria for a custom data identifier.
# Arguments
- `regex`: The regular expression (regex) that defines the pattern to match. The expression
can contain as many as 512 characters.
- `sample_text`: The sample text to inspect by using the custom data identifier. The text
can contain as many as 1,000 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ignoreWords"`: An array that lists specific character sequences (ignore words) to
exclude from the results. If the text matched by the regular expression contains any string
in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words.
Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
- `"keywords"`: An array that lists specific character sequences (keywords), one of which
must precede and be within proximity (maximumMatchDistance) of the regular expression to
match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8
characters. Keywords aren't case sensitive.
- `"maximumMatchDistance"`: The maximum number of characters that can exist between the end
of at least one complete character sequence specified by the keywords array and the end of
the text that matches the regex pattern. If a complete keyword precedes all the text that
matches the pattern and the keyword is within the specified distance, Amazon Macie includes
the result. The distance can be 1-300 characters. The default value is 50.
"""
function test_custom_data_identifier(
regex, sampleText; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"POST",
"/custom-data-identifiers/test",
Dict{String,Any}("regex" => regex, "sampleText" => sampleText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_custom_data_identifier(
regex,
sampleText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"POST",
"/custom-data-identifiers/test",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("regex" => regex, "sampleText" => sampleText),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags (keys and values) from an Amazon Macie resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: One or more tags (keys) to remove from the resource. In an HTTP request to
remove multiple tags, append the tagKeys parameter and argument for each tag to remove,
separated by an ampersand (&).
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_allow_list(criteria, id, name)
update_allow_list(criteria, id, name, params::Dict{String,<:Any})
Updates the settings for an allow list.
# Arguments
- `criteria`: The criteria that specify the text or text pattern to ignore. The criteria
can be the location and name of an S3 object that lists specific text to ignore
(s3WordsList), or a regular expression that defines a text pattern to ignore (regex). You
can change a list's underlying criteria, such as the name of the S3 object or the regular
expression to use. However, you can't change the type from s3WordsList to regex or the
other way around.
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
- `name`: A custom name for the allow list. The name can contain as many as 128 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A custom description of the allow list. The description can contain as
many as 512 characters.
"""
function update_allow_list(
criteria, id, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/allow-lists/$(id)",
Dict{String,Any}("criteria" => criteria, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_allow_list(
criteria,
id,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PUT",
"/allow-lists/$(id)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("criteria" => criteria, "name" => name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_automated_discovery_configuration(status)
update_automated_discovery_configuration(status, params::Dict{String,<:Any})
Changes the configuration settings and status of automated sensitive data discovery for an
organization or standalone account.
# Arguments
- `status`: The new status of automated sensitive data discovery for the organization or
account. Valid values are: ENABLED, start or resume all automated sensitive data discovery
activities; and, DISABLED, stop performing all automated sensitive data discovery
activities. If you specify DISABLED for an administrator account, you also disable
automated sensitive data discovery for all member accounts in the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoEnableOrganizationMembers"`: Specifies whether to automatically enable automated
sensitive data discovery for accounts in the organization. Valid values are: ALL (default),
enable it for all existing accounts and new member accounts; NEW, enable it only for new
member accounts; and, NONE, don't enable it for any accounts. If you specify NEW or NONE,
automated sensitive data discovery continues to be enabled for any existing accounts that
it's currently enabled for. To enable or disable it for individual member accounts, specify
NEW or NONE, and then enable or disable it for each account by using the
BatchUpdateAutomatedDiscoveryAccounts operation.
"""
function update_automated_discovery_configuration(
status; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/automated-discovery/configuration",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_automated_discovery_configuration(
status, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/automated-discovery/configuration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_classification_job(job_id, job_status)
update_classification_job(job_id, job_status, params::Dict{String,<:Any})
Changes the status of a classification job.
# Arguments
- `job_id`: The unique identifier for the classification job.
- `job_status`: The new status for the job. Valid values are: CANCELLED - Stops the job
permanently and cancels it. This value is valid only if the job's current status is IDLE,
PAUSED, RUNNING, or USER_PAUSED. If you specify this value and the job's current status is
RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You
can't resume or restart a job after you cancel it. RUNNING - Resumes the job. This value is
valid only if the job's current status is USER_PAUSED. If you paused the job while it was
actively running and you specify this value less than 30 days after you paused the job,
Macie immediately resumes processing from the point where you paused the job. Otherwise,
Macie resumes the job according to the schedule and other settings for the job. USER_PAUSED
- Pauses the job temporarily. This value is valid only if the job's current status is IDLE,
PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING,
Macie immediately begins to pause all processing tasks for the job. If you pause a one-time
job and you don't resume it within 30 days, the job expires and Macie cancels the job. If
you pause a recurring job when its status is RUNNING and you don't resume it within 30
days, the job run expires and Macie cancels the run. To check the expiration date, refer to
the UserPausedDetails.jobExpiresAt property.
"""
function update_classification_job(
jobId, jobStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/jobs/$(jobId)",
Dict{String,Any}("jobStatus" => jobStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_classification_job(
jobId,
jobStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PATCH",
"/jobs/$(jobId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("jobStatus" => jobStatus), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_classification_scope(id)
update_classification_scope(id, params::Dict{String,<:Any})
Updates the classification scope settings for an account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"s3"`: The S3 buckets to add or remove from the exclusion list defined by the
classification scope.
"""
function update_classification_scope(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"PATCH",
"/classification-scopes/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_classification_scope(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/classification-scopes/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_findings_filter(id)
update_findings_filter(id, params::Dict{String,<:Any})
Updates the criteria and other settings for a findings filter.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: The action to perform on findings that match the filter criteria
(findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the
findings; and, NOOP, don't perform any action on the findings.
- `"clientToken"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
- `"description"`: A custom description of the filter. The description can contain as many
as 512 characters. We strongly recommend that you avoid including any sensitive data in the
description of a filter. Other users of your account might be able to see this description,
depending on the actions that they're allowed to perform in Amazon Macie.
- `"findingCriteria"`: The criteria to use to filter findings.
- `"name"`: A custom name for the filter. The name must contain at least 3 characters and
can contain as many as 64 characters. We strongly recommend that you avoid including any
sensitive data in the name of a filter. Other users of your account might be able to see
this name, depending on the actions that they're allowed to perform in Amazon Macie.
- `"position"`: The position of the filter in the list of saved filters on the Amazon Macie
console. This value also determines the order in which the filter is applied to findings,
relative to other filters that are also applied to the findings.
"""
function update_findings_filter(id; aws_config::AbstractAWSConfig=global_aws_config())
return macie2(
"PATCH",
"/findingsfilters/$(id)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_findings_filter(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/findingsfilters/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_macie_session()
update_macie_session(params::Dict{String,<:Any})
Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingPublishingFrequency"`: Specifies how often to publish updates to policy findings
for the account. This includes publishing updates to Security Hub and Amazon EventBridge
(formerly Amazon CloudWatch Events).
- `"status"`: Specifies a new status for the account. Valid values are: ENABLED, resume all
Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the
account.
"""
function update_macie_session(; aws_config::AbstractAWSConfig=global_aws_config())
return macie2("PATCH", "/macie"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function update_macie_session(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH", "/macie", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_member_session(id, status)
update_member_session(id, status, params::Dict{String,<:Any})
Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
- `status`: Specifies the new status for the account. Valid values are: ENABLED, resume all
Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the
account.
"""
function update_member_session(
id, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/macie/members/$(id)",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_member_session(
id,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PATCH",
"/macie/members/$(id)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_organization_configuration(auto_enable)
update_organization_configuration(auto_enable, params::Dict{String,<:Any})
Updates the Amazon Macie configuration settings for an organization in Organizations.
# Arguments
- `auto_enable`: Specifies whether to enable Amazon Macie automatically for accounts that
are added to the organization in Organizations.
"""
function update_organization_configuration(
autoEnable; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/admin/configuration",
Dict{String,Any}("autoEnable" => autoEnable);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_organization_configuration(
autoEnable,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PATCH",
"/admin/configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("autoEnable" => autoEnable), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_profile(resource_arn)
update_resource_profile(resource_arn, params::Dict{String,<:Any})
Updates the sensitivity score for an S3 bucket.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 bucket that the request applies
to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sensitivityScoreOverride"`: The new sensitivity score for the bucket. Valid values are:
100, assign the maximum score and apply the Sensitive label to the bucket; and, null
(empty), assign a score that Amazon Macie calculates automatically after you submit the
request.
"""
function update_resource_profile(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/resource-profiles",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_profile(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PATCH",
"/resource-profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_profile_detections(resource_arn)
update_resource_profile_detections(resource_arn, params::Dict{String,<:Any})
Updates the sensitivity scoring settings for an S3 bucket.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 bucket that the request applies
to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"suppressDataIdentifiers"`: An array of objects, one for each custom data identifier or
managed data identifier that detected the type of sensitive data to start excluding or
including in the bucket's score. To start including all sensitive data types in the score,
don't specify any values for this array.
"""
function update_resource_profile_detections(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PATCH",
"/resource-profiles/detections",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_profile_detections(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PATCH",
"/resource-profiles/detections",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_reveal_configuration(configuration)
update_reveal_configuration(configuration, params::Dict{String,<:Any})
Updates the status and configuration settings for retrieving occurrences of sensitive data
reported by findings.
# Arguments
- `configuration`: The KMS key to use to encrypt the sensitive data, and the status of the
configuration for the Amazon Macie account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"retrievalConfiguration"`: The access method and settings to use when retrieving the
sensitive data.
"""
function update_reveal_configuration(
configuration; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/reveal-configuration",
Dict{String,Any}("configuration" => configuration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_reveal_configuration(
configuration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return macie2(
"PUT",
"/reveal-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("configuration" => configuration), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sensitivity_inspection_template(id)
update_sensitivity_inspection_template(id, params::Dict{String,<:Any})
Updates the settings for the sensitivity inspection template for an account.
# Arguments
- `id`: The unique identifier for the Amazon Macie resource that the request applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A custom description of the template. The description can contain as
many as 200 characters.
- `"excludes"`: The managed data identifiers to explicitly exclude (not use) when
performing automated sensitive data discovery. To exclude an allow list or custom data
identifier that's currently included by the template, update the values for the
SensitivityInspectionTemplateIncludes.allowListIds and
SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.
- `"includes"`: The allow lists, custom data identifiers, and managed data identifiers to
explicitly include (use) when performing automated sensitive data discovery.
"""
function update_sensitivity_inspection_template(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/templates/sensitivity-inspections/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sensitivity_inspection_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return macie2(
"PUT",
"/templates/sensitivity-inspections/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 58133 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mailmanager
using AWS.Compat
using AWS.UUIDs
"""
create_addon_instance(addon_subscription_id)
create_addon_instance(addon_subscription_id, params::Dict{String,<:Any})
Creates an Add On instance for the subscription indicated in the request. The resulting
Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic
policy.
# Arguments
- `addon_subscription_id`: The unique ID of a previously created subscription that an Add
On instance is created for. You can only have one instance per subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that Amazon SES uses to recognize subsequent retries of
the same request.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_addon_instance(
AddonSubscriptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"CreateAddonInstance",
Dict{String,Any}(
"AddonSubscriptionId" => AddonSubscriptionId, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_addon_instance(
AddonSubscriptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateAddonInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddonSubscriptionId" => AddonSubscriptionId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_addon_subscription(addon_name)
create_addon_subscription(addon_name, params::Dict{String,<:Any})
Creates a subscription for an Add On representing the acceptance of its terms of use and
additional pricing. The subscription can then be used to create an instance for use in rule
sets or traffic policies.
# Arguments
- `addon_name`: The name of the Add On to subscribe to. You can only have one subscription
for each Add On name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that Amazon SES uses to recognize subsequent retries of
the same request.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_addon_subscription(
AddonName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"CreateAddonSubscription",
Dict{String,Any}("AddonName" => AddonName, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_addon_subscription(
AddonName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateAddonSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddonName" => AddonName, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_archive(archive_name)
create_archive(archive_name, params::Dict{String,<:Any})
Creates a new email archive resource for storing and retaining emails.
# Arguments
- `archive_name`: A unique name for the new archive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token Amazon SES uses to recognize retries of this request.
- `"KmsKeyArn"`: The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the
archive.
- `"Retention"`: The period for retaining emails in the archive before automatic deletion.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_archive(ArchiveName; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"CreateArchive",
Dict{String,Any}("ArchiveName" => ArchiveName, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_archive(
ArchiveName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateArchive",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArchiveName" => ArchiveName, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ingress_point(ingress_point_name, rule_set_id, traffic_policy_id, type)
create_ingress_point(ingress_point_name, rule_set_id, traffic_policy_id, type, params::Dict{String,<:Any})
Provision a new ingress endpoint resource.
# Arguments
- `ingress_point_name`: A user friendly name for an ingress endpoint resource.
- `rule_set_id`: The identifier of an existing rule set that you attach to an ingress
endpoint resource.
- `traffic_policy_id`: The identifier of an existing traffic policy that you attach to an
ingress endpoint resource.
- `type`: The type of the ingress endpoint to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that Amazon SES uses to recognize subsequent retries of
the same request.
- `"IngressPointConfiguration"`: If you choose an Authenticated ingress endpoint, you must
configure either an SMTP password or a secret ARN.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_ingress_point(
IngressPointName,
RuleSetId,
TrafficPolicyId,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateIngressPoint",
Dict{String,Any}(
"IngressPointName" => IngressPointName,
"RuleSetId" => RuleSetId,
"TrafficPolicyId" => TrafficPolicyId,
"Type" => Type,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ingress_point(
IngressPointName,
RuleSetId,
TrafficPolicyId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateIngressPoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IngressPointName" => IngressPointName,
"RuleSetId" => RuleSetId,
"TrafficPolicyId" => TrafficPolicyId,
"Type" => Type,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_relay(authentication, relay_name, server_name, server_port)
create_relay(authentication, relay_name, server_name, server_port, params::Dict{String,<:Any})
Creates a relay resource which can be used in rules to relay incoming emails to defined
relay destinations.
# Arguments
- `authentication`: Authentication for the relay destination server—specify the secretARN
where the SMTP credentials are stored.
- `relay_name`: The unique name of the relay resource.
- `server_name`: The destination relay server address.
- `server_port`: The destination relay server port.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that Amazon SES uses to recognize subsequent retries of
the same request.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_relay(
Authentication,
RelayName,
ServerName,
ServerPort;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateRelay",
Dict{String,Any}(
"Authentication" => Authentication,
"RelayName" => RelayName,
"ServerName" => ServerName,
"ServerPort" => ServerPort,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_relay(
Authentication,
RelayName,
ServerName,
ServerPort,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateRelay",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Authentication" => Authentication,
"RelayName" => RelayName,
"ServerName" => ServerName,
"ServerPort" => ServerPort,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule_set(rule_set_name, rules)
create_rule_set(rule_set_name, rules, params::Dict{String,<:Any})
Provision a new rule set.
# Arguments
- `rule_set_name`: A user-friendly name for the rule set.
- `rules`: Conditional rules that are evaluated for determining actions on email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that Amazon SES uses to recognize subsequent retries of
the same request.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_rule_set(
RuleSetName, Rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"CreateRuleSet",
Dict{String,Any}(
"RuleSetName" => RuleSetName, "Rules" => Rules, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule_set(
RuleSetName,
Rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RuleSetName" => RuleSetName,
"Rules" => Rules,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_policy(default_action, policy_statements, traffic_policy_name)
create_traffic_policy(default_action, policy_statements, traffic_policy_name, params::Dict{String,<:Any})
Provision a new traffic policy resource.
# Arguments
- `default_action`: Default action instructs the traffic policy to either Allow or Deny
(block) messages that fall outside of (or not addressed by) the conditions of your policy
statements
- `policy_statements`: Conditional statements for filtering email traffic.
- `traffic_policy_name`: A user-friendly name for the traffic policy resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that Amazon SES uses to recognize subsequent retries of
the same request.
- `"MaxMessageSizeBytes"`: The maximum message size in bytes of email which is allowed in
by this traffic policy—anything larger will be blocked.
- `"Tags"`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_traffic_policy(
DefaultAction,
PolicyStatements,
TrafficPolicyName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateTrafficPolicy",
Dict{String,Any}(
"DefaultAction" => DefaultAction,
"PolicyStatements" => PolicyStatements,
"TrafficPolicyName" => TrafficPolicyName,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_policy(
DefaultAction,
PolicyStatements,
TrafficPolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"CreateTrafficPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultAction" => DefaultAction,
"PolicyStatements" => PolicyStatements,
"TrafficPolicyName" => TrafficPolicyName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_addon_instance(addon_instance_id)
delete_addon_instance(addon_instance_id, params::Dict{String,<:Any})
Deletes an Add On instance.
# Arguments
- `addon_instance_id`: The Add On instance ID to delete.
"""
function delete_addon_instance(
AddonInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"DeleteAddonInstance",
Dict{String,Any}("AddonInstanceId" => AddonInstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_addon_instance(
AddonInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"DeleteAddonInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AddonInstanceId" => AddonInstanceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_addon_subscription(addon_subscription_id)
delete_addon_subscription(addon_subscription_id, params::Dict{String,<:Any})
Deletes an Add On subscription.
# Arguments
- `addon_subscription_id`: The Add On subscription ID to delete.
"""
function delete_addon_subscription(
AddonSubscriptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"DeleteAddonSubscription",
Dict{String,Any}("AddonSubscriptionId" => AddonSubscriptionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_addon_subscription(
AddonSubscriptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"DeleteAddonSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AddonSubscriptionId" => AddonSubscriptionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_archive(archive_id)
delete_archive(archive_id, params::Dict{String,<:Any})
Initiates deletion of an email archive. This changes the archive state to pending deletion.
In this state, no new emails can be added, and existing archived emails become inaccessible
(search, export, download). The archive and all of its contents will be permanently deleted
30 days after entering the pending deletion state, regardless of the configured retention
period.
# Arguments
- `archive_id`: The identifier of the archive to delete.
"""
function delete_archive(ArchiveId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"DeleteArchive",
Dict{String,Any}("ArchiveId" => ArchiveId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_archive(
ArchiveId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"DeleteArchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveId" => ArchiveId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ingress_point(ingress_point_id)
delete_ingress_point(ingress_point_id, params::Dict{String,<:Any})
Delete an ingress endpoint resource.
# Arguments
- `ingress_point_id`: The identifier of the ingress endpoint resource that you want to
delete.
"""
function delete_ingress_point(
IngressPointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"DeleteIngressPoint",
Dict{String,Any}("IngressPointId" => IngressPointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ingress_point(
IngressPointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"DeleteIngressPoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IngressPointId" => IngressPointId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_relay(relay_id)
delete_relay(relay_id, params::Dict{String,<:Any})
Deletes an existing relay resource.
# Arguments
- `relay_id`: The unique relay identifier.
"""
function delete_relay(RelayId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"DeleteRelay",
Dict{String,Any}("RelayId" => RelayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_relay(
RelayId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"DeleteRelay",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RelayId" => RelayId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule_set(rule_set_id)
delete_rule_set(rule_set_id, params::Dict{String,<:Any})
Delete a rule set.
# Arguments
- `rule_set_id`: The identifier of an existing rule set resource to delete.
"""
function delete_rule_set(RuleSetId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"DeleteRuleSet",
Dict{String,Any}("RuleSetId" => RuleSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule_set(
RuleSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"DeleteRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetId" => RuleSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_policy(traffic_policy_id)
delete_traffic_policy(traffic_policy_id, params::Dict{String,<:Any})
Delete a traffic policy resource.
# Arguments
- `traffic_policy_id`: The identifier of the traffic policy that you want to delete.
"""
function delete_traffic_policy(
TrafficPolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"DeleteTrafficPolicy",
Dict{String,Any}("TrafficPolicyId" => TrafficPolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_policy(
TrafficPolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"DeleteTrafficPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrafficPolicyId" => TrafficPolicyId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_addon_instance(addon_instance_id)
get_addon_instance(addon_instance_id, params::Dict{String,<:Any})
Gets detailed information about an Add On instance.
# Arguments
- `addon_instance_id`: The Add On instance ID to retrieve information for.
"""
function get_addon_instance(
AddonInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetAddonInstance",
Dict{String,Any}("AddonInstanceId" => AddonInstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_addon_instance(
AddonInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetAddonInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AddonInstanceId" => AddonInstanceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_addon_subscription(addon_subscription_id)
get_addon_subscription(addon_subscription_id, params::Dict{String,<:Any})
Gets detailed information about an Add On subscription.
# Arguments
- `addon_subscription_id`: The Add On subscription ID to retrieve information for.
"""
function get_addon_subscription(
AddonSubscriptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetAddonSubscription",
Dict{String,Any}("AddonSubscriptionId" => AddonSubscriptionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_addon_subscription(
AddonSubscriptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetAddonSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AddonSubscriptionId" => AddonSubscriptionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_archive(archive_id)
get_archive(archive_id, params::Dict{String,<:Any})
Retrieves the full details and current state of a specified email archive.
# Arguments
- `archive_id`: The identifier of the archive to retrieve.
"""
function get_archive(ArchiveId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"GetArchive",
Dict{String,Any}("ArchiveId" => ArchiveId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_archive(
ArchiveId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetArchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveId" => ArchiveId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_archive_export(export_id)
get_archive_export(export_id, params::Dict{String,<:Any})
Retrieves the details and current status of a specific email archive export job.
# Arguments
- `export_id`: The identifier of the export job to get details for.
"""
function get_archive_export(ExportId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"GetArchiveExport",
Dict{String,Any}("ExportId" => ExportId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_archive_export(
ExportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetArchiveExport",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExportId" => ExportId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_archive_message(archived_message_id)
get_archive_message(archived_message_id, params::Dict{String,<:Any})
Returns a pre-signed URL that provides temporary download access to the specific email
message stored in the archive.
# Arguments
- `archived_message_id`: The unique identifier of the archived email message.
"""
function get_archive_message(
ArchivedMessageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetArchiveMessage",
Dict{String,Any}("ArchivedMessageId" => ArchivedMessageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_archive_message(
ArchivedMessageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetArchiveMessage",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ArchivedMessageId" => ArchivedMessageId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_archive_message_content(archived_message_id)
get_archive_message_content(archived_message_id, params::Dict{String,<:Any})
Returns the textual content of a specific email message stored in the archive. Attachments
are not included.
# Arguments
- `archived_message_id`: The unique identifier of the archived email message.
"""
function get_archive_message_content(
ArchivedMessageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetArchiveMessageContent",
Dict{String,Any}("ArchivedMessageId" => ArchivedMessageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_archive_message_content(
ArchivedMessageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetArchiveMessageContent",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ArchivedMessageId" => ArchivedMessageId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_archive_search(search_id)
get_archive_search(search_id, params::Dict{String,<:Any})
Retrieves the details and current status of a specific email archive search job.
# Arguments
- `search_id`: The identifier of the search job to get details for.
"""
function get_archive_search(SearchId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"GetArchiveSearch",
Dict{String,Any}("SearchId" => SearchId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_archive_search(
SearchId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetArchiveSearch",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SearchId" => SearchId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_archive_search_results(search_id)
get_archive_search_results(search_id, params::Dict{String,<:Any})
Returns the results of a completed email archive search job.
# Arguments
- `search_id`: The identifier of the completed search job.
"""
function get_archive_search_results(
SearchId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetArchiveSearchResults",
Dict{String,Any}("SearchId" => SearchId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_archive_search_results(
SearchId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetArchiveSearchResults",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SearchId" => SearchId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ingress_point(ingress_point_id)
get_ingress_point(ingress_point_id, params::Dict{String,<:Any})
Fetch ingress endpoint resource attributes.
# Arguments
- `ingress_point_id`: The identifier of an ingress endpoint.
"""
function get_ingress_point(
IngressPointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetIngressPoint",
Dict{String,Any}("IngressPointId" => IngressPointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ingress_point(
IngressPointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetIngressPoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IngressPointId" => IngressPointId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_relay(relay_id)
get_relay(relay_id, params::Dict{String,<:Any})
Fetch the relay resource and it's attributes.
# Arguments
- `relay_id`: A unique relay identifier.
"""
function get_relay(RelayId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"GetRelay",
Dict{String,Any}("RelayId" => RelayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_relay(
RelayId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetRelay",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RelayId" => RelayId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule_set(rule_set_id)
get_rule_set(rule_set_id, params::Dict{String,<:Any})
Fetch attributes of a rule set.
# Arguments
- `rule_set_id`: The identifier of an existing rule set to be retrieved.
"""
function get_rule_set(RuleSetId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"GetRuleSet",
Dict{String,Any}("RuleSetId" => RuleSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule_set(
RuleSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetId" => RuleSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_traffic_policy(traffic_policy_id)
get_traffic_policy(traffic_policy_id, params::Dict{String,<:Any})
Fetch attributes of a traffic policy resource.
# Arguments
- `traffic_policy_id`: The identifier of the traffic policy resource.
"""
function get_traffic_policy(
TrafficPolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"GetTrafficPolicy",
Dict{String,Any}("TrafficPolicyId" => TrafficPolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_traffic_policy(
TrafficPolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"GetTrafficPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrafficPolicyId" => TrafficPolicyId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_addon_instances()
list_addon_instances(params::Dict{String,<:Any})
Lists all Add On instances in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you received a pagination token from a previous call to this API, you
can provide it here to continue paginating through the next page of results.
- `"PageSize"`: The maximum number of ingress endpoint resources that are returned per
call. You can use NextToken to obtain further ingress endpoints.
"""
function list_addon_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListAddonInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_addon_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListAddonInstances", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_addon_subscriptions()
list_addon_subscriptions(params::Dict{String,<:Any})
Lists all Add On subscriptions in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you received a pagination token from a previous call to this API, you
can provide it here to continue paginating through the next page of results.
- `"PageSize"`: The maximum number of ingress endpoint resources that are returned per
call. You can use NextToken to obtain further ingress endpoints.
"""
function list_addon_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListAddonSubscriptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_addon_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListAddonSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_archive_exports(archive_id)
list_archive_exports(archive_id, params::Dict{String,<:Any})
Returns a list of email archive export jobs.
# Arguments
- `archive_id`: The identifier of the archive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If NextToken is returned, there are more results available. The value of
NextToken is a unique pagination token for each page. Make the call again using the
returned token to retrieve the next page.
- `"PageSize"`: The maximum number of archive export jobs that are returned per call. You
can use NextToken to obtain further pages of archives.
"""
function list_archive_exports(ArchiveId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListArchiveExports",
Dict{String,Any}("ArchiveId" => ArchiveId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_archive_exports(
ArchiveId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"ListArchiveExports",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveId" => ArchiveId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_archive_searches(archive_id)
list_archive_searches(archive_id, params::Dict{String,<:Any})
Returns a list of email archive search jobs.
# Arguments
- `archive_id`: The identifier of the archive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If NextToken is returned, there are more results available. The value of
NextToken is a unique pagination token for each page. Make the call again using the
returned token to retrieve the next page.
- `"PageSize"`: The maximum number of archive search jobs that are returned per call. You
can use NextToken to obtain further pages of archives.
"""
function list_archive_searches(ArchiveId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListArchiveSearches",
Dict{String,Any}("ArchiveId" => ArchiveId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_archive_searches(
ArchiveId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"ListArchiveSearches",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveId" => ArchiveId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_archives()
list_archives(params::Dict{String,<:Any})
Returns a list of all email archives in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If NextToken is returned, there are more results available. The value of
NextToken is a unique pagination token for each page. Make the call again using the
returned token to retrieve the next page.
- `"PageSize"`: The maximum number of archives that are returned per call. You can use
NextToken to obtain further pages of archives.
"""
function list_archives(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListArchives"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_archives(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListArchives", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_ingress_points()
list_ingress_points(params::Dict{String,<:Any})
List all ingress endpoint resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you received a pagination token from a previous call to this API, you
can provide it here to continue paginating through the next page of results.
- `"PageSize"`: The maximum number of ingress endpoint resources that are returned per
call. You can use NextToken to obtain further ingress endpoints.
"""
function list_ingress_points(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListIngressPoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_ingress_points(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListIngressPoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_relays()
list_relays(params::Dict{String,<:Any})
Lists all the existing relay resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you received a pagination token from a previous call to this API, you
can provide it here to continue paginating through the next page of results.
- `"PageSize"`: The number of relays to be returned in one request.
"""
function list_relays(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager("ListRelays"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_relays(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListRelays", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rule_sets()
list_rule_sets(params::Dict{String,<:Any})
List rule sets for this account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you received a pagination token from a previous call to this API, you
can provide it here to continue paginating through the next page of results.
- `"PageSize"`: The maximum number of rule set resources that are returned per call. You
can use NextToken to obtain further rule sets.
"""
function list_rule_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListRuleSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rule_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListRuleSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the list of tags (keys and values) assigned to the resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to retrieve tags from.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_policies()
list_traffic_policies(params::Dict{String,<:Any})
List traffic policy resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If you received a pagination token from a previous call to this API, you
can provide it here to continue paginating through the next page of results.
- `"PageSize"`: The maximum number of traffic policy resources that are returned per call.
You can use NextToken to obtain further traffic policies.
"""
function list_traffic_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"ListTrafficPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_traffic_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"ListTrafficPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_archive_export(archive_id, export_destination_configuration, from_timestamp, to_timestamp)
start_archive_export(archive_id, export_destination_configuration, from_timestamp, to_timestamp, params::Dict{String,<:Any})
Initiates an export of emails from the specified archive.
# Arguments
- `archive_id`: The identifier of the archive to export emails from.
- `export_destination_configuration`: Details on where to deliver the exported email data.
- `from_timestamp`: The start of the timestamp range to include emails from.
- `to_timestamp`: The end of the timestamp range to include emails from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Criteria to filter which emails are included in the export.
- `"MaxResults"`: The maximum number of email items to include in the export.
"""
function start_archive_export(
ArchiveId,
ExportDestinationConfiguration,
FromTimestamp,
ToTimestamp;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"StartArchiveExport",
Dict{String,Any}(
"ArchiveId" => ArchiveId,
"ExportDestinationConfiguration" => ExportDestinationConfiguration,
"FromTimestamp" => FromTimestamp,
"ToTimestamp" => ToTimestamp,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_archive_export(
ArchiveId,
ExportDestinationConfiguration,
FromTimestamp,
ToTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"StartArchiveExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArchiveId" => ArchiveId,
"ExportDestinationConfiguration" => ExportDestinationConfiguration,
"FromTimestamp" => FromTimestamp,
"ToTimestamp" => ToTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_archive_search(archive_id, from_timestamp, max_results, to_timestamp)
start_archive_search(archive_id, from_timestamp, max_results, to_timestamp, params::Dict{String,<:Any})
Initiates a search across emails in the specified archive.
# Arguments
- `archive_id`: The identifier of the archive to search emails in.
- `from_timestamp`: The start timestamp of the range to search emails from.
- `max_results`: The maximum number of search results to return.
- `to_timestamp`: The end timestamp of the range to search emails from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Criteria to filter which emails are included in the search results.
"""
function start_archive_search(
ArchiveId,
FromTimestamp,
MaxResults,
ToTimestamp;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"StartArchiveSearch",
Dict{String,Any}(
"ArchiveId" => ArchiveId,
"FromTimestamp" => FromTimestamp,
"MaxResults" => MaxResults,
"ToTimestamp" => ToTimestamp,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_archive_search(
ArchiveId,
FromTimestamp,
MaxResults,
ToTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"StartArchiveSearch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArchiveId" => ArchiveId,
"FromTimestamp" => FromTimestamp,
"MaxResults" => MaxResults,
"ToTimestamp" => ToTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_archive_export(export_id)
stop_archive_export(export_id, params::Dict{String,<:Any})
Stops an in-progress export of emails from an archive.
# Arguments
- `export_id`: The identifier of the export job to stop.
"""
function stop_archive_export(ExportId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"StopArchiveExport",
Dict{String,Any}("ExportId" => ExportId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_archive_export(
ExportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"StopArchiveExport",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExportId" => ExportId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_archive_search(search_id)
stop_archive_search(search_id, params::Dict{String,<:Any})
Stops an in-progress archive search job.
# Arguments
- `search_id`: The identifier of the search job to stop.
"""
function stop_archive_search(SearchId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"StopArchiveSearch",
Dict{String,Any}("SearchId" => SearchId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_archive_search(
SearchId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"StopArchiveSearch",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SearchId" => SearchId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags (keys and values) to a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to tag.
- `tags`: The tags used to organize, track, or control access for the resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Remove one or more tags (keys and values) from a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to untag.
- `tag_keys`: The keys of the key-value pairs for the tag or tags you want to remove from
the specified resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_archive(archive_id)
update_archive(archive_id, params::Dict{String,<:Any})
Updates the attributes of an existing email archive.
# Arguments
- `archive_id`: The identifier of the archive to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArchiveName"`: A new, unique name for the archive.
- `"Retention"`: A new retention period for emails in the archive.
"""
function update_archive(ArchiveId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"UpdateArchive",
Dict{String,Any}("ArchiveId" => ArchiveId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_archive(
ArchiveId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"UpdateArchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveId" => ArchiveId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ingress_point(ingress_point_id)
update_ingress_point(ingress_point_id, params::Dict{String,<:Any})
Update attributes of a provisioned ingress endpoint resource.
# Arguments
- `ingress_point_id`: The identifier for the ingress endpoint you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IngressPointConfiguration"`: If you choose an Authenticated ingress endpoint, you must
configure either an SMTP password or a secret ARN.
- `"IngressPointName"`: A user friendly name for the ingress endpoint resource.
- `"RuleSetId"`: The identifier of an existing rule set that you attach to an ingress
endpoint resource.
- `"StatusToUpdate"`: The update status of an ingress endpoint.
- `"TrafficPolicyId"`: The identifier of an existing traffic policy that you attach to an
ingress endpoint resource.
"""
function update_ingress_point(
IngressPointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"UpdateIngressPoint",
Dict{String,Any}("IngressPointId" => IngressPointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ingress_point(
IngressPointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"UpdateIngressPoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IngressPointId" => IngressPointId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_relay(relay_id)
update_relay(relay_id, params::Dict{String,<:Any})
Updates the attributes of an existing relay resource.
# Arguments
- `relay_id`: The unique relay identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Authentication for the relay destination server—specify the
secretARN where the SMTP credentials are stored.
- `"RelayName"`: The name of the relay resource.
- `"ServerName"`: The destination relay server address.
- `"ServerPort"`: The destination relay server port.
"""
function update_relay(RelayId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"UpdateRelay",
Dict{String,Any}("RelayId" => RelayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_relay(
RelayId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"UpdateRelay",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RelayId" => RelayId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_set(rule_set_id)
update_rule_set(rule_set_id, params::Dict{String,<:Any})
>Update attributes of an already provisioned rule set.
# Arguments
- `rule_set_id`: The identifier of a rule set you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RuleSetName"`: A user-friendly name for the rule set resource.
- `"Rules"`: A new set of rules to replace the current rules of the rule set—these rules
will override all the rules of the rule set.
"""
function update_rule_set(RuleSetId; aws_config::AbstractAWSConfig=global_aws_config())
return mailmanager(
"UpdateRuleSet",
Dict{String,Any}("RuleSetId" => RuleSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_set(
RuleSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"UpdateRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetId" => RuleSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_traffic_policy(traffic_policy_id)
update_traffic_policy(traffic_policy_id, params::Dict{String,<:Any})
Update attributes of an already provisioned traffic policy resource.
# Arguments
- `traffic_policy_id`: The identifier of the traffic policy that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultAction"`: Default action instructs the traffic policy to either Allow or Deny
(block) messages that fall outside of (or not addressed by) the conditions of your policy
statements
- `"MaxMessageSizeBytes"`: The maximum message size in bytes of email which is allowed in
by this traffic policy—anything larger will be blocked.
- `"PolicyStatements"`: The list of conditions to be updated for filtering email traffic.
- `"TrafficPolicyName"`: A user-friendly name for the traffic policy resource.
"""
function update_traffic_policy(
TrafficPolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mailmanager(
"UpdateTrafficPolicy",
Dict{String,Any}("TrafficPolicyId" => TrafficPolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_traffic_policy(
TrafficPolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mailmanager(
"UpdateTrafficPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrafficPolicyId" => TrafficPolicyId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 41555 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: managedblockchain
using AWS.Compat
using AWS.UUIDs
"""
create_accessor(accessor_type, client_request_token)
create_accessor(accessor_type, client_request_token, params::Dict{String,<:Any})
Creates a new accessor for use with Amazon Managed Blockchain service that supports token
based access. The accessor contains information required for token based access.
# Arguments
- `accessor_type`: The type of accessor. Currently, accessor type is restricted to
BILLING_TOKEN.
- `client_request_token`: This is a unique, case-sensitive identifier that you provide to
ensure the idempotency of the operation. An idempotent operation completes no more than
once. This identifier is required only if you make a service request directly using an HTTP
client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon
Web Services CLI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NetworkType"`: The blockchain network that the Accessor token is created for. Use
the actual networkType value for the blockchain network that you are creating the Accessor
token for. With the shut down of the Ethereum Goerli and Polygon Mumbai Testnet networks
the following networkType values are no longer available for selection and use.
ETHEREUM_MAINNET_AND_GOERLI ETHEREUM_GOERLI POLYGON_MUMBAI However, your
existing Accessor tokens with these networkType values will remain unchanged.
- `"Tags"`: Tags to assign to the Accessor. Each tag consists of a key and an optional
value. You can specify multiple key-value pairs in a single request with an overall maximum
of 50 tags allowed per resource. For more information about tags, see Tagging Resources in
the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon
Managed Blockchain Hyperledger Fabric Developer Guide.
"""
function create_accessor(
AccessorType, ClientRequestToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"POST",
"/accessors",
Dict{String,Any}(
"AccessorType" => AccessorType, "ClientRequestToken" => ClientRequestToken
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_accessor(
AccessorType,
ClientRequestToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/accessors",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessorType" => AccessorType,
"ClientRequestToken" => ClientRequestToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_member(client_request_token, invitation_id, member_configuration, network_id)
create_member(client_request_token, invitation_id, member_configuration, network_id, params::Dict{String,<:Any})
Creates a member within a Managed Blockchain network. Applies only to Hyperledger Fabric.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than one time.
This identifier is required only if you make a service request directly using an HTTP
client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.
- `invitation_id`: The unique identifier of the invitation that is sent to the member to
join the network.
- `member_configuration`: Member configuration parameters.
- `network_id`: The unique identifier of the network in which the member is created.
"""
function create_member(
ClientRequestToken,
InvitationId,
MemberConfiguration,
networkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/members",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"InvitationId" => InvitationId,
"MemberConfiguration" => MemberConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_member(
ClientRequestToken,
InvitationId,
MemberConfiguration,
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/members",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"InvitationId" => InvitationId,
"MemberConfiguration" => MemberConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network(client_request_token, framework, framework_version, member_configuration, name, voting_policy)
create_network(client_request_token, framework, framework_version, member_configuration, name, voting_policy, params::Dict{String,<:Any})
Creates a new blockchain network using Amazon Managed Blockchain. Applies only to
Hyperledger Fabric.
# Arguments
- `client_request_token`: This is a unique, case-sensitive identifier that you provide to
ensure the idempotency of the operation. An idempotent operation completes no more than
once. This identifier is required only if you make a service request directly using an HTTP
client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon
Web Services CLI.
- `framework`: The blockchain framework that the network uses.
- `framework_version`: The version of the blockchain framework that the network uses.
- `member_configuration`: Configuration properties for the first member within the network.
- `name`: The name of the network.
- `voting_policy`: The voting rules used by the network to determine if a proposal is
approved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for the network.
- `"FrameworkConfiguration"`: Configuration properties of the blockchain framework
relevant to the network configuration.
- `"Tags"`: Tags to assign to the network. Each tag consists of a key and an optional
value. You can specify multiple key-value pairs in a single request with an overall maximum
of 50 tags allowed per resource. For more information about tags, see Tagging Resources in
the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon
Managed Blockchain Hyperledger Fabric Developer Guide.
"""
function create_network(
ClientRequestToken,
Framework,
FrameworkVersion,
MemberConfiguration,
Name,
VotingPolicy;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Framework" => Framework,
"FrameworkVersion" => FrameworkVersion,
"MemberConfiguration" => MemberConfiguration,
"Name" => Name,
"VotingPolicy" => VotingPolicy,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network(
ClientRequestToken,
Framework,
FrameworkVersion,
MemberConfiguration,
Name,
VotingPolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Framework" => Framework,
"FrameworkVersion" => FrameworkVersion,
"MemberConfiguration" => MemberConfiguration,
"Name" => Name,
"VotingPolicy" => VotingPolicy,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_node(client_request_token, node_configuration, network_id)
create_node(client_request_token, node_configuration, network_id, params::Dict{String,<:Any})
Creates a node on the specified blockchain network. Applies to Hyperledger Fabric and
Ethereum.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than one time.
This identifier is required only if you make a service request directly using an HTTP
client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.
- `node_configuration`: The properties of a node configuration.
- `network_id`: The unique identifier of the network for the node. Ethereum public networks
have the following NetworkIds: n-ethereum-mainnet
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MemberId"`: The unique identifier of the member that owns this node. Applies only to
Hyperledger Fabric.
- `"Tags"`: Tags to assign to the node. Each tag consists of a key and an optional value.
You can specify multiple key-value pairs in a single request with an overall maximum of 50
tags allowed per resource. For more information about tags, see Tagging Resources in the
Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon
Managed Blockchain Hyperledger Fabric Developer Guide.
"""
function create_node(
ClientRequestToken,
NodeConfiguration,
networkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/nodes",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"NodeConfiguration" => NodeConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_node(
ClientRequestToken,
NodeConfiguration,
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/nodes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"NodeConfiguration" => NodeConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_proposal(actions, client_request_token, member_id, network_id)
create_proposal(actions, client_request_token, member_id, network_id, params::Dict{String,<:Any})
Creates a proposal for a change to the network that other members of the network can vote
on, for example, a proposal to add a new member to the network. Any member can create a
proposal. Applies only to Hyperledger Fabric.
# Arguments
- `actions`: The type of actions proposed, such as inviting a member or removing a member.
The types of Actions in a proposal are mutually exclusive. For example, a proposal with
Invitations actions cannot also contain Removals actions.
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than one time.
This identifier is required only if you make a service request directly using an HTTP
client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.
- `member_id`: The unique identifier of the member that is creating the proposal. This
identifier is especially useful for identifying the member making the proposal when
multiple members exist in a single Amazon Web Services account.
- `network_id`: The unique identifier of the network for which the proposal is made.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the proposal that is visible to voting members, for
example, \"Proposal to add Example Corp. as member.\"
- `"Tags"`: Tags to assign to the proposal. Each tag consists of a key and an optional
value. You can specify multiple key-value pairs in a single request with an overall maximum
of 50 tags allowed per resource. For more information about tags, see Tagging Resources in
the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon
Managed Blockchain Hyperledger Fabric Developer Guide.
"""
function create_proposal(
Actions,
ClientRequestToken,
MemberId,
networkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/proposals",
Dict{String,Any}(
"Actions" => Actions,
"ClientRequestToken" => ClientRequestToken,
"MemberId" => MemberId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_proposal(
Actions,
ClientRequestToken,
MemberId,
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/proposals",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Actions" => Actions,
"ClientRequestToken" => ClientRequestToken,
"MemberId" => MemberId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_accessor(accessor_id)
delete_accessor(accessor_id, params::Dict{String,<:Any})
Deletes an accessor that your Amazon Web Services account owns. An accessor object is a
container that has the information required for token based access to your Ethereum nodes
including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor
changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state
can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections
that were initiated while the accessor was in the AVAILABLE state remain open until they
expire (up to 2 hours).
# Arguments
- `accessor_id`: The unique identifier of the accessor.
"""
function delete_accessor(AccessorId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"DELETE",
"/accessors/$(AccessorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_accessor(
AccessorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"DELETE",
"/accessors/$(AccessorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_member(member_id, network_id)
delete_member(member_id, network_id, params::Dict{String,<:Any})
Deletes a member. Deleting a member removes the member and all associated resources from
the network. DeleteMember can only be called for a specified MemberId if the principal
performing the action is associated with the Amazon Web Services account that owns the
member. In all other cases, the DeleteMember action is carried out as the result of an
approved proposal to remove a member. If MemberId is the last member in a network specified
by the last Amazon Web Services account, the network is deleted also. Applies only to
Hyperledger Fabric.
# Arguments
- `member_id`: The unique identifier of the member to remove.
- `network_id`: The unique identifier of the network from which the member is removed.
"""
function delete_member(
memberId, networkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"DELETE",
"/networks/$(networkId)/members/$(memberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_member(
memberId,
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"DELETE",
"/networks/$(networkId)/members/$(memberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_node(network_id, node_id)
delete_node(network_id, node_id, params::Dict{String,<:Any})
Deletes a node that your Amazon Web Services account owns. All data on the node is lost and
cannot be recovered. Applies to Hyperledger Fabric and Ethereum.
# Arguments
- `network_id`: The unique identifier of the network that the node is on. Ethereum public
networks have the following NetworkIds: n-ethereum-mainnet
- `node_id`: The unique identifier of the node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"memberId"`: The unique identifier of the member that owns this node. Applies only to
Hyperledger Fabric and is required for Hyperledger Fabric.
"""
function delete_node(networkId, nodeId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"DELETE",
"/networks/$(networkId)/nodes/$(nodeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_node(
networkId,
nodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"DELETE",
"/networks/$(networkId)/nodes/$(nodeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_accessor(accessor_id)
get_accessor(accessor_id, params::Dict{String,<:Any})
Returns detailed information about an accessor. An accessor object is a container that has
the information required for token based access to your Ethereum nodes.
# Arguments
- `accessor_id`: The unique identifier of the accessor.
"""
function get_accessor(AccessorId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/accessors/$(AccessorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_accessor(
AccessorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/accessors/$(AccessorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_member(member_id, network_id)
get_member(member_id, network_id, params::Dict{String,<:Any})
Returns detailed information about a member. Applies only to Hyperledger Fabric.
# Arguments
- `member_id`: The unique identifier of the member.
- `network_id`: The unique identifier of the network to which the member belongs.
"""
function get_member(memberId, networkId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/networks/$(networkId)/members/$(memberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_member(
memberId,
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/members/$(memberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network(network_id)
get_network(network_id, params::Dict{String,<:Any})
Returns detailed information about a network. Applies to Hyperledger Fabric and Ethereum.
# Arguments
- `network_id`: The unique identifier of the network to get information about.
"""
function get_network(networkId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/networks/$(networkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network(
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_node(network_id, node_id)
get_node(network_id, node_id, params::Dict{String,<:Any})
Returns detailed information about a node. Applies to Hyperledger Fabric and Ethereum.
# Arguments
- `network_id`: The unique identifier of the network that the node is on.
- `node_id`: The unique identifier of the node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"memberId"`: The unique identifier of the member that owns the node. Applies only to
Hyperledger Fabric and is required for Hyperledger Fabric.
"""
function get_node(networkId, nodeId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/networks/$(networkId)/nodes/$(nodeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_node(
networkId,
nodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/nodes/$(nodeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_proposal(network_id, proposal_id)
get_proposal(network_id, proposal_id, params::Dict{String,<:Any})
Returns detailed information about a proposal. Applies only to Hyperledger Fabric.
# Arguments
- `network_id`: The unique identifier of the network for which the proposal is made.
- `proposal_id`: The unique identifier of the proposal.
"""
function get_proposal(
networkId, proposalId; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"GET",
"/networks/$(networkId)/proposals/$(proposalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_proposal(
networkId,
proposalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/proposals/$(proposalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_accessors()
list_accessors(params::Dict{String,<:Any})
Returns a list of the accessors and their properties. Accessor objects are containers that
have the information required for token based access to your Ethereum nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of accessors to list.
- `"networkType"`: The blockchain network that the Accessor token is created for. Use the
value ETHEREUM_MAINNET_AND_GOERLI for all existing Accessors tokens that were created
before the networkType property was introduced.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_accessors(; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET", "/accessors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_accessors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"GET", "/accessors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_invitations()
list_invitations(params::Dict{String,<:Any})
Returns a list of all invitations for the current Amazon Web Services account. Applies only
to Hyperledger Fabric.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of invitations to return.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET", "/invitations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"GET",
"/invitations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_members(network_id)
list_members(network_id, params::Dict{String,<:Any})
Returns a list of the members in a network and properties of their configurations. Applies
only to Hyperledger Fabric.
# Arguments
- `network_id`: The unique identifier of the network for which to list members.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isOwned"`: An optional Boolean value. If provided, the request is limited either to
members that the current Amazon Web Services account owns (true) or that other Amazon Web
Services accountsn own (false). If omitted, all members are listed.
- `"maxResults"`: The maximum number of members to return in the request.
- `"name"`: The optional name of the member to list.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"status"`: An optional status specifier. If provided, only members currently in this
status are listed.
"""
function list_members(networkId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/networks/$(networkId)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_members(
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_networks()
list_networks(params::Dict{String,<:Any})
Returns information about the networks in which the current Amazon Web Services account
participates. Applies to Hyperledger Fabric and Ethereum.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"framework"`: An optional framework specifier. If provided, only networks of this
framework type are listed.
- `"maxResults"`: The maximum number of networks to list.
- `"name"`: The name of the network.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"status"`: An optional status specifier. If provided, only networks currently in this
status are listed. Applies only to Hyperledger Fabric.
"""
function list_networks(; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET", "/networks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_networks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"GET", "/networks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_nodes(network_id)
list_nodes(network_id, params::Dict{String,<:Any})
Returns information about the nodes within a network. Applies to Hyperledger Fabric and
Ethereum.
# Arguments
- `network_id`: The unique identifier of the network for which to list nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of nodes to list.
- `"memberId"`: The unique identifier of the member who owns the nodes to list. Applies
only to Hyperledger Fabric and is required for Hyperledger Fabric.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"status"`: An optional status specifier. If provided, only nodes currently in this
status are listed.
"""
function list_nodes(networkId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/networks/$(networkId)/nodes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_nodes(
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/nodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_proposal_votes(network_id, proposal_id)
list_proposal_votes(network_id, proposal_id, params::Dict{String,<:Any})
Returns the list of votes for a specified proposal, including the value of each vote and
the unique identifier of the member that cast the vote. Applies only to Hyperledger Fabric.
# Arguments
- `network_id`: The unique identifier of the network.
- `proposal_id`: The unique identifier of the proposal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of votes to return.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_proposal_votes(
networkId, proposalId; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"GET",
"/networks/$(networkId)/proposals/$(proposalId)/votes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_proposal_votes(
networkId,
proposalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/proposals/$(proposalId)/votes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_proposals(network_id)
list_proposals(network_id, params::Dict{String,<:Any})
Returns a list of proposals for the network. Applies only to Hyperledger Fabric.
# Arguments
- `network_id`: The unique identifier of the network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of proposals to return.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_proposals(networkId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"GET",
"/networks/$(networkId)/proposals";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_proposals(
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/networks/$(networkId)/proposals",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of tags for the specified resource. Each tag consists of a key and optional
value. For more information about tags, see Tagging Resources in the Amazon Managed
Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain
Hyperledger Fabric Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For more information
about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_invitation(invitation_id)
reject_invitation(invitation_id, params::Dict{String,<:Any})
Rejects an invitation to join a network. This action can be called by a principal in an
Amazon Web Services account that has received an invitation to create a member and join a
network. Applies only to Hyperledger Fabric.
# Arguments
- `invitation_id`: The unique identifier of the invitation to reject.
"""
function reject_invitation(invitationId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"DELETE",
"/invitations/$(invitationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_invitation(
invitationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"DELETE",
"/invitations/$(invitationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})
Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource.
Each tag consists of a key and optional value. When you specify a tag key that already
exists, the tag value is overwritten with the new value. Use UntagResource to remove tag
keys. A resource can have up to 50 tags. If you try to create more than 50 tags for a
resource, your request fails and returns an error. For more information about tags, see
Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging
Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
# Arguments
- `tags`: The tags to assign to the specified resource. Tag values can be empty, for
example, \"MyTagKey\" : \"\". You can specify multiple key-value pairs in a single request,
with an overall maximum of 50 tags added to each resource.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For more information
about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Tags,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the Amazon Managed Blockchain resource. For more
information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum
Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric
Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For more information
about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
- `tag_keys`: The tag keys.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_member(member_id, network_id)
update_member(member_id, network_id, params::Dict{String,<:Any})
Updates a member configuration with new parameters. Applies only to Hyperledger Fabric.
# Arguments
- `member_id`: The unique identifier of the member.
- `network_id`: The unique identifier of the Managed Blockchain network to which the member
belongs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LogPublishingConfiguration"`: Configuration properties for publishing to Amazon
CloudWatch Logs.
"""
function update_member(
memberId, networkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain(
"PATCH",
"/networks/$(networkId)/members/$(memberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_member(
memberId,
networkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"PATCH",
"/networks/$(networkId)/members/$(memberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_node(network_id, node_id)
update_node(network_id, node_id, params::Dict{String,<:Any})
Updates a node configuration with new parameters. Applies only to Hyperledger Fabric.
# Arguments
- `network_id`: The unique identifier of the network that the node is on.
- `node_id`: The unique identifier of the node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LogPublishingConfiguration"`: Configuration properties for publishing to Amazon
CloudWatch Logs.
- `"MemberId"`: The unique identifier of the member that owns the node. Applies only to
Hyperledger Fabric.
"""
function update_node(networkId, nodeId; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain(
"PATCH",
"/networks/$(networkId)/nodes/$(nodeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_node(
networkId,
nodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"PATCH",
"/networks/$(networkId)/nodes/$(nodeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
vote_on_proposal(vote, voter_member_id, network_id, proposal_id)
vote_on_proposal(vote, voter_member_id, network_id, proposal_id, params::Dict{String,<:Any})
Casts a vote for a specified ProposalId on behalf of a member. The member to vote as,
specified by VoterMemberId, must be in the same Amazon Web Services account as the
principal that calls the action. Applies only to Hyperledger Fabric.
# Arguments
- `vote`: The value of the vote.
- `voter_member_id`: The unique identifier of the member casting the vote.
- `network_id`: The unique identifier of the network.
- `proposal_id`: The unique identifier of the proposal.
"""
function vote_on_proposal(
Vote,
VoterMemberId,
networkId,
proposalId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/proposals/$(proposalId)/votes",
Dict{String,Any}("Vote" => Vote, "VoterMemberId" => VoterMemberId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function vote_on_proposal(
Vote,
VoterMemberId,
networkId,
proposalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain(
"POST",
"/networks/$(networkId)/proposals/$(proposalId)/votes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Vote" => Vote, "VoterMemberId" => VoterMemberId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 16545 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: managedblockchain_query
using AWS.Compat
using AWS.UUIDs
"""
batch_get_token_balance()
batch_get_token_balance(params::Dict{String,<:Any})
Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for
every token in the request. Only the native tokens BTC and ETH, and the ERC-20, ERC-721,
and ERC 1155 token standards are supported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"getTokenBalanceInputs"`: An array of BatchGetTokenBalanceInputItem objects whose
balance is being requested.
"""
function batch_get_token_balance(; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain_query(
"POST",
"/batch-get-token-balance";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_token_balance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/batch-get-token-balance",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset_contract(contract_identifier)
get_asset_contract(contract_identifier, params::Dict{String,<:Any})
Gets the information about a specific contract deployed on the blockchain. The Bitcoin
blockchain networks do not support this operation. Metadata is currently only available
for some ERC-20 contracts. Metadata will be available for additional contracts in the
future.
# Arguments
- `contract_identifier`: Contains the blockchain address and network information about the
contract.
"""
function get_asset_contract(
contractIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/get-asset-contract",
Dict{String,Any}("contractIdentifier" => contractIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_asset_contract(
contractIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain_query(
"POST",
"/get-asset-contract",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("contractIdentifier" => contractIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_token_balance(owner_identifier, token_identifier)
get_token_balance(owner_identifier, token_identifier, params::Dict{String,<:Any})
Gets the balance of a specific token, including native tokens, for a given address (wallet
or contract) on the blockchain. Only the native tokens BTC and ETH, and the ERC-20,
ERC-721, and ERC 1155 token standards are supported.
# Arguments
- `owner_identifier`: The container for the identifier for the owner.
- `token_identifier`: The container for the identifier for the token, including the unique
token ID and its blockchain network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"atBlockchainInstant"`: The time for when the TokenBalance is requested or the current
time if a time is not provided in the request. This time will only be recorded up to the
second.
"""
function get_token_balance(
ownerIdentifier, tokenIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/get-token-balance",
Dict{String,Any}(
"ownerIdentifier" => ownerIdentifier, "tokenIdentifier" => tokenIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_token_balance(
ownerIdentifier,
tokenIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain_query(
"POST",
"/get-token-balance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ownerIdentifier" => ownerIdentifier,
"tokenIdentifier" => tokenIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transaction(network)
get_transaction(network, params::Dict{String,<:Any})
Gets the details of a transaction. This action will return transaction details for all
transactions that are confirmed on the blockchain, even if they have not reached finality.
# Arguments
- `network`: The blockchain network where the transaction occurred.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"transactionHash"`: The hash of a transaction. It is generated when a transaction is
created.
- `"transactionId"`: The identifier of a Bitcoin transaction. It is generated when a
transaction is created. transactionId is only supported on the Bitcoin networks.
"""
function get_transaction(network; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain_query(
"POST",
"/get-transaction",
Dict{String,Any}("network" => network);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transaction(
network, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/get-transaction",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("network" => network), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_contracts(contract_filter)
list_asset_contracts(contract_filter, params::Dict{String,<:Any})
Lists all the contracts for a given contract type deployed by an address (either a contract
address or a wallet address). The Bitcoin blockchain networks do not support this operation.
# Arguments
- `contract_filter`: Contains the filter parameter for the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of contracts to list. Default: 100 Even if
additional results can be retrieved, the request can return less results than maxResults or
an empty array of results. To retrieve the next set of results, make another request with
the returned nextToken value. The value of nextToken is null when there are no more results
to return
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_asset_contracts(
contractFilter; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/list-asset-contracts",
Dict{String,Any}("contractFilter" => contractFilter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_contracts(
contractFilter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain_query(
"POST",
"/list-asset-contracts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("contractFilter" => contractFilter), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_filtered_transaction_events(address_identifier_filter, network)
list_filtered_transaction_events(address_identifier_filter, network, params::Dict{String,<:Any})
Lists all the transaction events for an address on the blockchain. This operation is only
supported on the Bitcoin networks.
# Arguments
- `address_identifier_filter`: This is the unique public address on the blockchain for
which the transaction events are being requested.
- `network`: The blockchain network where the transaction occurred. Valid Values:
BITCOIN_MAINNET | BITCOIN_TESTNET
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"confirmationStatusFilter"`:
- `"maxResults"`: The maximum number of transaction events to list. Default: 100 Even if
additional results can be retrieved, the request can return less results than maxResults or
an empty array of results. To retrieve the next set of results, make another request with
the returned nextToken value. The value of nextToken is null when there are no more results
to return
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"sort"`: The order by which the results will be sorted.
- `"timeFilter"`: This container specifies the time frame for the transaction events
returned in the response.
- `"voutFilter"`: This container specifies filtering attributes related to BITCOIN_VOUT
event types
"""
function list_filtered_transaction_events(
addressIdentifierFilter, network; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/list-filtered-transaction-events",
Dict{String,Any}(
"addressIdentifierFilter" => addressIdentifierFilter, "network" => network
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_filtered_transaction_events(
addressIdentifierFilter,
network,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain_query(
"POST",
"/list-filtered-transaction-events",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"addressIdentifierFilter" => addressIdentifierFilter,
"network" => network,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_token_balances(token_filter)
list_token_balances(token_filter, params::Dict{String,<:Any})
This action returns the following for a given blockchain network: Lists all token
balances owned by an address (either a contract address or a wallet address). Lists all
token balances for all tokens created by a contract. Lists all token balances for a given
token. You must always specify the network property of the tokenFilter when using this
operation.
# Arguments
- `token_filter`: The contract address or a token identifier on the blockchain network by
which to filter the request. You must specify the contractAddress property of this
container when listing tokens minted by a contract. You must always specify the network
property of this container when using this operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of token balances to return. Default: 100 Even if
additional results can be retrieved, the request can return less results than maxResults or
an empty array of results. To retrieve the next set of results, make another request with
the returned nextToken value. The value of nextToken is null when there are no more results
to return
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"ownerFilter"`: The contract or wallet address on the blockchain network by which to
filter the request. You must specify the address property of the ownerFilter when listing
balances of tokens owned by the address.
"""
function list_token_balances(tokenFilter; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain_query(
"POST",
"/list-token-balances",
Dict{String,Any}("tokenFilter" => tokenFilter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_token_balances(
tokenFilter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain_query(
"POST",
"/list-token-balances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("tokenFilter" => tokenFilter), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_transaction_events(network)
list_transaction_events(network, params::Dict{String,<:Any})
Lists all the transaction events for a transaction This action will return transaction
details for all transactions that are confirmed on the blockchain, even if they have not
reached finality.
# Arguments
- `network`: The blockchain network where the transaction events occurred.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of transaction events to list. Default: 100 Even if
additional results can be retrieved, the request can return less results than maxResults or
an empty array of results. To retrieve the next set of results, make another request with
the returned nextToken value. The value of nextToken is null when there are no more results
to return
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"transactionHash"`: The hash of a transaction. It is generated when a transaction is
created.
- `"transactionId"`: The identifier of a Bitcoin transaction. It is generated when a
transaction is created. transactionId is only supported on the Bitcoin networks.
"""
function list_transaction_events(network; aws_config::AbstractAWSConfig=global_aws_config())
return managedblockchain_query(
"POST",
"/list-transaction-events",
Dict{String,Any}("network" => network);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_transaction_events(
network, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/list-transaction-events",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("network" => network), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_transactions(address, network)
list_transactions(address, network, params::Dict{String,<:Any})
Lists all the transaction events for a transaction.
# Arguments
- `address`: The address (either a contract or wallet), whose transactions are being
requested.
- `network`: The blockchain network where the transactions occurred.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"confirmationStatusFilter"`: This filter is used to include transactions in the response
that haven't reached finality . Transactions that have reached finality are always part of
the response.
- `"fromBlockchainInstant"`:
- `"maxResults"`: The maximum number of transactions to list. Default: 100 Even if
additional results can be retrieved, the request can return less results than maxResults or
an empty array of results. To retrieve the next set of results, make another request with
the returned nextToken value. The value of nextToken is null when there are no more results
to return
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
- `"sort"`: The order by which the results will be sorted.
- `"toBlockchainInstant"`:
"""
function list_transactions(
address, network; aws_config::AbstractAWSConfig=global_aws_config()
)
return managedblockchain_query(
"POST",
"/list-transactions",
Dict{String,Any}("address" => address, "network" => network);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_transactions(
address,
network,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return managedblockchain_query(
"POST",
"/list-transactions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("address" => address, "network" => network), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 6218 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: marketplace_agreement
using AWS.Compat
using AWS.UUIDs
"""
describe_agreement(agreement_id)
describe_agreement(agreement_id, params::Dict{String,<:Any})
Provides details about an agreement, such as the proposer, acceptor, start date, and end
date.
# Arguments
- `agreement_id`: The unique identifier of the agreement.
"""
function describe_agreement(agreementId; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_agreement(
"DescribeAgreement",
Dict{String,Any}("agreementId" => agreementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_agreement(
agreementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_agreement(
"DescribeAgreement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("agreementId" => agreementId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_agreement_terms(agreement_id)
get_agreement_terms(agreement_id, params::Dict{String,<:Any})
Obtains details about the terms in an agreement that you participated in as proposer or
acceptor. The details include: TermType – The type of term, such as LegalTerm,
RenewalTerm, or ConfigurableUpfrontPricingTerm. TermID – The ID of the particular
term, which is common between offer and agreement. TermPayload – The key information
contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various
pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.
Configuration – The buyer/acceptor's selection at the time of agreement creation, such as
the number of units purchased for a dimension or setting the EnableAutoRenew flag.
# Arguments
- `agreement_id`: The unique identifier of the agreement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of agreements to return in the response.
- `"nextToken"`: A token to specify where to start pagination
"""
function get_agreement_terms(agreementId; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_agreement(
"GetAgreementTerms",
Dict{String,Any}("agreementId" => agreementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_agreement_terms(
agreementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_agreement(
"GetAgreementTerms",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("agreementId" => agreementId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_agreements()
search_agreements(params::Dict{String,<:Any})
Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The
search returns a list of agreements with basic agreement information. The following filter
combinations are supported: PartyType as Proposer + AgreementType + ResourceIdentifier
PartyType as Proposer + AgreementType + OfferId PartyType as Proposer + AgreementType
+ AcceptorAccountId PartyType as Proposer + AgreementType + Status PartyType as
Proposer + AgreementType + ResourceIdentifier + Status PartyType as Proposer +
AgreementType + OfferId + Status PartyType as Proposer + AgreementType +
AcceptorAccountId + Status PartyType as Proposer + AgreementType + ResourceType +
Status PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType +
Status PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId
PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId + Status PartyType
as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier PartyType as
Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier + Status PartyType as
Proposer + AgreementType + AcceptorAccountId + ResourceType
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"catalog"`: The catalog in which the agreement was created.
- `"filters"`: The filter name and value pair used to return a specific list of results.
The following filters are supported: ResourceIdentifier – The unique identifier of the
resource. ResourceType – Type of the resource, which is the product (AmiProduct,
ContainerProduct, or SaaSProduct). PartyType – The party type (either Acceptor or
Proposer) of the caller. For agreements where the caller is the proposer, use the Proposer
filter. For agreements where the caller is the acceptor, use the Acceptor filter.
AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.
OfferId – The unique identifier of the offer in which the terms are registered in the
agreement token. Status – The current status of the agreement. Values include ACTIVE,
ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED. BeforeEndTime – A
date used to filter agreements with a date before the endTime of an agreement.
AfterEndTime – A date used to filter agreements with a date after the endTime of an
agreement. AgreementType – The type of agreement. Values include PurchaseAgreement or
VendorInsightsAgreement.
- `"maxResults"`: The maximum number of agreements to return in the response.
- `"nextToken"`: A token to specify where to start pagination.
- `"sort"`: An object that contains the SortBy and SortOrder attributes.
"""
function search_agreements(; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_agreement(
"SearchAgreements"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_agreements(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_agreement(
"SearchAgreements", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 19668 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: marketplace_catalog
using AWS.Compat
using AWS.UUIDs
"""
batch_describe_entities(entity_request_list)
batch_describe_entities(entity_request_list, params::Dict{String,<:Any})
Returns metadata and content for multiple entities. This is the Batch version of the
DescribeEntity API and uses the same IAM permission action as DescribeEntity API.
# Arguments
- `entity_request_list`: List of entity IDs and the catalogs the entities are present in.
"""
function batch_describe_entities(
EntityRequestList; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/BatchDescribeEntities",
Dict{String,Any}("EntityRequestList" => EntityRequestList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_describe_entities(
EntityRequestList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/BatchDescribeEntities",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EntityRequestList" => EntityRequestList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_change_set(catalog, change_set_id)
cancel_change_set(catalog, change_set_id, params::Dict{String,<:Any})
Used to cancel an open change request. Must be sent before the status of the request
changes to APPLYING, the final stage of completing your change request. You can describe a
change during the 60-day request history retention period for API calls.
# Arguments
- `catalog`: Required. The catalog related to the request. Fixed value: AWSMarketplace.
- `change_set_id`: Required. The unique identifier of the StartChangeSet request that you
want to cancel.
"""
function cancel_change_set(
catalog, changeSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"PATCH",
"/CancelChangeSet",
Dict{String,Any}("catalog" => catalog, "changeSetId" => changeSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_change_set(
catalog,
changeSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"PATCH",
"/CancelChangeSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("catalog" => catalog, "changeSetId" => changeSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Deletes a resource-based policy on an entity that is identified by its resource ARN.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the entity resource that is associated
with the resource policy.
"""
function delete_resource_policy(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"DELETE",
"/DeleteResourcePolicy",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"DELETE",
"/DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_change_set(catalog, change_set_id)
describe_change_set(catalog, change_set_id, params::Dict{String,<:Any})
Provides information about a given change set.
# Arguments
- `catalog`: Required. The catalog related to the request. Fixed value: AWSMarketplace
- `change_set_id`: Required. The unique identifier for the StartChangeSet request that you
want to describe the details for.
"""
function describe_change_set(
catalog, changeSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"GET",
"/DescribeChangeSet",
Dict{String,Any}("catalog" => catalog, "changeSetId" => changeSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_change_set(
catalog,
changeSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"GET",
"/DescribeChangeSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("catalog" => catalog, "changeSetId" => changeSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_entity(catalog, entity_id)
describe_entity(catalog, entity_id, params::Dict{String,<:Any})
Returns the metadata and content of the entity.
# Arguments
- `catalog`: Required. The catalog related to the request. Fixed value: AWSMarketplace
- `entity_id`: Required. The unique ID of the entity to describe.
"""
function describe_entity(
catalog, entityId; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"GET",
"/DescribeEntity",
Dict{String,Any}("catalog" => catalog, "entityId" => entityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_entity(
catalog,
entityId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"GET",
"/DescribeEntity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("catalog" => catalog, "entityId" => entityId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})
Gets a resource-based policy of an entity that is identified by its resource ARN.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the entity resource that is associated
with the resource policy.
"""
function get_resource_policy(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_catalog(
"GET",
"/GetResourcePolicy",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policy(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"GET",
"/GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_change_sets(catalog)
list_change_sets(catalog, params::Dict{String,<:Any})
Returns the list of change sets owned by the account being used to make the call. You can
filter this list by providing any combination of entityId, ChangeSetName, and status. If
you provide more than one filter, the API operation applies a logical AND between the
filters. You can describe a change during the 60-day request history retention period for
API calls.
# Arguments
- `catalog`: The catalog related to the request. Fixed value: AWSMarketplace
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterList"`: An array of filter objects.
- `"MaxResults"`: The maximum number of results returned by a single call. This value must
be provided in the next call to retrieve the next set of results. By default, this value is
20.
- `"NextToken"`: The token value retrieved from a previous call to access the next page of
results.
- `"Sort"`: An object that contains two attributes, SortBy and SortOrder.
"""
function list_change_sets(Catalog; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_catalog(
"POST",
"/ListChangeSets",
Dict{String,Any}("Catalog" => Catalog);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_change_sets(
Catalog, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/ListChangeSets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Catalog" => Catalog), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entities(catalog, entity_type)
list_entities(catalog, entity_type, params::Dict{String,<:Any})
Provides the list of entities of a given type.
# Arguments
- `catalog`: The catalog related to the request. Fixed value: AWSMarketplace
- `entity_type`: The type of entities to retrieve. Valid values are: AmiProduct,
ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience,
BrandingSettings, Offer, Seller, ResaleAuthorization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EntityTypeFilters"`: A Union object containing filter shapes for all EntityTypes. Each
EntityTypeFilter shape will have filters applicable for that EntityType that can be used to
search or filter entities.
- `"EntityTypeSort"`: A Union object containing Sort shapes for all EntityTypes. Each
EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that
EntityType. This can be used to sort the results of the filter query.
- `"FilterList"`: An array of filter objects. Each filter object contains two attributes,
filterName and filterValues.
- `"MaxResults"`: Specifies the upper limit of the elements on a single page. If a value
isn't provided, the default value is 20.
- `"NextToken"`: The value of the next token, if it exists. Null if there are no more
results.
- `"OwnershipType"`: Filters the returned set of entities based on their owner. The default
is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM),
set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy
operation can't be discovered through the SHARED parameter.
- `"Sort"`: An object that contains two attributes, SortBy and SortOrder.
"""
function list_entities(
Catalog, EntityType; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/ListEntities",
Dict{String,Any}("Catalog" => Catalog, "EntityType" => EntityType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_entities(
Catalog,
EntityType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/ListEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Catalog" => Catalog, "EntityType" => EntityType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags that have been added to a resource (either an entity or change set).
# Arguments
- `resource_arn`: Required. The Amazon Resource Name (ARN) associated with the resource you
want to list tags on.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct
and ContainerProduct.
# Arguments
- `policy`: The policy document to set; formatted in JSON.
- `resource_arn`: The Amazon Resource Name (ARN) of the entity resource you want to
associate with a resource policy.
"""
function put_resource_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/PutResourcePolicy",
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
Policy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_change_set(catalog, change_set)
start_change_set(catalog, change_set, params::Dict{String,<:Any})
Allows you to request changes for your entities. Within a single ChangeSet, you can't start
the same change type against the same entity multiple times. Additionally, when a ChangeSet
is running, all the entities targeted by the different changes are locked until the change
set has completed (either succeeded, cancelled, or failed). If you try to start a change
set containing a change against an entity that is already locked, you will receive a
ResourceInUseException error. For example, you can't start the ChangeSet described in the
example later in this topic because it contains two changes to run the same change type
(AddRevisions) against the same entity (entity-id@1). For more information about working
with change sets, see Working with change sets. For information about change types for
single-AMI products, see Working with single-AMI products. Also, for more information about
change types available for container-based products, see Working with container products.
# Arguments
- `catalog`: The catalog related to the request. Fixed value: AWSMarketplace
- `change_set`: Array of change object.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChangeSetName"`: Optional case sensitive string of up to 100 ASCII characters. The
change set name can be used to filter the list of change sets.
- `"ChangeSetTags"`: A list of objects specifying each key name and value for the
ChangeSetTags property.
- `"ClientRequestToken"`: A unique token to identify the request to ensure idempotency.
- `"Intent"`: The intent related to the request. The default is APPLY. To test your request
before applying changes to your entities, use VALIDATE. This feature is currently available
for adding versions to single-AMI products. For more information, see Add a new version.
"""
function start_change_set(
Catalog, ChangeSet; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/StartChangeSet",
Dict{String,Any}(
"Catalog" => Catalog,
"ChangeSet" => ChangeSet,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_change_set(
Catalog,
ChangeSet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/StartChangeSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Catalog" => Catalog,
"ChangeSet" => ChangeSet,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Tags a resource (either an entity or change set).
# Arguments
- `resource_arn`: Required. The Amazon Resource Name (ARN) associated with the resource you
want to tag.
- `tags`: Required. A list of objects specifying each key name and value. Number of objects
allowed: 1-50.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_catalog(
"POST",
"/TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag or list of tags from a resource (either an entity or change set).
# Arguments
- `resource_arn`: Required. The Amazon Resource Name (ARN) associated with the resource you
want to remove the tag from.
- `tag_keys`: Required. A list of key names of tags to be removed. Number of strings
allowed: 0-256.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_catalog(
"POST",
"/UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_catalog(
"POST",
"/UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 12580 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: marketplace_commerce_analytics
using AWS.Compat
using AWS.UUIDs
"""
generate_data_set(data_set_publication_date, data_set_type, destination_s3_bucket_name, role_name_arn, sns_topic_arn)
generate_data_set(data_set_publication_date, data_set_type, destination_s3_bucket_name, role_name_arn, sns_topic_arn, params::Dict{String,<:Any})
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. Returns a unique request identifier that can be used to correlate requests with
notifications from the SNS topic. Data sets will be published in comma-separated values
(CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same
name already exists (e.g. if the same data set is requested twice), the original file will
be overwritten by the new file. Requires a Role with an attached permissions policy
providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation,
sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
# Arguments
- `data_set_publication_date`: The date a data set was published. For daily data sets,
provide a date with day-level granularity for the desired day. For monthly data sets except
those with prefix disbursed_amount, provide a date with month-level granularity for the
desired month (the day value will be ignored). For data sets with prefix disbursed_amount,
provide a date with day-level granularity for the desired day. For these data sets we will
look backwards in time over the range of 31 days until the first data set is found (the
latest one).
- `data_set_type`: The desired data set type.
customer_subscriber_hourly_monthly_subscriptions From 2017-09-15 to present: Available
daily by 24:00 UTC. customer_subscriber_annual_subscriptions From 2017-09-15 to present:
Available daily by 24:00 UTC. daily_business_usage_by_instance_type From 2017-09-15 to
present: Available daily by 24:00 UTC. daily_business_fees From 2017-09-15 to present:
Available daily by 24:00 UTC. daily_business_free_trial_conversions From 2017-09-15 to
present: Available daily by 24:00 UTC. daily_business_new_instances From 2017-09-15 to
present: Available daily by 24:00 UTC. daily_business_new_product_subscribers From
2017-09-15 to present: Available daily by 24:00 UTC.
daily_business_canceled_product_subscribers From 2017-09-15 to present: Available daily by
24:00 UTC. monthly_revenue_billing_and_revenue_data From 2017-09-15 to present: Available
monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g.
hourly) from one month prior. monthly_revenue_annual_subscriptions From 2017-09-15 to
present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes
up-front software charges (e.g. annual) from one month prior.
monthly_revenue_field_demonstration_usage From 2018-03-15 to present: Available monthly on
the 15th day of the month by 24:00 UTC. monthly_revenue_flexible_payment_schedule From
2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
disbursed_amount_by_product From 2017-09-15 to present: Available every 30 days by 24:00
UTC. disbursed_amount_by_instance_hours From 2017-09-15 to present: Available every 30
days by 24:00 UTC. disbursed_amount_by_customer_geo From 2017-09-15 to present: Available
every 30 days by 24:00 UTC. disbursed_amount_by_age_of_uncollected_funds From 2017-09-15
to present: Available every 30 days by 24:00 UTC.
disbursed_amount_by_age_of_disbursed_funds From 2017-09-15 to present: Available every 30
days by 24:00 UTC. disbursed_amount_by_age_of_past_due_funds From 2018-04-07 to present:
Available every 30 days by 24:00 UTC. disbursed_amount_by_uncollected_funds_breakdown
From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
sales_compensation_billed_revenue From 2017-09-15 to present: Available monthly on the 15th
day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one
month prior, and up-front software charges (e.g. annual) from one month prior.
us_sales_and_use_tax_records From 2017-09-15 to present: Available monthly on the 15th day
of the month by 24:00 UTC. disbursed_amount_by_product_with_uncollected_funds This data
set is deprecated. Download related reports from AMMP instead!
customer_profile_by_industry This data set is deprecated. Download related reports from
AMMP instead! customer_profile_by_revenue This data set is deprecated. Download related
reports from AMMP instead! customer_profile_by_geography This data set is deprecated.
Download related reports from AMMP instead!
- `destination_s3_bucket_name`: The name (friendly name, not ARN) of the destination S3
bucket.
- `role_name_arn`: The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
- `sns_topic_arn`: Amazon Resource Name (ARN) for the SNS Topic that will be notified when
the data set has been published or if an error has occurred.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"customerDefinedValues"`: (Optional) Key-value pairs which will be returned, unmodified,
in the Amazon SNS notification message and the data set metadata file. These key-value
pairs can be used to correlated responses with tracking information from other systems.
- `"destinationS3Prefix"`: (Optional) The desired S3 prefix for the published data set,
similar to a directory path in standard file systems. For example, if given the bucket name
\"mybucket\" and the prefix \"myprefix/mydatasets\", the output file \"outputfile\" would
be published to \"s3://mybucket/myprefix/mydatasets/outputfile\". If the prefix directory
structure does not exist, it will be created. If no prefix is provided, the data set will
be published to the S3 bucket root.
"""
function generate_data_set(
dataSetPublicationDate,
dataSetType,
destinationS3BucketName,
roleNameArn,
snsTopicArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_commerce_analytics(
"GenerateDataSet",
Dict{String,Any}(
"dataSetPublicationDate" => dataSetPublicationDate,
"dataSetType" => dataSetType,
"destinationS3BucketName" => destinationS3BucketName,
"roleNameArn" => roleNameArn,
"snsTopicArn" => snsTopicArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_data_set(
dataSetPublicationDate,
dataSetType,
destinationS3BucketName,
roleNameArn,
snsTopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_commerce_analytics(
"GenerateDataSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataSetPublicationDate" => dataSetPublicationDate,
"dataSetType" => dataSetType,
"destinationS3BucketName" => destinationS3BucketName,
"roleNameArn" => roleNameArn,
"snsTopicArn" => snsTopicArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_support_data_export(data_set_type, destination_s3_bucket_name, from_date, role_name_arn, sns_topic_arn)
start_support_data_export(data_set_type, destination_s3_bucket_name, from_date, role_name_arn, sns_topic_arn, params::Dict{String,<:Any})
This target has been deprecated. Given a data set type and a from date, asynchronously
publishes the requested customer support data to the specified S3 bucket and notifies the
specified SNS topic once the data is available. Returns a unique request identifier that
can be used to correlate requests with notifications from the SNS topic. Data sets will be
published in comma-separated values (CSV) format with the file name
{data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists
(e.g. if the same data set is requested twice), the original file will be overwritten by
the new file. Requires a Role with an attached permissions policy providing Allow
permissions for the following actions: s3:PutObject, s3:GetBucketLocation,
sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
# Arguments
- `data_set_type`: This target has been deprecated. Specifies the data set type to be
written to the output csv file. The data set types customer_support_contacts_data and
test_customer_support_contacts_data both result in a csv file containing the following
fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start
Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title,
Country Code, ZIP Code, Operation Type, and Operation Time.
customer_support_contacts_data Customer support contact data. The data set will contain all
changes (Creates, Updates, and Deletes) to customer support contact data from the date
specified in the from_date parameter. test_customer_support_contacts_data An example data
set containing static test data in the same format as customer_support_contacts_data
- `destination_s3_bucket_name`: This target has been deprecated. The name (friendly name,
not ARN) of the destination S3 bucket.
- `from_date`: This target has been deprecated. The start date from which to retrieve the
data set in UTC. This parameter only affects the customer_support_contacts_data data set
type.
- `role_name_arn`: This target has been deprecated. The Amazon Resource Name (ARN) of the
Role with an attached permissions policy to interact with the provided AWS services.
- `sns_topic_arn`: This target has been deprecated. Amazon Resource Name (ARN) for the SNS
Topic that will be notified when the data set has been published or if an error has
occurred.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"customerDefinedValues"`: This target has been deprecated. (Optional) Key-value pairs
which will be returned, unmodified, in the Amazon SNS notification message and the data set
metadata file.
- `"destinationS3Prefix"`: This target has been deprecated. (Optional) The desired S3
prefix for the published data set, similar to a directory path in standard file systems.
For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\",
the output file \"outputfile\" would be published to
\"s3://mybucket/myprefix/mydatasets/outputfile\". If the prefix directory structure does
not exist, it will be created. If no prefix is provided, the data set will be published to
the S3 bucket root.
"""
function start_support_data_export(
dataSetType,
destinationS3BucketName,
fromDate,
roleNameArn,
snsTopicArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_commerce_analytics(
"StartSupportDataExport",
Dict{String,Any}(
"dataSetType" => dataSetType,
"destinationS3BucketName" => destinationS3BucketName,
"fromDate" => fromDate,
"roleNameArn" => roleNameArn,
"snsTopicArn" => snsTopicArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_support_data_export(
dataSetType,
destinationS3BucketName,
fromDate,
roleNameArn,
snsTopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_commerce_analytics(
"StartSupportDataExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataSetType" => dataSetType,
"destinationS3BucketName" => destinationS3BucketName,
"fromDate" => fromDate,
"roleNameArn" => roleNameArn,
"snsTopicArn" => snsTopicArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 5648 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: marketplace_deployment
using AWS.Compat
using AWS.UUIDs
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags that have been added to a deployment parameter resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) associated with the deployment parameter
resource you want to list tags on.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_deployment(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_deployment(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_deployment_parameter(agreement_id, catalog, deployment_parameter, product_id)
put_deployment_parameter(agreement_id, catalog, deployment_parameter, product_id, params::Dict{String,<:Any})
Creates or updates a deployment parameter and is targeted by catalog and agreementId.
# Arguments
- `agreement_id`: The unique identifier of the agreement.
- `catalog`: The catalog related to the request. Fixed value: AWS Marketplace
- `deployment_parameter`: The deployment parameter targeted to the acceptor of an agreement
for which to create the AWS Secret Manager resource.
- `product_id`: The product for which AWS Marketplace will save secrets for the buyer’s
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotency token for deployment parameters. A unique identifier for
the new version.
- `"expirationDate"`: The date when deployment parameters expire and are scheduled for
deletion.
- `"tags"`: A map of key-value pairs, where each pair represents a tag saved to the
resource. Tags will only be applied for create operations, and they'll be ignored if the
resource already exists.
"""
function put_deployment_parameter(
agreementId,
catalog,
deploymentParameter,
productId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_deployment(
"POST",
"/catalogs/$(catalog)/products/$(productId)/deployment-parameters",
Dict{String,Any}(
"agreementId" => agreementId,
"deploymentParameter" => deploymentParameter,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_deployment_parameter(
agreementId,
catalog,
deploymentParameter,
productId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_deployment(
"POST",
"/catalogs/$(catalog)/products/$(productId)/deployment-parameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"agreementId" => agreementId,
"deploymentParameter" => deploymentParameter,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn)
tag_resource(resource_arn, params::Dict{String,<:Any})
Tags a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) associated with the resource you want to
tag.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A map of key-value pairs, where each pair represents a tag present on the
resource.
"""
function tag_resource(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_deployment(
"POST",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_deployment(
"POST",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag or list of tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) associated with the resource you want to
remove the tag from.
- `tag_keys`: A list of key names of tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_deployment(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_deployment(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 1984 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: marketplace_entitlement_service
using AWS.Compat
using AWS.UUIDs
"""
get_entitlements(product_code)
get_entitlements(product_code, params::Dict{String,<:Any})
GetEntitlements retrieves entitlement values for a given product. The results can be
filtered based on customer identifier or product dimensions.
# Arguments
- `product_code`: Product code is used to uniquely identify a product in AWS Marketplace.
The product code will be provided by AWS Marketplace when the product listing is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filter is used to return entitlements for a specific customer or for a
specific dimension. Filters are described as keys mapped to a lists of values. Filtered
requests are unioned for each value in the value list, and then intersected for each filter
key.
- `"MaxResults"`: The maximum number of items to retrieve from the GetEntitlements
operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.
- `"NextToken"`: For paginated calls to GetEntitlements, pass the NextToken from the
previous GetEntitlementsResult.
"""
function get_entitlements(ProductCode; aws_config::AbstractAWSConfig=global_aws_config())
return marketplace_entitlement_service(
"GetEntitlements",
Dict{String,Any}("ProductCode" => ProductCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_entitlements(
ProductCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_entitlement_service(
"GetEntitlements",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProductCode" => ProductCode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 11151 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: marketplace_metering
using AWS.Compat
using AWS.UUIDs
"""
batch_meter_usage(product_code, usage_records)
batch_meter_usage(product_code, usage_records, params::Dict{String,<:Any})
BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post
metering records for a set of customers. For identical requests, the API is idempotent;
requests can be retried with the same records or a subset of the input records. Every
request to BatchMeterUsage is for one product. If you need to meter usage for multiple
products, you must make multiple calls to BatchMeterUsage. Usage records are expected to be
submitted as quickly as possible after the event that is being recorded, and are not
accepted more than 6 hours after the event. BatchMeterUsage can process up to 25
UsageRecords at a time. A UsageRecord can optionally include multiple usage allocations, to
provide customers with usage data split into buckets by tags that you define (or allow the
customer to define). BatchMeterUsage returns a list of UsageRecordResult objects, showing
the result for each UsageRecord, as well as a list of UnprocessedRecords, indicating errors
in the service side that you should retry. BatchMeterUsage requests must be less than 1MB
in size. For an example of using BatchMeterUsage, see BatchMeterUsage code example in the
AWS Marketplace Seller Guide.
# Arguments
- `product_code`: Product code is used to uniquely identify a product in AWS Marketplace.
The product code should be the same as the one used during the publishing of a new product.
- `usage_records`: The set of UsageRecords to submit. BatchMeterUsage accepts up to 25
UsageRecords at a time.
"""
function batch_meter_usage(
ProductCode, UsageRecords; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_metering(
"BatchMeterUsage",
Dict{String,Any}("ProductCode" => ProductCode, "UsageRecords" => UsageRecords);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_meter_usage(
ProductCode,
UsageRecords,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_metering(
"BatchMeterUsage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductCode" => ProductCode, "UsageRecords" => UsageRecords
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
meter_usage(product_code, timestamp, usage_dimension)
meter_usage(product_code, timestamp, usage_dimension, params::Dict{String,<:Any})
API to emit metering records. For identical requests, the API is idempotent. It simply
returns the metering record ID. MeterUsage is authenticated on the buyer's AWS account
using credentials from the EC2 instance, ECS task, or EKS pod. MeterUsage can optionally
include multiple usage allocations, to provide customers with usage data split into buckets
by tags that you define (or allow the customer to define). Usage records are expected to be
submitted as quickly as possible after the event that is being recorded, and are not
accepted more than 6 hours after the event.
# Arguments
- `product_code`: Product code is used to uniquely identify a product in AWS Marketplace.
The product code should be the same as the one used during the publishing of a new product.
- `timestamp`: Timestamp, in UTC, for which the usage is being reported. Your application
can meter usage for up to one hour in the past. Make sure the timestamp value is not before
the start of the software usage.
- `usage_dimension`: It will be one of the fcp dimension name provided during the
publishing of the product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Checks whether you have the permissions required for the action, but does not
make the request. If you have the permissions, the request returns DryRunOperation;
otherwise, it returns UnauthorizedException. Defaults to false if not specified.
- `"UsageAllocations"`: The set of UsageAllocations to submit. The sum of all
UsageAllocation quantities must equal the UsageQuantity of the MeterUsage request, and each
UsageAllocation must have a unique set of tags (include no tags).
- `"UsageQuantity"`: Consumption value for the hour. Defaults to 0 if not specified.
"""
function meter_usage(
ProductCode,
Timestamp,
UsageDimension;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_metering(
"MeterUsage",
Dict{String,Any}(
"ProductCode" => ProductCode,
"Timestamp" => Timestamp,
"UsageDimension" => UsageDimension,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function meter_usage(
ProductCode,
Timestamp,
UsageDimension,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_metering(
"MeterUsage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductCode" => ProductCode,
"Timestamp" => Timestamp,
"UsageDimension" => UsageDimension,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_usage(product_code, public_key_version)
register_usage(product_code, public_key_version, params::Dict{String,<:Any})
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. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
RegisterUsage, but you may choose to do so if you would like to receive usage data in your
seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage
performs two primary functions: metering and entitlement. Entitlement: RegisterUsage
allows you to verify that the customer running your paid software is subscribed to your
product on AWS Marketplace, enabling you to guard against unauthorized use. Your container
image that integrates with RegisterUsage is only required to guard against unauthorized use
at container startup, as such a CustomerNotSubscribedException or
PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage.
Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod
will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while
the Amazon ECS task or Amazon EKS pod is still running. Metering: RegisterUsage meters
software use per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the
second. A minimum of 1 minute of usage applies to tasks that are short lived. For example,
if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured as a
Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and
the customer will be charged: (10 * hourly_rate). Metering for software use is
automatically handled by the AWS Marketplace Metering Control Plane -- your software is not
required to perform any metering specific actions, other than call RegisterUsage once for
metering of software use to commence. The AWS Marketplace Metering Control Plane will also
continue to bill customers for running ECS tasks and Amazon EKS pods, regardless of the
customers subscription state, removing the need for your software to perform entitlement
checks at runtime.
# Arguments
- `product_code`: Product code is used to uniquely identify a product in AWS Marketplace.
The product code should be the same as the one used during the publishing of a new product.
- `public_key_version`: Public Key Version provided by AWS Marketplace
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Nonce"`: (Optional) To scope down the registration to a specific running software
instance and guard against replay attacks.
"""
function register_usage(
ProductCode, PublicKeyVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_metering(
"RegisterUsage",
Dict{String,Any}(
"ProductCode" => ProductCode, "PublicKeyVersion" => PublicKeyVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_usage(
ProductCode,
PublicKeyVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_metering(
"RegisterUsage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductCode" => ProductCode, "PublicKeyVersion" => PublicKeyVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resolve_customer(registration_token)
resolve_customer(registration_token, params::Dict{String,<:Any})
ResolveCustomer is 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 their browser. The registration token is resolved through this API to obtain
a CustomerIdentifier along with the CustomerAWSAccountId and ProductCode. The API needs to
called from the seller account id used to publish the SaaS application to successfully
resolve the token. For an example of using ResolveCustomer, see ResolveCustomer code
example in the AWS Marketplace Seller Guide.
# Arguments
- `registration_token`: When a buyer visits your website during the registration process,
the buyer submits a registration token through the browser. The registration token is
resolved to obtain a CustomerIdentifier along with the CustomerAWSAccountId and ProductCode.
"""
function resolve_customer(
RegistrationToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return marketplace_metering(
"ResolveCustomer",
Dict{String,Any}("RegistrationToken" => RegistrationToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resolve_customer(
RegistrationToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return marketplace_metering(
"ResolveCustomer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegistrationToken" => RegistrationToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 66117 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediaconnect
using AWS.Compat
using AWS.UUIDs
"""
add_bridge_outputs(bridge_arn, outputs)
add_bridge_outputs(bridge_arn, outputs, params::Dict{String,<:Any})
Adds outputs to an existing bridge.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `outputs`: The outputs that you want to add to this bridge.
"""
function add_bridge_outputs(
bridgeArn, outputs; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/bridges/$(bridgeArn)/outputs",
Dict{String,Any}("outputs" => outputs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_bridge_outputs(
bridgeArn,
outputs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/bridges/$(bridgeArn)/outputs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("outputs" => outputs), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_bridge_sources(bridge_arn, sources)
add_bridge_sources(bridge_arn, sources, params::Dict{String,<:Any})
Adds sources to an existing bridge.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `sources`: The sources that you want to add to this bridge.
"""
function add_bridge_sources(
bridgeArn, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/bridges/$(bridgeArn)/sources",
Dict{String,Any}("sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_bridge_sources(
bridgeArn,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/bridges/$(bridgeArn)/sources",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("sources" => sources), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_flow_media_streams(flow_arn, media_streams)
add_flow_media_streams(flow_arn, media_streams, params::Dict{String,<:Any})
Adds media streams to an existing flow. After you add a media stream to a flow, you can
associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.
# Arguments
- `flow_arn`: The Amazon Resource Name (ARN) of the flow.
- `media_streams`: The media streams that you want to add to the flow.
"""
function add_flow_media_streams(
flowArn, mediaStreams; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/mediaStreams",
Dict{String,Any}("mediaStreams" => mediaStreams);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_flow_media_streams(
flowArn,
mediaStreams,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/mediaStreams",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("mediaStreams" => mediaStreams), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_flow_outputs(flow_arn, outputs)
add_flow_outputs(flow_arn, outputs, params::Dict{String,<:Any})
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
# Arguments
- `flow_arn`: The flow that you want to add outputs to.
- `outputs`: A list of outputs that you want to add.
"""
function add_flow_outputs(
flowArn, outputs; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/outputs",
Dict{String,Any}("outputs" => outputs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_flow_outputs(
flowArn,
outputs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/outputs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("outputs" => outputs), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_flow_sources(flow_arn, sources)
add_flow_sources(flow_arn, sources, params::Dict{String,<:Any})
Adds Sources to flow
# Arguments
- `flow_arn`: The flow that you want to mutate.
- `sources`: A list of sources that you want to add.
"""
function add_flow_sources(
flowArn, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/source",
Dict{String,Any}("sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_flow_sources(
flowArn,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/source",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("sources" => sources), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_flow_vpc_interfaces(flow_arn, vpc_interfaces)
add_flow_vpc_interfaces(flow_arn, vpc_interfaces, params::Dict{String,<:Any})
Adds VPC interfaces to flow
# Arguments
- `flow_arn`: The flow that you want to mutate.
- `vpc_interfaces`: A list of VPC interfaces that you want to add.
"""
function add_flow_vpc_interfaces(
flowArn, vpcInterfaces; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/vpcInterfaces",
Dict{String,Any}("vpcInterfaces" => vpcInterfaces);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_flow_vpc_interfaces(
flowArn,
vpcInterfaces,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/vpcInterfaces",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("vpcInterfaces" => vpcInterfaces), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bridge(name, placement_arn, sources)
create_bridge(name, placement_arn, sources, params::Dict{String,<:Any})
Creates a new bridge. The request must include one source.
# Arguments
- `name`: The name of the bridge. This name can not be modified after the bridge is created.
- `placement_arn`: The bridge placement Amazon Resource Number (ARN).
- `sources`: The sources that you want to add to this bridge.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"egressGatewayBridge"`: Create a bridge with the egress bridge type. An egress bridge is
a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is
delivered to your premises.
- `"ingressGatewayBridge"`: Create a bridge with the ingress bridge type. An ingress bridge
is a ground-to-cloud bridge. The content originates at your premises and is delivered to
the cloud.
- `"outputs"`: The outputs that you want to add to this bridge.
- `"sourceFailoverConfig"`: The settings for source failover.
"""
function create_bridge(
name, placementArn, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/bridges",
Dict{String,Any}(
"name" => name, "placementArn" => placementArn, "sources" => sources
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bridge(
name,
placementArn,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/bridges",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "placementArn" => placementArn, "sources" => sources
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_flow(name)
create_flow(name, params::Dict{String,<:Any})
Creates a new flow. The request must include one source. The request optionally can include
outputs (up to 50) and entitlements (up to 50).
# Arguments
- `name`: The name of the flow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"availabilityZone"`: The Availability Zone that you want to create the flow in. These
options are limited to the Availability Zones within the current AWS Region.
- `"entitlements"`: The entitlements that you want to grant on a flow.
- `"maintenance"`:
- `"mediaStreams"`: The media streams that you want to add to the flow. You can associate
these media streams with sources and outputs on the flow.
- `"outputs"`: The outputs that you want to add to this flow.
- `"source"`:
- `"sourceFailoverConfig"`:
- `"sources"`:
- `"vpcInterfaces"`: The VPC interfaces you want on the flow.
"""
function create_flow(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"POST",
"/v1/flows",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_flow(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_gateway(egress_cidr_blocks, name, networks)
create_gateway(egress_cidr_blocks, name, networks, params::Dict{String,<:Any})
Creates a new gateway. The request must include at least one network (up to 4).
# Arguments
- `egress_cidr_blocks`: The range of IP addresses that are allowed to contribute content or
initiate output requests for flows communicating with this gateway. These IP addresses
should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example,
10.0.0.0/16.
- `name`: The name of the gateway. This name can not be modified after the gateway is
created.
- `networks`: The list of networks that you want to add.
"""
function create_gateway(
egressCidrBlocks, name, networks; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/gateways",
Dict{String,Any}(
"egressCidrBlocks" => egressCidrBlocks, "name" => name, "networks" => networks
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_gateway(
egressCidrBlocks,
name,
networks,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/gateways",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"egressCidrBlocks" => egressCidrBlocks,
"name" => name,
"networks" => networks,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bridge(bridge_arn)
delete_bridge(bridge_arn, params::Dict{String,<:Any})
Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to delete.
"""
function delete_bridge(bridgeArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"DELETE",
"/v1/bridges/$(bridgeArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bridge(
bridgeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/bridges/$(bridgeArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_flow(flow_arn)
delete_flow(flow_arn, params::Dict{String,<:Any})
Deletes a flow. Before you can delete a flow, you must stop the flow.
# Arguments
- `flow_arn`: The ARN of the flow that you want to delete.
"""
function delete_flow(flowArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_flow(
flowArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_gateway(gateway_arn)
delete_gateway(gateway_arn, params::Dict{String,<:Any})
Deletes a gateway. Before you can delete a gateway, you must deregister its instances and
delete its bridges.
# Arguments
- `gateway_arn`: The ARN of the gateway that you want to delete.
"""
function delete_gateway(gatewayArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"DELETE",
"/v1/gateways/$(gatewayArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_gateway(
gatewayArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/gateways/$(gatewayArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_gateway_instance(gateway_instance_arn)
deregister_gateway_instance(gateway_instance_arn, params::Dict{String,<:Any})
Deregisters an instance. Before you deregister an instance, all bridges running on the
instance must be stopped. If you want to deregister an instance without stopping the
bridges, you must use the --force option.
# Arguments
- `gateway_instance_arn`: The Amazon Resource Name (ARN) of the gateway that contains the
instance that you want to deregister.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: Force the deregistration of an instance. Force will deregister an instance,
even if there are bridges running on it.
"""
function deregister_gateway_instance(
gatewayInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/gateway-instances/$(gatewayInstanceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_gateway_instance(
gatewayInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/gateway-instances/$(gatewayInstanceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bridge(bridge_arn)
describe_bridge(bridge_arn, params::Dict{String,<:Any})
Displays the details of a bridge.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to describe.
"""
function describe_bridge(bridgeArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET",
"/v1/bridges/$(bridgeArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bridge(
bridgeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"GET",
"/v1/bridges/$(bridgeArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_flow(flow_arn)
describe_flow(flow_arn, params::Dict{String,<:Any})
Displays the details of a flow. The response includes the flow ARN, name, and Availability
Zone, as well as details about the source, outputs, and entitlements.
# Arguments
- `flow_arn`: The ARN of the flow that you want to describe.
"""
function describe_flow(flowArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET",
"/v1/flows/$(flowArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_flow(
flowArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/flows/$(flowArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_flow_source_metadata(flow_arn)
describe_flow_source_metadata(flow_arn, params::Dict{String,<:Any})
Displays details of the flow's source stream. The response contains information about the
contents of the stream and its programs.
# Arguments
- `flow_arn`: The Amazon Resource Name (ARN) of the flow.
"""
function describe_flow_source_metadata(
flowArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/flows/$(flowArn)/source-metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_flow_source_metadata(
flowArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/flows/$(flowArn)/source-metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_gateway(gateway_arn)
describe_gateway(gateway_arn, params::Dict{String,<:Any})
Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR
blocks, as well as details about the networks.
# Arguments
- `gateway_arn`: The Amazon Resource Name (ARN) of the gateway that you want to describe.
"""
function describe_gateway(gatewayArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET",
"/v1/gateways/$(gatewayArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_gateway(
gatewayArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"GET",
"/v1/gateways/$(gatewayArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_gateway_instance(gateway_instance_arn)
describe_gateway_instance(gateway_instance_arn, params::Dict{String,<:Any})
Displays the details of an instance.
# Arguments
- `gateway_instance_arn`: The Amazon Resource Name (ARN) of the gateway instance that you
want to describe.
"""
function describe_gateway_instance(
gatewayInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/gateway-instances/$(gatewayInstanceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_gateway_instance(
gatewayInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"GET",
"/v1/gateway-instances/$(gatewayInstanceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_offering(offering_arn)
describe_offering(offering_arn, params::Dict{String,<:Any})
Displays the details of an offering. The response includes the offering description,
duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
# Arguments
- `offering_arn`: The Amazon Resource Name (ARN) of the offering.
"""
function describe_offering(offeringArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET",
"/v1/offerings/$(offeringArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_offering(
offeringArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"GET",
"/v1/offerings/$(offeringArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reservation(reservation_arn)
describe_reservation(reservation_arn, params::Dict{String,<:Any})
Displays the details of a reservation. The response includes the reservation name, state,
start date and time, and the details of the offering that make up the rest of the
reservation (such as price, duration, and outbound bandwidth).
# Arguments
- `reservation_arn`: The Amazon Resource Name (ARN) of the reservation.
"""
function describe_reservation(
reservationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/reservations/$(reservationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reservation(
reservationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"GET",
"/v1/reservations/$(reservationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
grant_flow_entitlements(entitlements, flow_arn)
grant_flow_entitlements(entitlements, flow_arn, params::Dict{String,<:Any})
Grants entitlements to an existing flow.
# Arguments
- `entitlements`: The list of entitlements that you want to grant.
- `flow_arn`: The flow that you want to grant entitlements on.
"""
function grant_flow_entitlements(
entitlements, flowArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/entitlements",
Dict{String,Any}("entitlements" => entitlements);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function grant_flow_entitlements(
entitlements,
flowArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/flows/$(flowArn)/entitlements",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("entitlements" => entitlements), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bridges()
list_bridges(params::Dict{String,<:Any})
Displays a list of bridges that are associated with this account and an optionally
specified Arn. This request returns a paginated result.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterArn"`: Filter the list results to display only the bridges associated with the
selected Amazon Resource Name (ARN).
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListBridges request with MaxResults set at 5. Although 20 items match your
request, the service returns no more than the first 5 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 10 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListBridges request with MaxResults set at 5. The service returns the
first batch of results (up to 5) and a NextToken value. To see the next batch of results,
you can submit the ListBridges request a second time and specify the NextToken value.
"""
function list_bridges(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET", "/v1/bridges"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_bridges(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET", "/v1/bridges", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_entitlements()
list_entitlements(params::Dict{String,<:Any})
Displays a list of all entitlements that have been granted to this account. This request
returns 20 results per page.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your
request, the service returns no more than the first 5 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 20 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListEntitlements request with MaxResults set at 5. The service
returns the first batch of results (up to 5) and a NextToken value. To see the next batch
of results, you can submit the ListEntitlements request a second time and specify the
NextToken value.
"""
function list_entitlements(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET", "/v1/entitlements"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_entitlements(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/entitlements",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_flows()
list_flows(params::Dict{String,<:Any})
Displays a list of flows that are associated with this account. This request returns a
paginated result.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListFlows request with MaxResults set at 5. Although 20 items match your request,
the service returns no more than the first 5 items. (The service also returns a NextToken
value that you can use to fetch the next batch of results.) The service might return fewer
results than the MaxResults value. If MaxResults is not included in the request, the
service defaults to pagination with a maximum of 10 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListFlows request with MaxResults set at 5. The service returns the
first batch of results (up to 5) and a NextToken value. To see the next batch of results,
you can submit the ListFlows request a second time and specify the NextToken value.
"""
function list_flows(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET", "/v1/flows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_flows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET", "/v1/flows", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_gateway_instances()
list_gateway_instances(params::Dict{String,<:Any})
Displays a list of instances associated with the AWS account. This request returns a
paginated result. You can use the filterArn property to display only the instances
associated with the selected Gateway Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterArn"`: Filter the list results to display only the instances associated with the
selected Gateway Amazon Resource Name (ARN).
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListInstances request with MaxResults set at 5. Although 20 items match your
request, the service returns no more than the first 5 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 10 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListInstances request with MaxResults set at 5. The service returns
the first batch of results (up to 5) and a NextToken value. To see the next batch of
results, you can submit the ListInstances request a second time and specify the NextToken
value.
"""
function list_gateway_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET",
"/v1/gateway-instances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_gateway_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/gateway-instances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_gateways()
list_gateways(params::Dict{String,<:Any})
Displays a list of gateways that are associated with this account. This request returns a
paginated result.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListGateways request with MaxResults set at 5. Although 20 items match your
request, the service returns no more than the first 5 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 10 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListGateways request with MaxResults set at 5. The service returns
the first batch of results (up to 5) and a NextToken value. To see the next batch of
results, you can submit the ListGateways request a second time and specify the NextToken
value.
"""
function list_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET", "/v1/gateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/gateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_offerings()
list_offerings(params::Dict{String,<:Any})
Displays a list of all offerings that are available to this account in the current AWS
Region. If you have an active reservation (which means you've purchased an offering that
has already started and hasn't expired yet), your account isn't eligible for other
offerings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListOfferings request with MaxResults set at 5. Although 20 items match your
request, the service returns no more than the first 5 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 10 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListOfferings request with MaxResults set at 5. The service returns
the first batch of results (up to 5) and a NextToken value. To see the next batch of
results, you can submit the ListOfferings request a second time and specify the NextToken
value.
"""
function list_offerings(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET", "/v1/offerings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/offerings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_reservations()
list_reservations(params::Dict{String,<:Any})
Displays a list of all reservations that have been purchased by this account in the current
AWS Region. This list includes all reservations in all states (such as active and expired).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return per API request. For example, you
submit a ListReservations request with MaxResults set at 5. Although 20 items match your
request, the service returns no more than the first 5 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 10 results per page.
- `"nextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListReservations request with MaxResults set at 5. The service
returns the first batch of results (up to 5) and a NextToken value. To see the next batch
of results, you can submit the ListOfferings request a second time and specify the
NextToken value.
"""
function list_reservations(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"GET", "/v1/reservations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_reservations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/v1/reservations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
List all tags on an AWS Elemental MediaConnect resource
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the AWS Elemental
MediaConnect resource for which to list the tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_offering(offering_arn, reservation_name, start)
purchase_offering(offering_arn, reservation_name, start, params::Dict{String,<:Any})
Submits a request to purchase an offering. If you already have an active reservation, you
can't purchase another offering.
# Arguments
- `offering_arn`: The Amazon Resource Name (ARN) of the offering.
- `reservation_name`: The name that you want to use for the reservation.
- `start`: The date and time that you want the reservation to begin, in Coordinated
Universal Time (UTC). You can specify any date and time between 12:00am on the first day of
the current month to the current time on today's date, inclusive. Specify the start in a
24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal
characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.
"""
function purchase_offering(
offeringArn, reservationName, start; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/offerings/$(offeringArn)",
Dict{String,Any}("reservationName" => reservationName, "start" => start);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_offering(
offeringArn,
reservationName,
start,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/v1/offerings/$(offeringArn)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("reservationName" => reservationName, "start" => start),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_bridge_output(bridge_arn, output_name)
remove_bridge_output(bridge_arn, output_name, params::Dict{String,<:Any})
Removes an output from a bridge.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `output_name`: The name of the bridge output that you want to remove.
"""
function remove_bridge_output(
bridgeArn, outputName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/bridges/$(bridgeArn)/outputs/$(outputName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_bridge_output(
bridgeArn,
outputName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/bridges/$(bridgeArn)/outputs/$(outputName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_bridge_source(bridge_arn, source_name)
remove_bridge_source(bridge_arn, source_name, params::Dict{String,<:Any})
Removes a source from a bridge.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `source_name`: The name of the bridge source that you want to remove.
"""
function remove_bridge_source(
bridgeArn, sourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/bridges/$(bridgeArn)/sources/$(sourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_bridge_source(
bridgeArn,
sourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/bridges/$(bridgeArn)/sources/$(sourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_flow_media_stream(flow_arn, media_stream_name)
remove_flow_media_stream(flow_arn, media_stream_name, params::Dict{String,<:Any})
Removes a media stream from a flow. This action is only available if the media stream is
not associated with a source or output.
# Arguments
- `flow_arn`: The Amazon Resource Name (ARN) of the flow.
- `media_stream_name`: The name of the media stream that you want to remove.
"""
function remove_flow_media_stream(
flowArn, mediaStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/mediaStreams/$(mediaStreamName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_flow_media_stream(
flowArn,
mediaStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/mediaStreams/$(mediaStreamName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_flow_output(flow_arn, output_arn)
remove_flow_output(flow_arn, output_arn, params::Dict{String,<:Any})
Removes an output from an existing flow. This request can be made only on an output that
does not have an entitlement associated with it. If the output has an entitlement, you must
revoke the entitlement instead. When an entitlement is revoked from a flow, the service
automatically removes the associated output.
# Arguments
- `flow_arn`: The flow that you want to remove an output from.
- `output_arn`: The ARN of the output that you want to remove.
"""
function remove_flow_output(
flowArn, outputArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/outputs/$(outputArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_flow_output(
flowArn,
outputArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/outputs/$(outputArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_flow_source(flow_arn, source_arn)
remove_flow_source(flow_arn, source_arn, params::Dict{String,<:Any})
Removes a source from an existing flow. This request can be made only if there is more than
one source on the flow.
# Arguments
- `flow_arn`: The flow that you want to remove a source from.
- `source_arn`: The ARN of the source that you want to remove.
"""
function remove_flow_source(
flowArn, sourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/source/$(sourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_flow_source(
flowArn,
sourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/source/$(sourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_flow_vpc_interface(flow_arn, vpc_interface_name)
remove_flow_vpc_interface(flow_arn, vpc_interface_name, params::Dict{String,<:Any})
Removes a VPC Interface from an existing flow. This request can be made only on a VPC
interface that does not have a Source or Output associated with it. If the VPC interface is
referenced by a Source or Output, you must first delete or update the Source or Output to
no longer reference the VPC interface.
# Arguments
- `flow_arn`: The flow that you want to remove a VPC interface from.
- `vpc_interface_name`: The name of the VPC interface that you want to remove.
"""
function remove_flow_vpc_interface(
flowArn, vpcInterfaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/vpcInterfaces/$(vpcInterfaceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_flow_vpc_interface(
flowArn,
vpcInterfaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/vpcInterfaces/$(vpcInterfaceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_flow_entitlement(entitlement_arn, flow_arn)
revoke_flow_entitlement(entitlement_arn, flow_arn, params::Dict{String,<:Any})
Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes
unavailable to the subscriber and the associated output is removed.
# Arguments
- `entitlement_arn`: The ARN of the entitlement that you want to revoke.
- `flow_arn`: The flow that you want to revoke an entitlement from.
"""
function revoke_flow_entitlement(
entitlementArn, flowArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/entitlements/$(entitlementArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_flow_entitlement(
entitlementArn,
flowArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/v1/flows/$(flowArn)/entitlements/$(entitlementArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_flow(flow_arn)
start_flow(flow_arn, params::Dict{String,<:Any})
Starts a flow.
# Arguments
- `flow_arn`: The ARN of the flow that you want to start.
"""
function start_flow(flowArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"POST",
"/v1/flows/start/$(flowArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_flow(
flowArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/start/$(flowArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_flow(flow_arn)
stop_flow(flow_arn, params::Dict{String,<:Any})
Stops a flow.
# Arguments
- `flow_arn`: The ARN of the flow that you want to stop.
"""
function stop_flow(flowArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"POST",
"/v1/flows/stop/$(flowArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_flow(
flowArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"POST",
"/v1/flows/stop/$(flowArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates the specified tags to a resource with the specified resourceArn. If existing
tags on a resource are not specified in the request parameters, they are not changed. When
a resource is deleted, the tags associated with that resource are deleted as well.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the AWS Elemental
MediaConnect resource to which to add tags.
- `tags`: A map from tag keys to values. Tag keys can have a maximum character length of
128 characters, and tag values can have a maximum length of 256 characters.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Deletes specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the AWS Elemental
MediaConnect resource from which to delete tags.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bridge(bridge_arn)
update_bridge(bridge_arn, params::Dict{String,<:Any})
Updates the bridge
# Arguments
- `bridge_arn`: The Amazon Resource Number (ARN) of the bridge that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"egressGatewayBridge"`:
- `"ingressGatewayBridge"`:
- `"sourceFailoverConfig"`:
"""
function update_bridge(bridgeArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bridge(
bridgeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bridge_output(bridge_arn, output_name)
update_bridge_output(bridge_arn, output_name, params::Dict{String,<:Any})
Updates an existing bridge output.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `output_name`: The name of the bridge output that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"networkOutput"`:
"""
function update_bridge_output(
bridgeArn, outputName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)/outputs/$(outputName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bridge_output(
bridgeArn,
outputName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)/outputs/$(outputName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bridge_source(bridge_arn, source_name)
update_bridge_source(bridge_arn, source_name, params::Dict{String,<:Any})
Updates an existing bridge source.
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `source_name`: The name of the source that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"flowSource"`:
- `"networkSource"`:
"""
function update_bridge_source(
bridgeArn, sourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)/sources/$(sourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bridge_source(
bridgeArn,
sourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)/sources/$(sourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bridge_state(bridge_arn, desired_state)
update_bridge_state(bridge_arn, desired_state, params::Dict{String,<:Any})
Updates the bridge state
# Arguments
- `bridge_arn`: The ARN of the bridge that you want to update.
- `desired_state`:
"""
function update_bridge_state(
bridgeArn, desiredState; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)/state",
Dict{String,Any}("desiredState" => desiredState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bridge_state(
bridgeArn,
desiredState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/bridges/$(bridgeArn)/state",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("desiredState" => desiredState), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flow(flow_arn)
update_flow(flow_arn, params::Dict{String,<:Any})
Updates flow
# Arguments
- `flow_arn`: The flow that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maintenance"`:
- `"sourceFailoverConfig"`:
"""
function update_flow(flowArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flow(
flowArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flow_entitlement(entitlement_arn, flow_arn)
update_flow_entitlement(entitlement_arn, flow_arn, params::Dict{String,<:Any})
You can change an entitlement's description, subscribers, and encryption. If you change the
subscribers, the service will remove the outputs that are are used by the subscribers that
are removed.
# Arguments
- `entitlement_arn`: The ARN of the entitlement that you want to update.
- `flow_arn`: The flow that is associated with the entitlement that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the entitlement. This description appears only on the
AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
- `"encryption"`: The type of encryption that will be used on the output associated with
this entitlement. Allowable encryption types: static-key, speke.
- `"entitlementStatus"`: An indication of whether you want to enable the entitlement to
allow access, or disable it to stop streaming content to the subscriber’s flow
temporarily. If you don’t specify the entitlementStatus field in your request,
MediaConnect leaves the value unchanged.
- `"subscribers"`: The AWS account IDs that you want to share your content with. The
receiving accounts (subscribers) will be allowed to create their own flow using your
content as the source.
"""
function update_flow_entitlement(
entitlementArn, flowArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/entitlements/$(entitlementArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flow_entitlement(
entitlementArn,
flowArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/entitlements/$(entitlementArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flow_media_stream(flow_arn, media_stream_name)
update_flow_media_stream(flow_arn, media_stream_name, params::Dict{String,<:Any})
Updates an existing media stream.
# Arguments
- `flow_arn`: The Amazon Resource Name (ARN) of the flow.
- `media_stream_name`: The name of the media stream that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: The attributes that you want to assign to the media stream.
- `"clockRate"`: The sample rate (in Hz) for the stream. If the media stream type is video
or ancillary data, set this value to 90000. If the media stream type is audio, set this
value to either 48000 or 96000.
- `"description"`: Description
- `"mediaStreamType"`: The type of media stream.
- `"videoFormat"`: The resolution of the video.
"""
function update_flow_media_stream(
flowArn, mediaStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/mediaStreams/$(mediaStreamName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flow_media_stream(
flowArn,
mediaStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/mediaStreams/$(mediaStreamName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flow_output(flow_arn, output_arn)
update_flow_output(flow_arn, output_arn, params::Dict{String,<:Any})
Updates an existing flow output.
# Arguments
- `flow_arn`: The flow that is associated with the output that you want to update.
- `output_arn`: The ARN of the output that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cidrAllowList"`: The range of IP addresses that should be allowed to initiate output
requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain
Routing (CIDR) block; for example, 10.0.0.0/16.
- `"description"`: A description of the output. This description appears only on the AWS
Elemental MediaConnect console and will not be seen by the end user.
- `"destination"`: The IP address where you want to send the output.
- `"encryption"`: The type of key used for the encryption. If no keyType is provided, the
service will use the default setting (static-key). Allowable encryption types: static-key.
- `"maxLatency"`: The maximum latency in milliseconds. This parameter applies only to
RIST-based, Zixi-based, and Fujitsu-based streams.
- `"mediaStreamOutputConfigurations"`: The media streams that are associated with the
output, and the parameters for those associations.
- `"minLatency"`: The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect source or output
represents the minimal potential latency of that connection. The latency of the stream is
set to the highest number between the sender’s minimum latency and the receiver’s
minimum latency.
- `"port"`: The port to use when content is distributed to this output.
- `"protocol"`: The protocol to use for the output.
- `"remoteId"`: The remote ID for the Zixi-pull stream.
- `"senderControlPort"`: The port that the flow uses to send outbound requests to initiate
connection with the sender.
- `"senderIpAddress"`: The IP address that the flow communicates with to initiate
connection with the sender.
- `"smoothingLatency"`: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC
streams.
- `"streamId"`: The stream ID that you want to use for this transport. This parameter
applies only to Zixi and SRT caller-based streams.
- `"vpcInterfaceAttachment"`: The name of the VPC interface attachment to use for this
output.
"""
function update_flow_output(
flowArn, outputArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/outputs/$(outputArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flow_output(
flowArn,
outputArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/outputs/$(outputArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flow_source(flow_arn, source_arn)
update_flow_source(flow_arn, source_arn, params::Dict{String,<:Any})
Updates the source of a flow.
# Arguments
- `flow_arn`: The flow that is associated with the source that you want to update.
- `source_arn`: The ARN of the source that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"decryption"`: The type of encryption used on the content ingested from this source.
Allowable encryption types: static-key.
- `"description"`: A description for the source. This value is not used or seen outside of
the current AWS Elemental MediaConnect account.
- `"entitlementArn"`: The ARN of the entitlement that allows you to subscribe to this flow.
The entitlement is set by the flow originator, and the ARN is generated as part of the
originator's flow.
- `"gatewayBridgeSource"`: The source configuration for cloud flows receiving a stream from
a bridge.
- `"ingestPort"`: The port that the flow will be listening on for incoming content.
- `"maxBitrate"`: The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
- `"maxLatency"`: The maximum latency in milliseconds. This parameter applies only to
RIST-based, Zixi-based, and Fujitsu-based streams.
- `"maxSyncBuffer"`: The size of the buffer (in milliseconds) to use to sync incoming
source data.
- `"mediaStreamSourceConfigurations"`: The media streams that are associated with the
source, and the parameters for those associations.
- `"minLatency"`: The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your MediaConnect source or output
represents the minimal potential latency of that connection. The latency of the stream is
set to the highest number between the sender’s minimum latency and the receiver’s
minimum latency.
- `"protocol"`: The protocol that is used by the source.
- `"senderControlPort"`: The port that the flow uses to send outbound requests to initiate
connection with the sender.
- `"senderIpAddress"`: The IP address that the flow communicates with to initiate
connection with the sender.
- `"sourceListenerAddress"`: Source IP or domain name for SRT-caller protocol.
- `"sourceListenerPort"`: Source port for SRT-caller protocol.
- `"streamId"`: The stream ID that you want to use for this transport. This parameter
applies only to Zixi and SRT caller-based streams.
- `"vpcInterfaceName"`: The name of the VPC interface to use for this source.
- `"whitelistCidr"`: The range of IP addresses that should be allowed to contribute content
to your source. These IP addresses should be in the form of a Classless Inter-Domain
Routing (CIDR) block; for example, 10.0.0.0/16.
"""
function update_flow_source(
flowArn, sourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/source/$(sourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flow_source(
flowArn,
sourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/flows/$(flowArn)/source/$(sourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_gateway_instance(gateway_instance_arn)
update_gateway_instance(gateway_instance_arn, params::Dict{String,<:Any})
Updates the configuration of an existing Gateway Instance.
# Arguments
- `gateway_instance_arn`: The Amazon Resource Name (ARN) of the instance that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bridgePlacement"`: The availability of the instance to host new bridges. The
bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be
deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
"""
function update_gateway_instance(
gatewayInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconnect(
"PUT",
"/v1/gateway-instances/$(gatewayInstanceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_gateway_instance(
gatewayInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconnect(
"PUT",
"/v1/gateway-instances/$(gatewayInstanceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 39293 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediaconvert
using AWS.Compat
using AWS.UUIDs
"""
associate_certificate(arn)
associate_certificate(arn, params::Dict{String,<:Any})
Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental
MediaConvert.
# Arguments
- `arn`: The ARN of the ACM certificate that you want to associate with your MediaConvert
resource.
"""
function associate_certificate(arn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"POST",
"/2017-08-29/certificates",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_certificate(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"POST",
"/2017-08-29/certificates",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_job(id)
cancel_job(id, params::Dict{String,<:Any})
Permanently cancel a job. Once you have canceled a job, you can't start it again.
# Arguments
- `id`: The Job ID of the job to be cancelled.
"""
function cancel_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"DELETE",
"/2017-08-29/jobs/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"DELETE",
"/2017-08-29/jobs/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(role, settings)
create_job(role, settings, params::Dict{String,<:Any})
Create a new transcoding job. For information about jobs and job settings, see the User
Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
# Arguments
- `role`: Required. The IAM role you use for creating this job. For details about
permissions, see the User Guide topic at the User Guide at
https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
- `settings`: JobSettings contains all the transcode settings for a job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accelerationSettings"`: Optional. Accelerated transcoding can significantly speed up
jobs with long, visually complex content. Outputs that use this feature incur pro-tier
pricing. For information about feature limitations, see the AWS Elemental MediaConvert User
Guide.
- `"billingTagsSource"`: Optional. Choose a tag type that AWS Billing and Cost Management
will use to sort your AWS Elemental MediaConvert costs on any billing report that you set
up. Any transcoding outputs that don't have an associated tag will appear in your billing
report unsorted. If you don't choose a valid value for this field, your job outputs will
appear on the billing report unsorted.
- `"clientRequestToken"`: Prevent duplicate jobs from being created and ensure idempotency
for your requests. A client request token can be any string that includes up to 64 ASCII
characters. If you reuse a client request token within one minute of a successful request,
the API returns the job details of the original request instead. For more information see
https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
- `"hopDestinations"`: Optional. Use queue hopping to avoid overly long waits in the
backlog of the queue that you submit your job to. Specify an alternate queue and the
maximum time that your job will wait in the initial queue before hopping. For more
information about this feature, see the AWS Elemental MediaConvert User Guide.
- `"jobTemplate"`: Optional. When you create a job, you can either specify a job template
or specify the transcoding settings individually.
- `"priority"`: Optional. Specify the relative priority for this job. In any given queue,
the service begins processing the job with the highest value first. When more than one job
has the same priority, the service begins processing the job that you submitted first. If
you don't specify a priority, the service uses the default value 0.
- `"queue"`: Optional. When you create a job, you can specify a queue to send it to. If you
don't specify, the job will go to the default queue. For more about queues, see the User
Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
- `"simulateReservedQueue"`: Optional. Enable this setting when you run a test job to
estimate how many reserved transcoding slots (RTS) you need. When this is enabled,
MediaConvert runs your job from an on-demand queue with similar performance to what you
will see with one RTS in a reserved queue. This setting is disabled by default.
- `"statusUpdateInterval"`: Optional. Specify how often MediaConvert sends STATUS_UPDATE
events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates.
MediaConvert sends an update at this interval from the time the service begins processing
your job to the time it completes the transcode or encounters an error.
- `"tags"`: Optional. The tags that you want to add to the resource. You can tag resources
with a key-value pair or with only a key. Use standard AWS tags on your job for automatic
integration with AWS services and for custom integrations and workflows.
- `"userMetadata"`: Optional. User-defined metadata that you want to associate with an
MediaConvert job. You specify metadata in key/value pairs. Use only for existing
integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you
use standard AWS tags.
"""
function create_job(role, settings; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"POST",
"/2017-08-29/jobs",
Dict{String,Any}(
"role" => role, "settings" => settings, "clientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
role,
settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconvert(
"POST",
"/2017-08-29/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"role" => role,
"settings" => settings,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job_template(name, settings)
create_job_template(name, settings, params::Dict{String,<:Any})
Create a new job template. For information about job templates see the User Guide at
http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
# Arguments
- `name`: The name of the job template you are creating.
- `settings`: JobTemplateSettings contains all the transcode settings saved in the template
that will be applied to jobs created from it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accelerationSettings"`: Accelerated transcoding can significantly speed up jobs with
long, visually complex content. Outputs that use this feature incur pro-tier pricing. For
information about feature limitations, see the AWS Elemental MediaConvert User Guide.
- `"category"`: Optional. A category for the job template you are creating
- `"description"`: Optional. A description of the job template you are creating.
- `"hopDestinations"`: Optional. Use queue hopping to avoid overly long waits in the
backlog of the queue that you submit your job to. Specify an alternate queue and the
maximum time that your job will wait in the initial queue before hopping. For more
information about this feature, see the AWS Elemental MediaConvert User Guide.
- `"priority"`: Specify the relative priority for this job. In any given queue, the service
begins processing the job with the highest value first. When more than one job has the same
priority, the service begins processing the job that you submitted first. If you don't
specify a priority, the service uses the default value 0.
- `"queue"`: Optional. The queue that jobs created from this template are assigned to. If
you don't specify this, jobs will go to the default queue.
- `"statusUpdateInterval"`: Specify how often MediaConvert sends STATUS_UPDATE events to
Amazon CloudWatch Events. Set the interval, in seconds, between status updates.
MediaConvert sends an update at this interval from the time the service begins processing
your job to the time it completes the transcode or encounters an error.
- `"tags"`: The tags that you want to add to the resource. You can tag resources with a
key-value pair or with only a key.
"""
function create_job_template(
name, settings; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"POST",
"/2017-08-29/jobTemplates",
Dict{String,Any}("name" => name, "settings" => settings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job_template(
name,
settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconvert(
"POST",
"/2017-08-29/jobTemplates",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "settings" => settings), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_preset(name, settings)
create_preset(name, settings, params::Dict{String,<:Any})
Create a new preset. For information about job templates see the User Guide at
http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
# Arguments
- `name`: The name of the preset you are creating.
- `settings`: Settings for preset
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"category"`: Optional. A category for the preset you are creating.
- `"description"`: Optional. A description of the preset you are creating.
- `"tags"`: The tags that you want to add to the resource. You can tag resources with a
key-value pair or with only a key.
"""
function create_preset(name, settings; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"POST",
"/2017-08-29/presets",
Dict{String,Any}("name" => name, "settings" => settings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_preset(
name,
settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconvert(
"POST",
"/2017-08-29/presets",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "settings" => settings), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_queue(name)
create_queue(name, params::Dict{String,<:Any})
Create a new transcoding queue. For information about queues, see Working With Queues in
the User Guide at
https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html
# Arguments
- `name`: The name of the queue that you are creating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Optional. A description of the queue that you are creating.
- `"pricingPlan"`: Specifies whether the pricing plan for the queue is on-demand or
reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For
reserved, you pay for the transcoding capacity of the entire queue, regardless of how much
or how little you use it. Reserved pricing requires a 12-month commitment. When you use the
API to create a queue, the default is on-demand.
- `"reservationPlanSettings"`: Details about the pricing plan for your reserved queue.
Required for reserved queues and not applicable to on-demand queues.
- `"status"`: Initial state of the queue. If you create a paused queue, then jobs in that
queue won't begin.
- `"tags"`: The tags that you want to add to the resource. You can tag resources with a
key-value pair or with only a key.
"""
function create_queue(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"POST",
"/2017-08-29/queues",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_queue(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"POST",
"/2017-08-29/queues",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job_template(name)
delete_job_template(name, params::Dict{String,<:Any})
Permanently delete a job template you have created.
# Arguments
- `name`: The name of the job template to be deleted.
"""
function delete_job_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"DELETE",
"/2017-08-29/jobTemplates/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"DELETE",
"/2017-08-29/jobTemplates/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy()
delete_policy(params::Dict{String,<:Any})
Permanently delete a policy that you created.
"""
function delete_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"DELETE",
"/2017-08-29/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"DELETE",
"/2017-08-29/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_preset(name)
delete_preset(name, params::Dict{String,<:Any})
Permanently delete a preset you have created.
# Arguments
- `name`: The name of the preset to be deleted.
"""
function delete_preset(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"DELETE",
"/2017-08-29/presets/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_preset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"DELETE",
"/2017-08-29/presets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queue(name)
delete_queue(name, params::Dict{String,<:Any})
Permanently delete a queue you have created.
# Arguments
- `name`: The name of the queue that you want to delete.
"""
function delete_queue(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"DELETE",
"/2017-08-29/queues/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queue(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"DELETE",
"/2017-08-29/queues/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoints()
describe_endpoints(params::Dict{String,<:Any})
Send a request with an empty body to the regional API endpoint to get your account API
endpoint. Note that DescribeEndpoints is no longer required. We recommend that you send
your requests directly to the regional endpoint instead.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Optional. Max number of endpoints, up to twenty, that will be returned at
one time.
- `"mode"`: Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to
return your endpoints if any exist, or to create an endpoint for you and return it if one
doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty
list if none exist.
- `"nextToken"`: Use this string, provided with the response to a previous request, to
request the next batch of endpoints.
"""
function describe_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"POST",
"/2017-08-29/endpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"POST",
"/2017-08-29/endpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_certificate(arn)
disassociate_certificate(arn, params::Dict{String,<:Any})
Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager
(ACM) certificate and an AWS Elemental MediaConvert resource.
# Arguments
- `arn`: The ARN of the ACM certificate that you want to disassociate from your
MediaConvert resource.
"""
function disassociate_certificate(arn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"DELETE",
"/2017-08-29/certificates/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_certificate(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"DELETE",
"/2017-08-29/certificates/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job(id)
get_job(id, params::Dict{String,<:Any})
Retrieve the JSON for a specific transcoding job.
# Arguments
- `id`: the job ID of the job.
"""
function get_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET",
"/2017-08-29/jobs/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/jobs/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_template(name)
get_job_template(name, params::Dict{String,<:Any})
Retrieve the JSON for a specific job template.
# Arguments
- `name`: The name of the job template.
"""
function get_job_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET",
"/2017-08-29/jobTemplates/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/jobTemplates/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy()
get_policy(params::Dict{String,<:Any})
Retrieve the JSON for your policy.
"""
function get_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET", "/2017-08-29/policy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_preset(name)
get_preset(name, params::Dict{String,<:Any})
Retrieve the JSON for a specific preset.
# Arguments
- `name`: The name of the preset.
"""
function get_preset(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET",
"/2017-08-29/presets/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_preset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/presets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_queue(name)
get_queue(name, params::Dict{String,<:Any})
Retrieve the JSON for a specific queue.
# Arguments
- `name`: The name of the queue that you want information about.
"""
function get_queue(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET",
"/2017-08-29/queues/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_queue(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/queues/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_templates()
list_job_templates(params::Dict{String,<:Any})
Retrieve a JSON array of up to twenty of your job templates. This will return the templates
themselves, not just a list of them. To retrieve the next twenty templates, use the
nextToken string returned with the array
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"category"`: Optionally, specify a job template category to limit responses to only job
templates from that category.
- `"listBy"`: Optional. When you request a list of job templates, you can choose to list
them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the
service will list them by name.
- `"maxResults"`: Optional. Number of job templates, up to twenty, that will be returned at
one time.
- `"nextToken"`: Use this string, provided with the response to a previous request, to
request the next batch of job templates.
- `"order"`: Optional. When you request lists of resources, you can specify whether they
are sorted in ASCENDING or DESCENDING order. Default varies by resource.
"""
function list_job_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET",
"/2017-08-29/jobTemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/jobTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
Retrieve a JSON array of up to twenty of your most recently created jobs. This array
includes in-process, completed, and errored jobs. This will return the jobs themselves, not
just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken
string returned with the array.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Optional. Number of jobs, up to twenty, that will be returned at one time.
- `"nextToken"`: Optional. Use this string, provided with the response to a previous
request, to request the next batch of jobs.
- `"order"`: Optional. When you request lists of resources, you can specify whether they
are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- `"queue"`: Optional. Provide a queue name to get back only jobs from that queue.
- `"status"`: Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED,
or ERROR.
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET", "/2017-08-29/jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_presets()
list_presets(params::Dict{String,<:Any})
Retrieve a JSON array of up to twenty of your presets. This will return the presets
themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken
string returned with the array.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"category"`: Optionally, specify a preset category to limit responses to only presets
from that category.
- `"listBy"`: Optional. When you request a list of presets, you can choose to list them
alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the
service will list them by name.
- `"maxResults"`: Optional. Number of presets, up to twenty, that will be returned at one
time
- `"nextToken"`: Use this string, provided with the response to a previous request, to
request the next batch of presets.
- `"order"`: Optional. When you request lists of resources, you can specify whether they
are sorted in ASCENDING or DESCENDING order. Default varies by resource.
"""
function list_presets(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET", "/2017-08-29/presets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_presets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/presets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queues()
list_queues(params::Dict{String,<:Any})
Retrieve a JSON array of up to twenty of your queues. This will return the queues
themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken
string returned with the array.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"listBy"`: Optional. When you request a list of queues, you can choose to list them
alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the
service will list them by creation date.
- `"maxResults"`: Optional. Number of queues, up to twenty, that will be returned at one
time.
- `"nextToken"`: Use this string, provided with the response to a previous request, to
request the next batch of queues.
- `"order"`: Optional. When you request lists of resources, you can specify whether they
are sorted in ASCENDING or DESCENDING order. Default varies by resource.
"""
function list_queues(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET", "/2017-08-29/queues"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_queues(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/queues",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})
Retrieve the tags for a MediaConvert resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the resource that you want to list tags for. To
get the ARN, send a GET request with the resource name.
"""
function list_tags_for_resource(arn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET",
"/2017-08-29/tags/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/tags/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_policy(policy)
put_policy(policy, params::Dict{String,<:Any})
Create or change your policy. For more information about policies, see the user guide at
http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
# Arguments
- `policy`: A policy configures behavior that you allow or disallow for your account. For
information about MediaConvert policies, see the user guide at
http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
"""
function put_policy(policy; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"PUT",
"/2017-08-29/policy",
Dict{String,Any}("policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_policy(
policy, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"PUT",
"/2017-08-29/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_jobs()
search_jobs(params::Dict{String,<:Any})
Retrieve a JSON array that includes job details for up to twenty of your most recent jobs.
Optionally filter results further according to input file, queue, or status. To retrieve
the twenty next most recent jobs, use the nextToken string returned with the array.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"inputFile"`: Optional. Provide your input file URL or your partial input file name. The
maximum length for an input file is 300 characters.
- `"maxResults"`: Optional. Number of jobs, up to twenty, that will be returned at one time.
- `"nextToken"`: Optional. Use this string, provided with the response to a previous
request, to request the next batch of jobs.
- `"order"`: Optional. When you request lists of resources, you can specify whether they
are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- `"queue"`: Optional. Provide a queue name, or a queue ARN, to return only jobs from that
queue.
- `"status"`: Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED,
or ERROR.
"""
function search_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"GET", "/2017-08-29/search"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"GET",
"/2017-08-29/search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})
Add tags to a MediaConvert queue, preset, or job template. For information about tagging,
see the User Guide at
https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the resource that you want to tag. To get the
ARN, send a GET request with the resource name.
- `tags`: The tags that you want to add to the resource. You can tag resources with a
key-value pair or with only a key.
"""
function tag_resource(arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"POST",
"/2017-08-29/tags",
Dict{String,Any}("arn" => arn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
arn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediaconvert(
"POST",
"/2017-08-29/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("arn" => arn, "tags" => tags), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(arn)
untag_resource(arn, params::Dict{String,<:Any})
Remove tags from a MediaConvert queue, preset, or job template. For information about
tagging, see the User Guide at
https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
To get the ARN, send a GET request with the resource name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tagKeys"`: The keys of the tags that you want to remove from the resource.
"""
function untag_resource(arn; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"PUT",
"/2017-08-29/tags/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"PUT",
"/2017-08-29/tags/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job_template(name)
update_job_template(name, params::Dict{String,<:Any})
Modify one of your existing job templates.
# Arguments
- `name`: The name of the job template you are modifying
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accelerationSettings"`: Accelerated transcoding can significantly speed up jobs with
long, visually complex content. Outputs that use this feature incur pro-tier pricing. For
information about feature limitations, see the AWS Elemental MediaConvert User Guide.
- `"category"`: The new category for the job template, if you are changing it.
- `"description"`: The new description for the job template, if you are changing it.
- `"hopDestinations"`: Optional list of hop destinations.
- `"priority"`: Specify the relative priority for this job. In any given queue, the service
begins processing the job with the highest value first. When more than one job has the same
priority, the service begins processing the job that you submitted first. If you don't
specify a priority, the service uses the default value 0.
- `"queue"`: The new queue for the job template, if you are changing it.
- `"settings"`: JobTemplateSettings contains all the transcode settings saved in the
template that will be applied to jobs created from it.
- `"statusUpdateInterval"`: Specify how often MediaConvert sends STATUS_UPDATE events to
Amazon CloudWatch Events. Set the interval, in seconds, between status updates.
MediaConvert sends an update at this interval from the time the service begins processing
your job to the time it completes the transcode or encounters an error.
"""
function update_job_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"PUT",
"/2017-08-29/jobTemplates/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"PUT",
"/2017-08-29/jobTemplates/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_preset(name)
update_preset(name, params::Dict{String,<:Any})
Modify one of your existing presets.
# Arguments
- `name`: The name of the preset you are modifying.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"category"`: The new category for the preset, if you are changing it.
- `"description"`: The new description for the preset, if you are changing it.
- `"settings"`: Settings for preset
"""
function update_preset(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"PUT",
"/2017-08-29/presets/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_preset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"PUT",
"/2017-08-29/presets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue(name)
update_queue(name, params::Dict{String,<:Any})
Modify one of your existing queues.
# Arguments
- `name`: The name of the queue that you are modifying.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new description for the queue, if you are changing it.
- `"reservationPlanSettings"`: The new details of your pricing plan for your reserved
queue. When you set up a new pricing plan to replace an expired one, you enter into another
12-month commitment. When you add capacity to your queue by increasing the number of RTS,
you extend the term of your commitment to 12 months from when you add capacity. After you
make these commitments, you can't cancel them.
- `"status"`: Pause or activate a queue by changing its status between ACTIVE and PAUSED.
If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause
the queue continue to run until they finish or result in an error.
"""
function update_queue(name; aws_config::AbstractAWSConfig=global_aws_config())
return mediaconvert(
"PUT",
"/2017-08-29/queues/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediaconvert(
"PUT",
"/2017-08-29/queues/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 102513 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: medialive
using AWS.Compat
using AWS.UUIDs
"""
accept_input_device_transfer(input_device_id)
accept_input_device_transfer(input_device_id, params::Dict{String,<:Any})
Accept an incoming input device transfer. The ownership of the device will transfer to your
AWS account.
# Arguments
- `input_device_id`: The unique ID of the input device to accept. For example,
hd-123456789abcdef.
"""
function accept_input_device_transfer(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/accept";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_input_device_transfer(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/accept",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete()
batch_delete(params::Dict{String,<:Any})
Starts delete of resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelIds"`: List of channel IDs
- `"inputIds"`: List of input IDs
- `"inputSecurityGroupIds"`: List of input security group IDs
- `"multiplexIds"`: List of multiplex IDs
"""
function batch_delete(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST", "/prod/batch/delete"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_delete(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/batch/delete",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_start()
batch_start(params::Dict{String,<:Any})
Starts existing resources
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelIds"`: List of channel IDs
- `"multiplexIds"`: List of multiplex IDs
"""
function batch_start(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST", "/prod/batch/start"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_start(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/batch/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_stop()
batch_stop(params::Dict{String,<:Any})
Stops running resources
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelIds"`: List of channel IDs
- `"multiplexIds"`: List of multiplex IDs
"""
function batch_stop(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST", "/prod/batch/stop"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_stop(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/batch/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_schedule(channel_id)
batch_update_schedule(channel_id, params::Dict{String,<:Any})
Update a channel schedule
# Arguments
- `channel_id`: Id of the channel whose schedule is being updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"creates"`: Schedule actions to create in the schedule.
- `"deletes"`: Schedule actions to delete from the schedule.
"""
function batch_update_schedule(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"PUT",
"/prod/channels/$(channelId)/schedule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_schedule(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/channels/$(channelId)/schedule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_input_device_transfer(input_device_id)
cancel_input_device_transfer(input_device_id, params::Dict{String,<:Any})
Cancel an input device transfer that you have requested.
# Arguments
- `input_device_id`: The unique ID of the input device to cancel. For example,
hd-123456789abcdef.
"""
function cancel_input_device_transfer(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_input_device_transfer(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
claim_device()
claim_device(params::Dict{String,<:Any})
Send a request to claim an AWS Elemental device that you have purchased from a third-party
vendor. After the request succeeds, you will own the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"id"`: The id of the device you want to claim.
"""
function claim_device(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST", "/prod/claimDevice"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function claim_device(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/claimDevice",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel()
create_channel(params::Dict{String,<:Any})
Creates a new channel
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cdiInputSpecification"`: Specification of CDI inputs for this channel
- `"channelClass"`: The class for this channel. STANDARD for a channel with two pipelines
or SINGLE_PIPELINE for a channel with one pipeline.
- `"destinations"`:
- `"encoderSettings"`:
- `"inputAttachments"`: List of input attachments for channel.
- `"inputSpecification"`: Specification of network and file inputs for this channel
- `"logLevel"`: The log level to write to CloudWatch Logs.
- `"maintenance"`: Maintenance settings for this channel.
- `"name"`: Name of channel.
- `"requestId"`: Unique request ID to be specified. This is needed to prevent retries
from
creating multiple resources.
- `"reserved"`: Deprecated field that's only usable by whitelisted customers.
- `"roleArn"`: An optional Amazon Resource Name (ARN) of the role to assume when running
the Channel.
- `"tags"`: A collection of key-value pairs.
- `"vpc"`: Settings for the VPC outputs
"""
function create_channel(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/channels",
Dict{String,Any}("requestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/channels",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestId" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cloud_watch_alarm_template(comparison_operator, evaluation_periods, group_identifier, metric_name, name, period, statistic, target_resource_type, threshold, treat_missing_data)
create_cloud_watch_alarm_template(comparison_operator, evaluation_periods, group_identifier, metric_name, name, period, statistic, target_resource_type, threshold, treat_missing_data, params::Dict{String,<:Any})
Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on
targeted resource types.
# Arguments
- `comparison_operator`:
- `evaluation_periods`: The number of periods over which data is compared to the specified
threshold.
- `group_identifier`: A cloudwatch alarm template group's identifier. Can be either be its
id or current name.
- `metric_name`: The name of the metric associated with the alarm. Must be compatible with
targetResourceType.
- `name`: A resource's name. Names must be unique within the scope of a resource type in a
specific region.
- `period`: The period, in seconds, over which the specified statistic is applied.
- `statistic`:
- `target_resource_type`:
- `threshold`: The threshold value to compare with the specified statistic.
- `treat_missing_data`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datapointsToAlarm"`: The number of datapoints within the evaluation period that must be
breaching to trigger the alarm.
- `"description"`: A resource's optional description.
- `"tags"`:
"""
function create_cloud_watch_alarm_template(
comparisonOperator,
evaluationPeriods,
groupIdentifier,
metricName,
name,
period,
statistic,
targetResourceType,
threshold,
treatMissingData;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/cloudwatch-alarm-templates",
Dict{String,Any}(
"comparisonOperator" => comparisonOperator,
"evaluationPeriods" => evaluationPeriods,
"groupIdentifier" => groupIdentifier,
"metricName" => metricName,
"name" => name,
"period" => period,
"statistic" => statistic,
"targetResourceType" => targetResourceType,
"threshold" => threshold,
"treatMissingData" => treatMissingData,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cloud_watch_alarm_template(
comparisonOperator,
evaluationPeriods,
groupIdentifier,
metricName,
name,
period,
statistic,
targetResourceType,
threshold,
treatMissingData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/cloudwatch-alarm-templates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"comparisonOperator" => comparisonOperator,
"evaluationPeriods" => evaluationPeriods,
"groupIdentifier" => groupIdentifier,
"metricName" => metricName,
"name" => name,
"period" => period,
"statistic" => statistic,
"targetResourceType" => targetResourceType,
"threshold" => threshold,
"treatMissingData" => treatMissingData,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cloud_watch_alarm_template_group(name)
create_cloud_watch_alarm_template_group(name, params::Dict{String,<:Any})
Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to
attach to signal maps for dynamically creating alarms.
# Arguments
- `name`: A resource's name. Names must be unique within the scope of a resource type in a
specific region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A resource's optional description.
- `"tags"`:
"""
function create_cloud_watch_alarm_template_group(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/cloudwatch-alarm-template-groups",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cloud_watch_alarm_template_group(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/cloudwatch-alarm-template-groups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_bridge_rule_template(event_type, group_identifier, name)
create_event_bridge_rule_template(event_type, group_identifier, name, params::Dict{String,<:Any})
Creates an eventbridge rule template to monitor events and send notifications to your
targeted resources.
# Arguments
- `event_type`:
- `group_identifier`: An eventbridge rule template group's identifier. Can be either be its
id or current name.
- `name`: A resource's name. Names must be unique within the scope of a resource type in a
specific region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A resource's optional description.
- `"eventTargets"`:
- `"tags"`:
"""
function create_event_bridge_rule_template(
eventType, groupIdentifier, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/eventbridge-rule-templates",
Dict{String,Any}(
"eventType" => eventType, "groupIdentifier" => groupIdentifier, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_bridge_rule_template(
eventType,
groupIdentifier,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/eventbridge-rule-templates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventType" => eventType,
"groupIdentifier" => groupIdentifier,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_bridge_rule_template_group(name)
create_event_bridge_rule_template_group(name, params::Dict{String,<:Any})
Creates an eventbridge rule template group to group your eventbridge rule templates and to
attach to signal maps for dynamically creating notification rules.
# Arguments
- `name`: A resource's name. Names must be unique within the scope of a resource type in a
specific region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A resource's optional description.
- `"tags"`:
"""
function create_event_bridge_rule_template_group(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/eventbridge-rule-template-groups",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_bridge_rule_template_group(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/eventbridge-rule-template-groups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_input()
create_input(params::Dict{String,<:Any})
Create an input
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinations"`: Destination settings for PUSH type inputs.
- `"inputDevices"`: Settings for the devices.
- `"inputSecurityGroups"`: A list of security groups referenced by IDs to attach to the
input.
- `"mediaConnectFlows"`: A list of the MediaConnect Flows that you want to use in this
input. You can specify as few as one
Flow and presently, as many as two. The only
requirement is when you have more than one is that each Flow is in a
separate Availability
Zone as this ensures your EML input is redundant to AZ issues.
- `"name"`: Name of the input.
- `"requestId"`: Unique identifier of the request to ensure the request is handled
exactly
once in case of retries.
- `"roleArn"`: The Amazon Resource Name (ARN) of the role this input assumes during and
after creation.
- `"sources"`: The source URLs for a PULL-type input. Every PULL type input needs
exactly
two source URLs for redundancy.
Only specify sources for PULL type Inputs. Leave
Destinations empty.
- `"tags"`: A collection of key-value pairs.
- `"type"`:
- `"vpc"`:
"""
function create_input(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/inputs",
Dict{String,Any}("requestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_input(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestId" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_input_security_group()
create_input_security_group(params::Dict{String,<:Any})
Creates a Input Security Group
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key-value pairs.
- `"whitelistRules"`: List of IPv4 CIDR addresses to whitelist
"""
function create_input_security_group(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/inputSecurityGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_input_security_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputSecurityGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_multiplex(availability_zones, multiplex_settings, name, request_id)
create_multiplex(availability_zones, multiplex_settings, name, request_id, params::Dict{String,<:Any})
Create a new multiplex.
# Arguments
- `availability_zones`: A list of availability zones for the multiplex. You must specify
exactly two.
- `multiplex_settings`: Configuration for a multiplex event.
- `name`: Name of multiplex.
- `request_id`: Unique request ID. This prevents retries from creating multiple
resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key-value pairs.
"""
function create_multiplex(
availabilityZones,
multiplexSettings,
name,
requestId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/multiplexes",
Dict{String,Any}(
"availabilityZones" => availabilityZones,
"multiplexSettings" => multiplexSettings,
"name" => name,
"requestId" => requestId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_multiplex(
availabilityZones,
multiplexSettings,
name,
requestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/multiplexes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZones" => availabilityZones,
"multiplexSettings" => multiplexSettings,
"name" => name,
"requestId" => requestId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_multiplex_program(multiplex_id, multiplex_program_settings, program_name, request_id)
create_multiplex_program(multiplex_id, multiplex_program_settings, program_name, request_id, params::Dict{String,<:Any})
Create a new program in the multiplex.
# Arguments
- `multiplex_id`: ID of the multiplex where the program is to be created.
- `multiplex_program_settings`: The settings for this multiplex program.
- `program_name`: Name of multiplex program.
- `request_id`: Unique request ID. This prevents retries from creating multiple
resources.
"""
function create_multiplex_program(
multiplexId,
multiplexProgramSettings,
programName,
requestId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/multiplexes/$(multiplexId)/programs",
Dict{String,Any}(
"multiplexProgramSettings" => multiplexProgramSettings,
"programName" => programName,
"requestId" => requestId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_multiplex_program(
multiplexId,
multiplexProgramSettings,
programName,
requestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/multiplexes/$(multiplexId)/programs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"multiplexProgramSettings" => multiplexProgramSettings,
"programName" => programName,
"requestId" => requestId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_partner_input(input_id)
create_partner_input(input_id, params::Dict{String,<:Any})
Create a partner input
# Arguments
- `input_id`: Unique ID of the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"requestId"`: Unique identifier of the request to ensure the request is handled
exactly
once in case of retries.
- `"tags"`: A collection of key-value pairs.
"""
function create_partner_input(inputId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/inputs/$(inputId)/partners",
Dict{String,Any}("requestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_partner_input(
inputId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputs/$(inputId)/partners",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestId" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_signal_map(discovery_entry_point_arn, name)
create_signal_map(discovery_entry_point_arn, name, params::Dict{String,<:Any})
Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on
the provided discoveryEntryPointArn.
# Arguments
- `discovery_entry_point_arn`: A top-level supported AWS resource ARN to discovery a signal
map from.
- `name`: A resource's name. Names must be unique within the scope of a resource type in a
specific region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cloudWatchAlarmTemplateGroupIdentifiers"`:
- `"description"`: A resource's optional description.
- `"eventBridgeRuleTemplateGroupIdentifiers"`:
- `"tags"`:
"""
function create_signal_map(
discoveryEntryPointArn, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/signal-maps",
Dict{String,Any}(
"discoveryEntryPointArn" => discoveryEntryPointArn, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_signal_map(
discoveryEntryPointArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/signal-maps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"discoveryEntryPointArn" => discoveryEntryPointArn, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tags(resource-arn)
create_tags(resource-arn, params::Dict{String,<:Any})
Create tags for a resource
# Arguments
- `resource-arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`:
"""
function create_tags(resource_arn; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tags(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel(channel_id)
delete_channel(channel_id, params::Dict{String,<:Any})
Starts deletion of channel. The associated outputs are also deleted.
# Arguments
- `channel_id`: Unique ID of the channel.
"""
function delete_channel(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"DELETE",
"/prod/channels/$(channelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/channels/$(channelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cloud_watch_alarm_template(identifier)
delete_cloud_watch_alarm_template(identifier, params::Dict{String,<:Any})
Deletes a cloudwatch alarm template.
# Arguments
- `identifier`: A cloudwatch alarm template's identifier. Can be either be its id or
current name.
"""
function delete_cloud_watch_alarm_template(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/cloudwatch-alarm-templates/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cloud_watch_alarm_template(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/cloudwatch-alarm-templates/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cloud_watch_alarm_template_group(identifier)
delete_cloud_watch_alarm_template_group(identifier, params::Dict{String,<:Any})
Deletes a cloudwatch alarm template group. You must detach this group from all signal maps
and ensure its existing templates are moved to another group or deleted.
# Arguments
- `identifier`: A cloudwatch alarm template group's identifier. Can be either be its id or
current name.
"""
function delete_cloud_watch_alarm_template_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/cloudwatch-alarm-template-groups/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cloud_watch_alarm_template_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/cloudwatch-alarm-template-groups/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_bridge_rule_template(identifier)
delete_event_bridge_rule_template(identifier, params::Dict{String,<:Any})
Deletes an eventbridge rule template.
# Arguments
- `identifier`: An eventbridge rule template's identifier. Can be either be its id or
current name.
"""
function delete_event_bridge_rule_template(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/eventbridge-rule-templates/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_bridge_rule_template(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/eventbridge-rule-templates/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_bridge_rule_template_group(identifier)
delete_event_bridge_rule_template_group(identifier, params::Dict{String,<:Any})
Deletes an eventbridge rule template group. You must detach this group from all signal maps
and ensure its existing templates are moved to another group or deleted.
# Arguments
- `identifier`: An eventbridge rule template group's identifier. Can be either be its id or
current name.
"""
function delete_event_bridge_rule_template_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/eventbridge-rule-template-groups/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_bridge_rule_template_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/eventbridge-rule-template-groups/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_input(input_id)
delete_input(input_id, params::Dict{String,<:Any})
Deletes the input end point
# Arguments
- `input_id`: Unique ID of the input
"""
function delete_input(inputId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"DELETE",
"/prod/inputs/$(inputId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_input(
inputId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/inputs/$(inputId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_input_security_group(input_security_group_id)
delete_input_security_group(input_security_group_id, params::Dict{String,<:Any})
Deletes an Input Security Group
# Arguments
- `input_security_group_id`: The Input Security Group to delete
"""
function delete_input_security_group(
inputSecurityGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/inputSecurityGroups/$(inputSecurityGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_input_security_group(
inputSecurityGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/inputSecurityGroups/$(inputSecurityGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_multiplex(multiplex_id)
delete_multiplex(multiplex_id, params::Dict{String,<:Any})
Delete a multiplex. The multiplex must be idle.
# Arguments
- `multiplex_id`: The ID of the multiplex.
"""
function delete_multiplex(multiplexId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"DELETE",
"/prod/multiplexes/$(multiplexId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_multiplex(
multiplexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/multiplexes/$(multiplexId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_multiplex_program(multiplex_id, program_name)
delete_multiplex_program(multiplex_id, program_name, params::Dict{String,<:Any})
Delete a program from a multiplex.
# Arguments
- `multiplex_id`: The ID of the multiplex that the program belongs to.
- `program_name`: The multiplex program name.
"""
function delete_multiplex_program(
multiplexId, programName; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/multiplexes/$(multiplexId)/programs/$(programName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_multiplex_program(
multiplexId,
programName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/multiplexes/$(multiplexId)/programs/$(programName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_reservation(reservation_id)
delete_reservation(reservation_id, params::Dict{String,<:Any})
Delete an expired reservation.
# Arguments
- `reservation_id`: Unique reservation ID, e.g. '1234567'
"""
function delete_reservation(
reservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/reservations/$(reservationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_reservation(
reservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/reservations/$(reservationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schedule(channel_id)
delete_schedule(channel_id, params::Dict{String,<:Any})
Delete all schedule actions on a channel.
# Arguments
- `channel_id`: Id of the channel whose schedule is being deleted.
"""
function delete_schedule(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"DELETE",
"/prod/channels/$(channelId)/schedule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schedule(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/channels/$(channelId)/schedule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_signal_map(identifier)
delete_signal_map(identifier, params::Dict{String,<:Any})
Deletes the specified signal map.
# Arguments
- `identifier`: A signal map's identifier. Can be either be its id or current name.
"""
function delete_signal_map(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"DELETE",
"/prod/signal-maps/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_signal_map(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/signal-maps/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(resource-arn, tag_keys)
delete_tags(resource-arn, tag_keys, params::Dict{String,<:Any})
Removes tags for a resource
# Arguments
- `resource-arn`:
- `tag_keys`: An array of tag keys to delete
"""
function delete_tags(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/tags/$(resource-arn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
resource_arn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_configuration()
describe_account_configuration(params::Dict{String,<:Any})
Describe account configuration
"""
function describe_account_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/accountConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/accountConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_channel(channel_id)
describe_channel(channel_id, params::Dict{String,<:Any})
Gets details about a channel
# Arguments
- `channel_id`: channel ID
"""
function describe_channel(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/channels/$(channelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_channel(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/channels/$(channelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_input(input_id)
describe_input(input_id, params::Dict{String,<:Any})
Produces details about an input
# Arguments
- `input_id`: Unique ID of the input
"""
function describe_input(inputId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/inputs/$(inputId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_input(
inputId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputs/$(inputId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_input_device(input_device_id)
describe_input_device(input_device_id, params::Dict{String,<:Any})
Gets the details for the input device
# Arguments
- `input_device_id`: The unique ID of this input device. For example, hd-123456789abcdef.
"""
function describe_input_device(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputDevices/$(inputDeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_input_device(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/inputDevices/$(inputDeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_input_device_thumbnail(accept, input_device_id)
describe_input_device_thumbnail(accept, input_device_id, params::Dict{String,<:Any})
Get the latest thumbnail data for the input device.
# Arguments
- `accept`: The HTTP Accept header. Indicates the requested type for the thumbnail.
- `input_device_id`: The unique ID of this input device. For example, hd-123456789abcdef.
"""
function describe_input_device_thumbnail(
accept, inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputDevices/$(inputDeviceId)/thumbnailData",
Dict{String,Any}("headers" => Dict{String,Any}("accept" => accept));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_input_device_thumbnail(
accept,
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/inputDevices/$(inputDeviceId)/thumbnailData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("headers" => Dict{String,Any}("accept" => accept)),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_input_security_group(input_security_group_id)
describe_input_security_group(input_security_group_id, params::Dict{String,<:Any})
Produces a summary of an Input Security Group
# Arguments
- `input_security_group_id`: The id of the Input Security Group to describe
"""
function describe_input_security_group(
inputSecurityGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputSecurityGroups/$(inputSecurityGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_input_security_group(
inputSecurityGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/inputSecurityGroups/$(inputSecurityGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_multiplex(multiplex_id)
describe_multiplex(multiplex_id, params::Dict{String,<:Any})
Gets details about a multiplex.
# Arguments
- `multiplex_id`: The ID of the multiplex.
"""
function describe_multiplex(multiplexId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/multiplexes/$(multiplexId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_multiplex(
multiplexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/multiplexes/$(multiplexId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_multiplex_program(multiplex_id, program_name)
describe_multiplex_program(multiplex_id, program_name, params::Dict{String,<:Any})
Get the details for a program in a multiplex.
# Arguments
- `multiplex_id`: The ID of the multiplex that the program belongs to.
- `program_name`: The name of the program.
"""
function describe_multiplex_program(
multiplexId, programName; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/multiplexes/$(multiplexId)/programs/$(programName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_multiplex_program(
multiplexId,
programName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/multiplexes/$(multiplexId)/programs/$(programName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_offering(offering_id)
describe_offering(offering_id, params::Dict{String,<:Any})
Get details for an offering.
# Arguments
- `offering_id`: Unique offering ID, e.g. '87654321'
"""
function describe_offering(offeringId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/offerings/$(offeringId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_offering(
offeringId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/offerings/$(offeringId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reservation(reservation_id)
describe_reservation(reservation_id, params::Dict{String,<:Any})
Get details for a reservation.
# Arguments
- `reservation_id`: Unique reservation ID, e.g. '1234567'
"""
function describe_reservation(
reservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/reservations/$(reservationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reservation(
reservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/reservations/$(reservationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_schedule(channel_id)
describe_schedule(channel_id, params::Dict{String,<:Any})
Get a channel schedule
# Arguments
- `channel_id`: Id of the channel whose schedule is being updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function describe_schedule(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/channels/$(channelId)/schedule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_schedule(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/channels/$(channelId)/schedule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_thumbnails(channel_id, pipeline_id, thumbnail_type)
describe_thumbnails(channel_id, pipeline_id, thumbnail_type, params::Dict{String,<:Any})
Describe the latest thumbnails data.
# Arguments
- `channel_id`: Unique ID of the channel
- `pipeline_id`: Pipeline ID (\"0\" or \"1\")
- `thumbnail_type`: thumbnail type
"""
function describe_thumbnails(
channelId, pipelineId, thumbnailType; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/channels/$(channelId)/thumbnails",
Dict{String,Any}("pipelineId" => pipelineId, "thumbnailType" => thumbnailType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_thumbnails(
channelId,
pipelineId,
thumbnailType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/channels/$(channelId)/thumbnails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"pipelineId" => pipelineId, "thumbnailType" => thumbnailType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cloud_watch_alarm_template(identifier)
get_cloud_watch_alarm_template(identifier, params::Dict{String,<:Any})
Retrieves the specified cloudwatch alarm template.
# Arguments
- `identifier`: A cloudwatch alarm template's identifier. Can be either be its id or
current name.
"""
function get_cloud_watch_alarm_template(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-templates/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cloud_watch_alarm_template(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-templates/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cloud_watch_alarm_template_group(identifier)
get_cloud_watch_alarm_template_group(identifier, params::Dict{String,<:Any})
Retrieves the specified cloudwatch alarm template group.
# Arguments
- `identifier`: A cloudwatch alarm template group's identifier. Can be either be its id or
current name.
"""
function get_cloud_watch_alarm_template_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-template-groups/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cloud_watch_alarm_template_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-template-groups/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_bridge_rule_template(identifier)
get_event_bridge_rule_template(identifier, params::Dict{String,<:Any})
Retrieves the specified eventbridge rule template.
# Arguments
- `identifier`: An eventbridge rule template's identifier. Can be either be its id or
current name.
"""
function get_event_bridge_rule_template(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/eventbridge-rule-templates/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_bridge_rule_template(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/eventbridge-rule-templates/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_bridge_rule_template_group(identifier)
get_event_bridge_rule_template_group(identifier, params::Dict{String,<:Any})
Retrieves the specified eventbridge rule template group.
# Arguments
- `identifier`: An eventbridge rule template group's identifier. Can be either be its id or
current name.
"""
function get_event_bridge_rule_template_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/eventbridge-rule-template-groups/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_bridge_rule_template_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/eventbridge-rule-template-groups/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signal_map(identifier)
get_signal_map(identifier, params::Dict{String,<:Any})
Retrieves the specified signal map.
# Arguments
- `identifier`: A signal map's identifier. Can be either be its id or current name.
"""
function get_signal_map(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/signal-maps/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_signal_map(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/signal-maps/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channels()
list_channels(params::Dict{String,<:Any})
Produces list of channels that have been created
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function list_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/channels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/channels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cloud_watch_alarm_template_groups()
list_cloud_watch_alarm_template_groups(params::Dict{String,<:Any})
Lists cloudwatch alarm template groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: A token used to retrieve the next set of results in paginated list
responses.
- `"scope"`: Represents the scope of a resource, with options for all scopes, AWS provided
resources, or local resources.
- `"signalMapIdentifier"`: A signal map's identifier. Can be either be its id or current
name.
"""
function list_cloud_watch_alarm_template_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-template-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cloud_watch_alarm_template_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-template-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cloud_watch_alarm_templates()
list_cloud_watch_alarm_templates(params::Dict{String,<:Any})
Lists cloudwatch alarm templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groupIdentifier"`: A cloudwatch alarm template group's identifier. Can be either be its
id or current name.
- `"maxResults"`:
- `"nextToken"`: A token used to retrieve the next set of results in paginated list
responses.
- `"scope"`: Represents the scope of a resource, with options for all scopes, AWS provided
resources, or local resources.
- `"signalMapIdentifier"`: A signal map's identifier. Can be either be its id or current
name.
"""
function list_cloud_watch_alarm_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cloud_watch_alarm_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/cloudwatch-alarm-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_bridge_rule_template_groups()
list_event_bridge_rule_template_groups(params::Dict{String,<:Any})
Lists eventbridge rule template groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: A token used to retrieve the next set of results in paginated list
responses.
- `"signalMapIdentifier"`: A signal map's identifier. Can be either be its id or current
name.
"""
function list_event_bridge_rule_template_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/eventbridge-rule-template-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_event_bridge_rule_template_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/eventbridge-rule-template-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_bridge_rule_templates()
list_event_bridge_rule_templates(params::Dict{String,<:Any})
Lists eventbridge rule templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groupIdentifier"`: An eventbridge rule template group's identifier. Can be either be
its id or current name.
- `"maxResults"`:
- `"nextToken"`: A token used to retrieve the next set of results in paginated list
responses.
- `"signalMapIdentifier"`: A signal map's identifier. Can be either be its id or current
name.
"""
function list_event_bridge_rule_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/eventbridge-rule-templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_event_bridge_rule_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/eventbridge-rule-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_input_device_transfers(transfer_type)
list_input_device_transfers(transfer_type, params::Dict{String,<:Any})
List input devices that are currently being transferred. List input devices that you are
transferring from your AWS account or input devices that another AWS account is
transferring to you.
# Arguments
- `transfer_type`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function list_input_device_transfers(
transferType; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputDeviceTransfers",
Dict{String,Any}("transferType" => transferType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_input_device_transfers(
transferType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/inputDeviceTransfers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("transferType" => transferType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_input_devices()
list_input_devices(params::Dict{String,<:Any})
List input devices
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function list_input_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/inputDevices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_input_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputDevices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_input_security_groups()
list_input_security_groups(params::Dict{String,<:Any})
Produces a list of Input Security Groups for an account
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function list_input_security_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET",
"/prod/inputSecurityGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_input_security_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputSecurityGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inputs()
list_inputs(params::Dict{String,<:Any})
Produces list of inputs that have been created
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function list_inputs(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/inputs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_inputs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/inputs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multiplex_programs(multiplex_id)
list_multiplex_programs(multiplex_id, params::Dict{String,<:Any})
List the programs that currently exist for a specific multiplex.
# Arguments
- `multiplex_id`: The ID of the multiplex that the programs belong to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return.
- `"nextToken"`: The token to retrieve the next page of results.
"""
function list_multiplex_programs(
multiplexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/multiplexes/$(multiplexId)/programs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_multiplex_programs(
multiplexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/multiplexes/$(multiplexId)/programs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multiplexes()
list_multiplexes(params::Dict{String,<:Any})
Retrieve a list of the existing multiplexes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return.
- `"nextToken"`: The token to retrieve the next page of results.
"""
function list_multiplexes(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/multiplexes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_multiplexes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/multiplexes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_offerings()
list_offerings(params::Dict{String,<:Any})
List offerings available for purchase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelClass"`: Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
- `"channelConfiguration"`: Filter to offerings that match the configuration of an existing
channel, e.g. '2345678' (a channel ID)
- `"codec"`: Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
- `"duration"`: Filter by offering duration, e.g. '12'
- `"maxResults"`:
- `"maximumBitrate"`: Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
- `"maximumFramerate"`: Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
- `"nextToken"`:
- `"resolution"`: Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
- `"resourceType"`: Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
- `"specialFeature"`: Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
- `"videoQuality"`: Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
"""
function list_offerings(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/offerings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/offerings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_reservations()
list_reservations(params::Dict{String,<:Any})
List purchased reservations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelClass"`: Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
- `"codec"`: Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
- `"maxResults"`:
- `"maximumBitrate"`: Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
- `"maximumFramerate"`: Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
- `"nextToken"`:
- `"resolution"`: Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
- `"resourceType"`: Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
- `"specialFeature"`: Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
- `"videoQuality"`: Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
"""
function list_reservations(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/reservations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_reservations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/reservations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signal_maps()
list_signal_maps(params::Dict{String,<:Any})
Lists signal maps.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cloudWatchAlarmTemplateGroupIdentifier"`: A cloudwatch alarm template group's
identifier. Can be either be its id or current name.
- `"eventBridgeRuleTemplateGroupIdentifier"`: An eventbridge rule template group's
identifier. Can be either be its id or current name.
- `"maxResults"`:
- `"nextToken"`: A token used to retrieve the next set of results in paginated list
responses.
"""
function list_signal_maps(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"GET", "/prod/signal-maps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_signal_maps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/signal-maps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})
Produces list of tags that have been created for a resource
# Arguments
- `resource-arn`:
"""
function list_tags_for_resource(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"GET",
"/prod/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"GET",
"/prod/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_offering(count, offering_id)
purchase_offering(count, offering_id, params::Dict{String,<:Any})
Purchase an offering and create a reservation.
# Arguments
- `count`: Number of resources
- `offering_id`: Offering to purchase, e.g. '87654321'
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Name for the new reservation
- `"renewalSettings"`: Renewal settings for the reservation
- `"requestId"`: Unique request ID to be specified. This is needed to prevent retries from
creating multiple resources.
- `"start"`: Requested reservation start time (UTC) in ISO-8601 format. The specified time
must be between the first day of the current month and one year from now. If no value is
given, the default is now.
- `"tags"`: A collection of key-value pairs
"""
function purchase_offering(
count, offeringId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/offerings/$(offeringId)/purchase",
Dict{String,Any}("count" => count, "requestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_offering(
count,
offeringId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/offerings/$(offeringId)/purchase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("count" => count, "requestId" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_input_device(input_device_id)
reboot_input_device(input_device_id, params::Dict{String,<:Any})
Send a reboot command to the specified input device. The device will begin rebooting within
a few seconds of sending the command. When the reboot is complete, the device’s
connection status will change to connected.
# Arguments
- `input_device_id`: The unique ID of the input device to reboot. For example,
hd-123456789abcdef.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: Force a reboot of an input device. If the device is streaming, it will stop
streaming and begin rebooting within a few seconds of sending the command. If the device
was streaming prior to the reboot, the device will resume streaming when the reboot
completes.
"""
function reboot_input_device(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/reboot";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_input_device(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/reboot",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_input_device_transfer(input_device_id)
reject_input_device_transfer(input_device_id, params::Dict{String,<:Any})
Reject the transfer of the specified input device to your AWS account.
# Arguments
- `input_device_id`: The unique ID of the input device to reject. For example,
hd-123456789abcdef.
"""
function reject_input_device_transfer(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/reject";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_input_device_transfer(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/reject",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restart_channel_pipelines(channel_id)
restart_channel_pipelines(channel_id, params::Dict{String,<:Any})
Restart pipelines in one channel that is currently running.
# Arguments
- `channel_id`: ID of channel
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"pipelineIds"`: An array of pipelines to restart in this channel. Format PIPELINE_0 or
PIPELINE_1.
"""
function restart_channel_pipelines(
channelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/channels/$(channelId)/restartChannelPipelines";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restart_channel_pipelines(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/channels/$(channelId)/restartChannelPipelines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_channel(channel_id)
start_channel(channel_id, params::Dict{String,<:Any})
Starts an existing channel
# Arguments
- `channel_id`: A request to start a channel
"""
function start_channel(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/channels/$(channelId)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_channel(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/channels/$(channelId)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_delete_monitor_deployment(identifier)
start_delete_monitor_deployment(identifier, params::Dict{String,<:Any})
Initiates a deployment to delete the monitor of the specified signal map.
# Arguments
- `identifier`: A signal map's identifier. Can be either be its id or current name.
"""
function start_delete_monitor_deployment(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"DELETE",
"/prod/signal-maps/$(identifier)/monitor-deployment";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_delete_monitor_deployment(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"DELETE",
"/prod/signal-maps/$(identifier)/monitor-deployment",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_input_device(input_device_id)
start_input_device(input_device_id, params::Dict{String,<:Any})
Start an input device that is attached to a MediaConnect flow. (There is no need to start a
device that is attached to a MediaLive input; MediaLive starts the device when the channel
starts.)
# Arguments
- `input_device_id`: The unique ID of the input device to start. For example,
hd-123456789abcdef.
"""
function start_input_device(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_input_device(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_input_device_maintenance_window(input_device_id)
start_input_device_maintenance_window(input_device_id, params::Dict{String,<:Any})
Start a maintenance window for the specified input device. Starting a maintenance window
will give the device up to two hours to install software. If the device was streaming prior
to the maintenance, it will resume streaming when the software is fully installed. Devices
automatically install updates while they are powered on and their MediaLive channels are
stopped. A maintenance window allows you to update a device without having to stop
MediaLive channels that use the device. The device must remain powered on and connected to
the internet for the duration of the maintenance.
# Arguments
- `input_device_id`: The unique ID of the input device to start a maintenance window for.
For example, hd-123456789abcdef.
"""
function start_input_device_maintenance_window(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/startInputDeviceMaintenanceWindow";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_input_device_maintenance_window(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/startInputDeviceMaintenanceWindow",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_monitor_deployment(identifier)
start_monitor_deployment(identifier, params::Dict{String,<:Any})
Initiates a deployment to deploy the latest monitor of the specified signal map.
# Arguments
- `identifier`: A signal map's identifier. Can be either be its id or current name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dryRun"`:
"""
function start_monitor_deployment(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/signal-maps/$(identifier)/monitor-deployment";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_monitor_deployment(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/signal-maps/$(identifier)/monitor-deployment",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_multiplex(multiplex_id)
start_multiplex(multiplex_id, params::Dict{String,<:Any})
Start (run) the multiplex. Starting the multiplex does not start the channels. You must
explicitly start each channel.
# Arguments
- `multiplex_id`: The ID of the multiplex.
"""
function start_multiplex(multiplexId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/multiplexes/$(multiplexId)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_multiplex(
multiplexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/multiplexes/$(multiplexId)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_update_signal_map(identifier)
start_update_signal_map(identifier, params::Dict{String,<:Any})
Initiates an update for the specified signal map. Will discover a new signal map if a
changed discoveryEntryPointArn is provided.
# Arguments
- `identifier`: A signal map's identifier. Can be either be its id or current name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cloudWatchAlarmTemplateGroupIdentifiers"`:
- `"description"`: A resource's optional description.
- `"discoveryEntryPointArn"`: A top-level supported AWS resource ARN to discovery a signal
map from.
- `"eventBridgeRuleTemplateGroupIdentifiers"`:
- `"forceRediscovery"`: If true, will force a rediscovery of a signal map if an unchanged
discoveryEntryPointArn is provided.
- `"name"`: A resource's name. Names must be unique within the scope of a resource type in
a specific region.
"""
function start_update_signal_map(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PATCH",
"/prod/signal-maps/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_update_signal_map(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PATCH",
"/prod/signal-maps/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_channel(channel_id)
stop_channel(channel_id, params::Dict{String,<:Any})
Stops a running channel
# Arguments
- `channel_id`: A request to stop a running channel
"""
function stop_channel(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/channels/$(channelId)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_channel(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/channels/$(channelId)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_input_device(input_device_id)
stop_input_device(input_device_id, params::Dict{String,<:Any})
Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a
device that is attached to a MediaLive input; MediaLive automatically stops the device when
the channel stops.)
# Arguments
- `input_device_id`: The unique ID of the input device to stop. For example,
hd-123456789abcdef.
"""
function stop_input_device(inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_input_device(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_multiplex(multiplex_id)
stop_multiplex(multiplex_id, params::Dict{String,<:Any})
Stops a running multiplex. If the multiplex isn't running, this action has no effect.
# Arguments
- `multiplex_id`: The ID of the multiplex.
"""
function stop_multiplex(multiplexId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"POST",
"/prod/multiplexes/$(multiplexId)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_multiplex(
multiplexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/multiplexes/$(multiplexId)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transfer_input_device(input_device_id)
transfer_input_device(input_device_id, params::Dict{String,<:Any})
Start an input device transfer to another AWS account. After you make the request, the
other account must accept or reject the transfer.
# Arguments
- `input_device_id`: The unique ID of this input device. For example, hd-123456789abcdef.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"targetCustomerId"`: The AWS account ID (12 digits) for the recipient of the device
transfer.
- `"targetRegion"`: The target AWS region to transfer the device.
- `"transferMessage"`: An optional message for the recipient. Maximum 280 characters.
"""
function transfer_input_device(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/transfer";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transfer_input_device(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"POST",
"/prod/inputDevices/$(inputDeviceId)/transfer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_configuration()
update_account_configuration(params::Dict{String,<:Any})
Update account configuration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountConfiguration"`:
"""
function update_account_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"PUT",
"/prod/accountConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/accountConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel(channel_id)
update_channel(channel_id, params::Dict{String,<:Any})
Updates a channel.
# Arguments
- `channel_id`: channel ID
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cdiInputSpecification"`: Specification of CDI inputs for this channel
- `"destinations"`: A list of output destinations for this channel.
- `"encoderSettings"`: The encoder settings for this channel.
- `"inputAttachments"`:
- `"inputSpecification"`: Specification of network and file inputs for this channel
- `"logLevel"`: The log level to write to CloudWatch Logs.
- `"maintenance"`: Maintenance settings for this channel.
- `"name"`: The name of the channel.
- `"roleArn"`: An optional Amazon Resource Name (ARN) of the role to assume when running
the Channel. If you do not specify this on an update call but the role was previously set
that role will be removed.
"""
function update_channel(channelId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"PUT",
"/prod/channels/$(channelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel(
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/channels/$(channelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel_class(channel_class, channel_id)
update_channel_class(channel_class, channel_id, params::Dict{String,<:Any})
Changes the class of the channel.
# Arguments
- `channel_class`: The channel class that you wish to update this channel to use.
- `channel_id`: Channel Id of the channel whose class should be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinations"`: A list of output destinations for this channel.
"""
function update_channel_class(
channelClass, channelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/channels/$(channelId)/channelClass",
Dict{String,Any}("channelClass" => channelClass);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel_class(
channelClass,
channelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/channels/$(channelId)/channelClass",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelClass" => channelClass), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cloud_watch_alarm_template(identifier)
update_cloud_watch_alarm_template(identifier, params::Dict{String,<:Any})
Updates the specified cloudwatch alarm template.
# Arguments
- `identifier`: A cloudwatch alarm template's identifier. Can be either be its id or
current name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"comparisonOperator"`:
- `"datapointsToAlarm"`: The number of datapoints within the evaluation period that must be
breaching to trigger the alarm.
- `"description"`: A resource's optional description.
- `"evaluationPeriods"`: The number of periods over which data is compared to the specified
threshold.
- `"groupIdentifier"`: A cloudwatch alarm template group's identifier. Can be either be its
id or current name.
- `"metricName"`: The name of the metric associated with the alarm. Must be compatible with
targetResourceType.
- `"name"`: A resource's name. Names must be unique within the scope of a resource type in
a specific region.
- `"period"`: The period, in seconds, over which the specified statistic is applied.
- `"statistic"`:
- `"targetResourceType"`:
- `"threshold"`: The threshold value to compare with the specified statistic.
- `"treatMissingData"`:
"""
function update_cloud_watch_alarm_template(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PATCH",
"/prod/cloudwatch-alarm-templates/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cloud_watch_alarm_template(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PATCH",
"/prod/cloudwatch-alarm-templates/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cloud_watch_alarm_template_group(identifier)
update_cloud_watch_alarm_template_group(identifier, params::Dict{String,<:Any})
Updates the specified cloudwatch alarm template group.
# Arguments
- `identifier`: A cloudwatch alarm template group's identifier. Can be either be its id or
current name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A resource's optional description.
"""
function update_cloud_watch_alarm_template_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PATCH",
"/prod/cloudwatch-alarm-template-groups/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cloud_watch_alarm_template_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PATCH",
"/prod/cloudwatch-alarm-template-groups/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_bridge_rule_template(identifier)
update_event_bridge_rule_template(identifier, params::Dict{String,<:Any})
Updates the specified eventbridge rule template.
# Arguments
- `identifier`: An eventbridge rule template's identifier. Can be either be its id or
current name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A resource's optional description.
- `"eventTargets"`:
- `"eventType"`:
- `"groupIdentifier"`: An eventbridge rule template group's identifier. Can be either be
its id or current name.
- `"name"`: A resource's name. Names must be unique within the scope of a resource type in
a specific region.
"""
function update_event_bridge_rule_template(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PATCH",
"/prod/eventbridge-rule-templates/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_bridge_rule_template(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PATCH",
"/prod/eventbridge-rule-templates/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_bridge_rule_template_group(identifier)
update_event_bridge_rule_template_group(identifier, params::Dict{String,<:Any})
Updates the specified eventbridge rule template group.
# Arguments
- `identifier`: An eventbridge rule template group's identifier. Can be either be its id or
current name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A resource's optional description.
"""
function update_event_bridge_rule_template_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PATCH",
"/prod/eventbridge-rule-template-groups/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_bridge_rule_template_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PATCH",
"/prod/eventbridge-rule-template-groups/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_input(input_id)
update_input(input_id, params::Dict{String,<:Any})
Updates an input.
# Arguments
- `input_id`: Unique ID of the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinations"`: Destination settings for PUSH type inputs.
- `"inputDevices"`: Settings for the devices.
- `"inputSecurityGroups"`: A list of security groups referenced by IDs to attach to the
input.
- `"mediaConnectFlows"`: A list of the MediaConnect Flow ARNs that you want to use as the
source of the input. You can specify as few as one
Flow and presently, as many as two. The
only requirement is when you have more than one is that each Flow is in a
separate
Availability Zone as this ensures your EML input is redundant to AZ issues.
- `"name"`: Name of the input.
- `"roleArn"`: The Amazon Resource Name (ARN) of the role this input assumes during and
after creation.
- `"sources"`: The source URLs for a PULL-type input. Every PULL type input needs
exactly
two source URLs for redundancy.
Only specify sources for PULL type Inputs. Leave
Destinations empty.
"""
function update_input(inputId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"PUT",
"/prod/inputs/$(inputId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_input(
inputId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/inputs/$(inputId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_input_device(input_device_id)
update_input_device(input_device_id, params::Dict{String,<:Any})
Updates the parameters for the input device.
# Arguments
- `input_device_id`: The unique ID of the input device. For example, hd-123456789abcdef.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"availabilityZone"`: The Availability Zone you want associated with this input device.
- `"hdDeviceSettings"`: The settings that you want to apply to the HD input device.
- `"name"`: The name that you assigned to this input device (not the unique ID).
- `"uhdDeviceSettings"`: The settings that you want to apply to the UHD input device.
"""
function update_input_device(
inputDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/inputDevices/$(inputDeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_input_device(
inputDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/inputDevices/$(inputDeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_input_security_group(input_security_group_id)
update_input_security_group(input_security_group_id, params::Dict{String,<:Any})
Update an Input Security Group's Whilelists.
# Arguments
- `input_security_group_id`: The id of the Input Security Group to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key-value pairs.
- `"whitelistRules"`: List of IPv4 CIDR addresses to whitelist
"""
function update_input_security_group(
inputSecurityGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/inputSecurityGroups/$(inputSecurityGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_input_security_group(
inputSecurityGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/inputSecurityGroups/$(inputSecurityGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_multiplex(multiplex_id)
update_multiplex(multiplex_id, params::Dict{String,<:Any})
Updates a multiplex.
# Arguments
- `multiplex_id`: ID of the multiplex to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"multiplexSettings"`: The new settings for a multiplex.
- `"name"`: Name of the multiplex.
"""
function update_multiplex(multiplexId; aws_config::AbstractAWSConfig=global_aws_config())
return medialive(
"PUT",
"/prod/multiplexes/$(multiplexId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_multiplex(
multiplexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/multiplexes/$(multiplexId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_multiplex_program(multiplex_id, program_name)
update_multiplex_program(multiplex_id, program_name, params::Dict{String,<:Any})
Update a program in a multiplex.
# Arguments
- `multiplex_id`: The ID of the multiplex of the program to update.
- `program_name`: The name of the program to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"multiplexProgramSettings"`: The new settings for a multiplex program.
"""
function update_multiplex_program(
multiplexId, programName; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/multiplexes/$(multiplexId)/programs/$(programName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_multiplex_program(
multiplexId,
programName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/multiplexes/$(multiplexId)/programs/$(programName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_reservation(reservation_id)
update_reservation(reservation_id, params::Dict{String,<:Any})
Update reservation.
# Arguments
- `reservation_id`: Unique reservation ID, e.g. '1234567'
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Name of the reservation
- `"renewalSettings"`: Renewal settings for the reservation
"""
function update_reservation(
reservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medialive(
"PUT",
"/prod/reservations/$(reservationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_reservation(
reservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medialive(
"PUT",
"/prod/reservations/$(reservationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 20094 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediapackage
using AWS.Compat
using AWS.UUIDs
"""
configure_logs(id)
configure_logs(id, params::Dict{String,<:Any})
Changes the Channel's properities to configure log subscription
# Arguments
- `id`: The ID of the channel to log subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"egressAccessLogs"`:
- `"ingressAccessLogs"`:
"""
function configure_logs(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"PUT",
"/channels/$(id)/configure_logs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_logs(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"PUT",
"/channels/$(id)/configure_logs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel(id)
create_channel(id, params::Dict{String,<:Any})
Creates a new Channel.
# Arguments
- `id`: The ID of the Channel. The ID must be unique within the region and it
cannot be
changed after a Channel is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A short text description of the Channel.
- `"tags"`:
"""
function create_channel(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"POST",
"/channels",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"POST",
"/channels",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_harvest_job(end_time, id, origin_endpoint_id, s3_destination, start_time)
create_harvest_job(end_time, id, origin_endpoint_id, s3_destination, start_time, params::Dict{String,<:Any})
Creates a new HarvestJob record.
# Arguments
- `end_time`: The end of the time-window which will be harvested
- `id`: The ID of the HarvestJob. The ID must be unique within the region
and it cannot be
changed after the HarvestJob is submitted
- `origin_endpoint_id`: The ID of the OriginEndpoint that the HarvestJob will harvest
from.
This cannot be changed after the HarvestJob is submitted.
- `s3_destination`:
- `start_time`: The start of the time-window which will be harvested
"""
function create_harvest_job(
endTime,
id,
originEndpointId,
s3Destination,
startTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"POST",
"/harvest_jobs",
Dict{String,Any}(
"endTime" => endTime,
"id" => id,
"originEndpointId" => originEndpointId,
"s3Destination" => s3Destination,
"startTime" => startTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_harvest_job(
endTime,
id,
originEndpointId,
s3Destination,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"POST",
"/harvest_jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"id" => id,
"originEndpointId" => originEndpointId,
"s3Destination" => s3Destination,
"startTime" => startTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_origin_endpoint(channel_id, id)
create_origin_endpoint(channel_id, id, params::Dict{String,<:Any})
Creates a new OriginEndpoint record.
# Arguments
- `channel_id`: The ID of the Channel that the OriginEndpoint will be associated with.
This
cannot be changed after the OriginEndpoint is created.
- `id`: The ID of the OriginEndpoint. The ID must be unique within the region
and it
cannot be changed after the OriginEndpoint is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorization"`:
- `"cmafPackage"`:
- `"dashPackage"`:
- `"description"`: A short text description of the OriginEndpoint.
- `"hlsPackage"`:
- `"manifestName"`: A short string that will be used as the filename of the OriginEndpoint
URL (defaults to \"index\").
- `"mssPackage"`:
- `"origination"`: Control whether origination of video is allowed for this OriginEndpoint.
If set to ALLOW, the OriginEndpoint
may by requested, pursuant to any other form of access
control. If set to DENY, the OriginEndpoint may not be
requested. This can be helpful for
Live to VOD harvesting, or for temporarily disabling origination
- `"startoverWindowSeconds"`: Maximum duration (seconds) of content to retain for startover
playback.
If not specified, startover playback will be disabled for the OriginEndpoint.
- `"tags"`:
- `"timeDelaySeconds"`: Amount of delay (seconds) to enforce on the playback of live
content.
If not specified, there will be no time delay in effect for the OriginEndpoint.
- `"whitelist"`: A list of source IP CIDR blocks that will be allowed to access the
OriginEndpoint.
"""
function create_origin_endpoint(
channelId, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"POST",
"/origin_endpoints",
Dict{String,Any}("channelId" => channelId, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_origin_endpoint(
channelId,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"POST",
"/origin_endpoints",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("channelId" => channelId, "id" => id), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel(id)
delete_channel(id, params::Dict{String,<:Any})
Deletes an existing Channel.
# Arguments
- `id`: The ID of the Channel to delete.
"""
function delete_channel(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"DELETE", "/channels/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_channel(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"DELETE",
"/channels/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_origin_endpoint(id)
delete_origin_endpoint(id, params::Dict{String,<:Any})
Deletes an existing OriginEndpoint.
# Arguments
- `id`: The ID of the OriginEndpoint to delete.
"""
function delete_origin_endpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"DELETE",
"/origin_endpoints/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_origin_endpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"DELETE",
"/origin_endpoints/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_channel(id)
describe_channel(id, params::Dict{String,<:Any})
Gets details about a Channel.
# Arguments
- `id`: The ID of a Channel.
"""
function describe_channel(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"GET", "/channels/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_channel(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET",
"/channels/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_harvest_job(id)
describe_harvest_job(id, params::Dict{String,<:Any})
Gets details about an existing HarvestJob.
# Arguments
- `id`: The ID of the HarvestJob.
"""
function describe_harvest_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"GET", "/harvest_jobs/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_harvest_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET",
"/harvest_jobs/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_origin_endpoint(id)
describe_origin_endpoint(id, params::Dict{String,<:Any})
Gets details about an existing OriginEndpoint.
# Arguments
- `id`: The ID of the OriginEndpoint.
"""
function describe_origin_endpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"GET",
"/origin_endpoints/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_origin_endpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET",
"/origin_endpoints/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channels()
list_channels(params::Dict{String,<:Any})
Returns a collection of Channels.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Upper bound on number of records to return.
- `"nextToken"`: A token used to resume pagination from the end of a previous request.
"""
function list_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"GET", "/channels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET", "/channels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_harvest_jobs()
list_harvest_jobs(params::Dict{String,<:Any})
Returns a collection of HarvestJob records.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeChannelId"`: When specified, the request will return only HarvestJobs associated
with the given Channel ID.
- `"includeStatus"`: When specified, the request will return only HarvestJobs in the given
status.
- `"maxResults"`: The upper bound on the number of records to return.
- `"nextToken"`: A token used to resume pagination from the end of a previous request.
"""
function list_harvest_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"GET", "/harvest_jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_harvest_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET",
"/harvest_jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_origin_endpoints()
list_origin_endpoints(params::Dict{String,<:Any})
Returns a collection of OriginEndpoint records.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelId"`: When specified, the request will return only OriginEndpoints associated
with the given Channel ID.
- `"maxResults"`: The upper bound on the number of records to return.
- `"nextToken"`: A token used to resume pagination from the end of a previous request.
"""
function list_origin_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"GET", "/origin_endpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_origin_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET",
"/origin_endpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})
# Arguments
- `resource-arn`:
"""
function list_tags_for_resource(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"GET",
"/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"GET",
"/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rotate_channel_credentials(id)
rotate_channel_credentials(id, params::Dict{String,<:Any})
Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is
deprecated. Please use RotateIngestEndpointCredentials instead
# Arguments
- `id`: The ID of the channel to update.
"""
function rotate_channel_credentials(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"PUT",
"/channels/$(id)/credentials";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_channel_credentials(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"PUT",
"/channels/$(id)/credentials",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rotate_ingest_endpoint_credentials(id, ingest_endpoint_id)
rotate_ingest_endpoint_credentials(id, ingest_endpoint_id, params::Dict{String,<:Any})
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
# Arguments
- `id`: The ID of the channel the IngestEndpoint is on.
- `ingest_endpoint_id`: The id of the IngestEndpoint whose credentials should be rotated
"""
function rotate_ingest_endpoint_credentials(
id, ingest_endpoint_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"PUT",
"/channels/$(id)/ingest_endpoints/$(ingest_endpoint_id)/credentials";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_ingest_endpoint_credentials(
id,
ingest_endpoint_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"PUT",
"/channels/$(id)/ingest_endpoints/$(ingest_endpoint_id)/credentials",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource-arn, tags)
tag_resource(resource-arn, tags, params::Dict{String,<:Any})
# Arguments
- `resource-arn`:
- `tags`:
"""
function tag_resource(resource_arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"POST",
"/tags/$(resource-arn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resource_arn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"POST",
"/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})
# Arguments
- `resource-arn`:
- `tag_keys`: The key(s) of tag to be deleted
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"DELETE",
"/tags/$(resource-arn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resource_arn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage(
"DELETE",
"/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel(id)
update_channel(id, params::Dict{String,<:Any})
Updates an existing Channel.
# Arguments
- `id`: The ID of the Channel to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A short text description of the Channel.
"""
function update_channel(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"PUT", "/channels/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_channel(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"PUT",
"/channels/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_origin_endpoint(id)
update_origin_endpoint(id, params::Dict{String,<:Any})
Updates an existing OriginEndpoint.
# Arguments
- `id`: The ID of the OriginEndpoint to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorization"`:
- `"cmafPackage"`:
- `"dashPackage"`:
- `"description"`: A short text description of the OriginEndpoint.
- `"hlsPackage"`:
- `"manifestName"`: A short string that will be appended to the end of the Endpoint URL.
- `"mssPackage"`:
- `"origination"`: Control whether origination of video is allowed for this OriginEndpoint.
If set to ALLOW, the OriginEndpoint
may by requested, pursuant to any other form of access
control. If set to DENY, the OriginEndpoint may not be
requested. This can be helpful for
Live to VOD harvesting, or for temporarily disabling origination
- `"startoverWindowSeconds"`: Maximum duration (in seconds) of content to retain for
startover playback.
If not specified, startover playback will be disabled for the
OriginEndpoint.
- `"timeDelaySeconds"`: Amount of delay (in seconds) to enforce on the playback of live
content.
If not specified, there will be no time delay in effect for the OriginEndpoint.
- `"whitelist"`: A list of source IP CIDR blocks that will be allowed to access the
OriginEndpoint.
"""
function update_origin_endpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage(
"PUT",
"/origin_endpoints/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_origin_endpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage(
"PUT",
"/origin_endpoints/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 17121 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediapackage_vod
using AWS.Compat
using AWS.UUIDs
"""
configure_logs(id)
configure_logs(id, params::Dict{String,<:Any})
Changes the packaging group's properities to configure log subscription
# Arguments
- `id`: The ID of a MediaPackage VOD PackagingGroup resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"egressAccessLogs"`:
"""
function configure_logs(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"PUT",
"/packaging_groups/$(id)/configure_logs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_logs(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"PUT",
"/packaging_groups/$(id)/configure_logs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_asset(id, packaging_group_id, source_arn, source_role_arn)
create_asset(id, packaging_group_id, source_arn, source_role_arn, params::Dict{String,<:Any})
Creates a new MediaPackage VOD Asset resource.
# Arguments
- `id`: The unique identifier for the Asset.
- `packaging_group_id`: The ID of the PackagingGroup for the Asset.
- `source_arn`: ARN of the source object in S3.
- `source_role_arn`: The IAM role ARN used to access the source S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceId"`: The resource ID to include in SPEKE key requests.
- `"tags"`:
"""
function create_asset(
id,
packagingGroupId,
sourceArn,
sourceRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage_vod(
"POST",
"/assets",
Dict{String,Any}(
"id" => id,
"packagingGroupId" => packagingGroupId,
"sourceArn" => sourceArn,
"sourceRoleArn" => sourceRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset(
id,
packagingGroupId,
sourceArn,
sourceRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage_vod(
"POST",
"/assets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"id" => id,
"packagingGroupId" => packagingGroupId,
"sourceArn" => sourceArn,
"sourceRoleArn" => sourceRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_packaging_configuration(id, packaging_group_id)
create_packaging_configuration(id, packaging_group_id, params::Dict{String,<:Any})
Creates a new MediaPackage VOD PackagingConfiguration resource.
# Arguments
- `id`: The ID of the PackagingConfiguration.
- `packaging_group_id`: The ID of a PackagingGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cmafPackage"`:
- `"dashPackage"`:
- `"hlsPackage"`:
- `"mssPackage"`:
- `"tags"`:
"""
function create_packaging_configuration(
id, packagingGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"POST",
"/packaging_configurations",
Dict{String,Any}("id" => id, "packagingGroupId" => packagingGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_packaging_configuration(
id,
packagingGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage_vod(
"POST",
"/packaging_configurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "packagingGroupId" => packagingGroupId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_packaging_group(id)
create_packaging_group(id, params::Dict{String,<:Any})
Creates a new MediaPackage VOD PackagingGroup resource.
# Arguments
- `id`: The ID of the PackagingGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorization"`:
- `"egressAccessLogs"`:
- `"tags"`:
"""
function create_packaging_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"POST",
"/packaging_groups",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_packaging_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"POST",
"/packaging_groups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset(id)
delete_asset(id, params::Dict{String,<:Any})
Deletes an existing MediaPackage VOD Asset resource.
# Arguments
- `id`: The ID of the MediaPackage VOD Asset resource to delete.
"""
function delete_asset(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"DELETE", "/assets/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_asset(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"DELETE",
"/assets/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_packaging_configuration(id)
delete_packaging_configuration(id, params::Dict{String,<:Any})
Deletes a MediaPackage VOD PackagingConfiguration resource.
# Arguments
- `id`: The ID of the MediaPackage VOD PackagingConfiguration resource to delete.
"""
function delete_packaging_configuration(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"DELETE",
"/packaging_configurations/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_packaging_configuration(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"DELETE",
"/packaging_configurations/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_packaging_group(id)
delete_packaging_group(id, params::Dict{String,<:Any})
Deletes a MediaPackage VOD PackagingGroup resource.
# Arguments
- `id`: The ID of the MediaPackage VOD PackagingGroup resource to delete.
"""
function delete_packaging_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"DELETE",
"/packaging_groups/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_packaging_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"DELETE",
"/packaging_groups/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset(id)
describe_asset(id, params::Dict{String,<:Any})
Returns a description of a MediaPackage VOD Asset resource.
# Arguments
- `id`: The ID of an MediaPackage VOD Asset resource.
"""
function describe_asset(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"GET", "/assets/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_asset(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/assets/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_packaging_configuration(id)
describe_packaging_configuration(id, params::Dict{String,<:Any})
Returns a description of a MediaPackage VOD PackagingConfiguration resource.
# Arguments
- `id`: The ID of a MediaPackage VOD PackagingConfiguration resource.
"""
function describe_packaging_configuration(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/packaging_configurations/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_packaging_configuration(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/packaging_configurations/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_packaging_group(id)
describe_packaging_group(id, params::Dict{String,<:Any})
Returns a description of a MediaPackage VOD PackagingGroup resource.
# Arguments
- `id`: The ID of a MediaPackage VOD PackagingGroup resource.
"""
function describe_packaging_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"GET",
"/packaging_groups/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_packaging_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/packaging_groups/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assets()
list_assets(params::Dict{String,<:Any})
Returns a collection of MediaPackage VOD Asset resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Upper bound on number of records to return.
- `"nextToken"`: A token used to resume pagination from the end of a previous request.
- `"packagingGroupId"`: Returns Assets associated with the specified PackagingGroup.
"""
function list_assets(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"GET", "/assets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET", "/assets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_packaging_configurations()
list_packaging_configurations(params::Dict{String,<:Any})
Returns a collection of MediaPackage VOD PackagingConfiguration resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Upper bound on number of records to return.
- `"nextToken"`: A token used to resume pagination from the end of a previous request.
- `"packagingGroupId"`: Returns MediaPackage VOD PackagingConfigurations associated with
the specified PackagingGroup.
"""
function list_packaging_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"GET",
"/packaging_configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_packaging_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/packaging_configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_packaging_groups()
list_packaging_groups(params::Dict{String,<:Any})
Returns a collection of MediaPackage VOD PackagingGroup resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Upper bound on number of records to return.
- `"nextToken"`: A token used to resume pagination from the end of a previous request.
"""
function list_packaging_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"GET", "/packaging_groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_packaging_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/packaging_groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})
Returns a list of the tags assigned to the specified resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) for the resource. You can get this from
the response to any request to the resource.
"""
function list_tags_for_resource(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"GET",
"/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage_vod(
"GET",
"/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource-arn, tags)
tag_resource(resource-arn, tags, params::Dict{String,<:Any})
Adds tags to the specified resource. You can specify one or more tags to add.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) for the resource. You can get this from
the response to any request to the resource.
- `tags`: A collection of tags associated with a resource
"""
function tag_resource(resource_arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"POST",
"/tags/$(resource-arn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resource_arn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage_vod(
"POST",
"/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified resource. You can specify one or more tags to remove.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) for the resource. You can get this from
the response to any request to the resource.
- `tag_keys`: A comma-separated list of the tag keys to remove from the resource.
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"DELETE",
"/tags/$(resource-arn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resource_arn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackage_vod(
"DELETE",
"/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_packaging_group(id)
update_packaging_group(id, params::Dict{String,<:Any})
Updates a specific packaging group. You can't change the id attribute or any other
system-generated attributes.
# Arguments
- `id`: The ID of a MediaPackage VOD PackagingGroup resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorization"`:
"""
function update_packaging_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackage_vod(
"PUT",
"/packaging_groups/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_packaging_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackage_vod(
"PUT",
"/packaging_groups/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 42297 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediapackagev2
using AWS.Compat
using AWS.UUIDs
"""
create_channel(channel_group_name, channel_name)
create_channel(channel_group_name, channel_name, params::Dict{String,<:Any})
Create a channel to start receiving content streams. The channel represents the input to
MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The
channel receives content, and after packaging it, outputs it through an origin endpoint to
downstream devices (such as video players or CDNs) that request the content. You can create
only one channel with each request. We recommend that you spread out channels between
channel groups, such as putting redundant channels in the same AWS Region in different
channel groups.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
You can't change the name after you create the channel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Enter any descriptive text that helps you to identify the channel.
- `"InputType"`: The input type will be an immutable field which will be used to define
whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to
HLS to preserve current behavior. The allowed values are: HLS - The HLS streaming
specification (which defines M3U8 manifests and TS segments). CMAF - The DASH-IF CMAF
Ingest specification (which defines CMAF segments with optional DASH manifests).
- `"tags"`: A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\", \"Key2\": \"Value2\"
- `"x-amzn-client-token"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
"""
function create_channel(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"POST",
"/channelGroup/$(ChannelGroupName)/channel",
Dict{String,Any}(
"ChannelName" => ChannelName, "x-amzn-client-token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/channelGroup/$(ChannelGroupName)/channel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChannelName" => ChannelName, "x-amzn-client-token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel_group(channel_group_name)
create_channel_group(channel_group_name, params::Dict{String,<:Any})
Create a channel group to group your channels and origin endpoints. A channel group is the
top-level resource that consists of channels and origin endpoints that are associated with
it and that provides predictable URLs for stream delivery. All channels and origin
endpoints within the channel group are guaranteed to share the DNS. You can create only one
channel group with each request.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
You can't use spaces in the name. You can't change the name after you create the channel
group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Enter any descriptive text that helps you to identify the channel group.
- `"tags"`: A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\", \"Key2\": \"Value2\"
- `"x-amzn-client-token"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
"""
function create_channel_group(
ChannelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"POST",
"/channelGroup",
Dict{String,Any}(
"ChannelGroupName" => ChannelGroupName, "x-amzn-client-token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel_group(
ChannelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/channelGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChannelGroupName" => ChannelGroupName,
"x-amzn-client-token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_origin_endpoint(channel_group_name, channel_name, container_type, origin_endpoint_name)
create_origin_endpoint(channel_group_name, channel_name, container_type, origin_endpoint_name, params::Dict{String,<:Any})
The endpoint is attached to a channel, and represents the output of the live content. You
can associate multiple endpoints to a single channel. Each endpoint gives players and
downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content
can't be served from a channel until it has an endpoint. You can create only one endpoint
with each request.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `container_type`: The type of container to attach to this origin endpoint. A container
type is a file format that encapsulates one or more media streams, such as audio and video,
into a single file. You can't change the container type after you create the endpoint.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and must be unique for your account in the AWS
Region and channel. You can't use spaces in the name. You can't change the name after you
create the endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DashManifests"`: A DASH manifest configuration.
- `"Description"`: Enter any descriptive text that helps you to identify the origin
endpoint.
- `"ForceEndpointErrorConfiguration"`: The failover settings for the endpoint.
- `"HlsManifests"`: An HTTP live streaming (HLS) manifest configuration.
- `"LowLatencyHlsManifests"`: A low-latency HLS manifest configuration.
- `"Segment"`: The segment configuration, including the segment name, duration, and other
configuration values.
- `"StartoverWindowSeconds"`: The size of the window (in seconds) to create a window of the
live stream that's available for on-demand viewing. Viewers can start-over or catch-up on
content that falls within the window. The maximum startover window is 1,209,600 seconds (14
days).
- `"Tags"`: A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\", \"Key2\": \"Value2\"
- `"x-amzn-client-token"`: A unique, case-sensitive token that you provide to ensure the
idempotency of the request.
"""
function create_origin_endpoint(
ChannelGroupName,
ChannelName,
ContainerType,
OriginEndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint",
Dict{String,Any}(
"ContainerType" => ContainerType,
"OriginEndpointName" => OriginEndpointName,
"x-amzn-client-token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_origin_endpoint(
ChannelGroupName,
ChannelName,
ContainerType,
OriginEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContainerType" => ContainerType,
"OriginEndpointName" => OriginEndpointName,
"x-amzn-client-token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel(channel_group_name, channel_name)
delete_channel(channel_group_name, channel_name, params::Dict{String,<:Any})
Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You
must delete the channel's origin endpoints before you can delete the channel.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
"""
function delete_channel(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel_group(channel_group_name)
delete_channel_group(channel_group_name, params::Dict{String,<:Any})
Delete a channel group. You must delete the channel group's channels and origin endpoints
before you can delete the channel group. If you delete a channel group, you'll lose access
to the egress domain and will have to create a new channel group to replace it.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
"""
function delete_channel_group(
ChannelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel_group(
ChannelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel_policy(channel_group_name, channel_name)
delete_channel_policy(channel_group_name, channel_name, params::Dict{String,<:Any})
Delete a channel policy.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
"""
function delete_channel_policy(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel_policy(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_origin_endpoint(channel_group_name, channel_name, origin_endpoint_name)
delete_origin_endpoint(channel_group_name, channel_name, origin_endpoint_name, params::Dict{String,<:Any})
Origin endpoints can serve content until they're deleted. Delete the endpoint if it should
no longer respond to playback requests. You must delete all endpoints from a channel before
you can delete the channel.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and and must be unique for your account in the
AWS Region and channel.
"""
function delete_origin_endpoint(
ChannelGroupName,
ChannelName,
OriginEndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_origin_endpoint(
ChannelGroupName,
ChannelName,
OriginEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_origin_endpoint_policy(channel_group_name, channel_name, origin_endpoint_name)
delete_origin_endpoint_policy(channel_group_name, channel_name, origin_endpoint_name, params::Dict{String,<:Any})
Delete an origin endpoint policy.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and and must be unique for your account in the
AWS Region and channel.
"""
function delete_origin_endpoint_policy(
ChannelGroupName,
ChannelName,
OriginEndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_origin_endpoint_policy(
ChannelGroupName,
ChannelName,
OriginEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channel(channel_group_name, channel_name)
get_channel(channel_group_name, channel_name, params::Dict{String,<:Any})
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including
the origin endpoints that are associated with it.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
"""
function get_channel(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channel(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channel_group(channel_group_name)
get_channel_group(channel_group_name, params::Dict{String,<:Any})
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage,
including the channels and origin endpoints that are associated with it.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
"""
function get_channel_group(
ChannelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channel_group(
ChannelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channel_policy(channel_group_name, channel_name)
get_channel_policy(channel_group_name, channel_name, params::Dict{String,<:Any})
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
With policies, you can specify who has access to AWS resources and what actions they can
perform on those resources.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
"""
function get_channel_policy(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channel_policy(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_origin_endpoint(channel_group_name, channel_name, origin_endpoint_name)
get_origin_endpoint(channel_group_name, channel_name, origin_endpoint_name, params::Dict{String,<:Any})
Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to
obtain its playback URL and to view the packaging settings that it's currently using.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and and must be unique for your account in the
AWS Region and channel.
"""
function get_origin_endpoint(
ChannelGroupName,
ChannelName,
OriginEndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_origin_endpoint(
ChannelGroupName,
ChannelName,
OriginEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_origin_endpoint_policy(channel_group_name, channel_name, origin_endpoint_name)
get_origin_endpoint_policy(channel_group_name, channel_name, origin_endpoint_name, params::Dict{String,<:Any})
Retrieves the specified origin endpoint policy that's configured in AWS Elemental
MediaPackage.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and and must be unique for your account in the
AWS Region and channel.
"""
function get_origin_endpoint_policy(
ChannelGroupName,
ChannelName,
OriginEndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_origin_endpoint_policy(
ChannelGroupName,
ChannelName,
OriginEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channel_groups()
list_channel_groups(params::Dict{String,<:Any})
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including
the channels and origin endpoints that are associated with it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The pagination token from the GET list request. Use the token to fetch the
next page of results.
"""
function list_channel_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackagev2(
"GET", "/channelGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_channel_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"GET",
"/channelGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channels(channel_group_name)
list_channels(channel_group_name, params::Dict{String,<:Any})
Retrieves all channels in a specific channel group that are configured in AWS Elemental
MediaPackage, including the origin endpoints that are associated with it.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The pagination token from the GET list request. Use the token to fetch the
next page of results.
"""
function list_channels(ChannelGroupName; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_channels(
ChannelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_origin_endpoints(channel_group_name, channel_name)
list_origin_endpoints(channel_group_name, channel_name, params::Dict{String,<:Any})
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental
MediaPackage.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: The pagination token from the GET list request. Use the token to fetch the
next page of results.
"""
function list_origin_endpoints(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_origin_endpoints(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags assigned to a resource.
# Arguments
- `resource_arn`: The ARN of the CloudWatch resource that you want to view tags for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_channel_policy(channel_group_name, channel_name, policy)
put_channel_policy(channel_group_name, channel_name, policy, params::Dict{String,<:Any})
Attaches an IAM policy to the specified channel. With policies, you can specify who has
access to AWS resources and what actions they can perform on those resources. You can
attach only one policy with each request.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `policy`: The policy to attach to the specified channel.
"""
function put_channel_policy(
ChannelGroupName, ChannelName, Policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/policy",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_channel_policy(
ChannelGroupName,
ChannelName,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_origin_endpoint_policy(channel_group_name, channel_name, origin_endpoint_name, policy)
put_origin_endpoint_policy(channel_group_name, channel_name, origin_endpoint_name, policy, params::Dict{String,<:Any})
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy
with each request.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and and must be unique for your account in the
AWS Region and channel.
- `policy`: The policy to attach to the specified origin endpoint.
"""
function put_origin_endpoint_policy(
ChannelGroupName,
ChannelName,
OriginEndpointName,
Policy;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)/policy",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_origin_endpoint_policy(
ChannelGroupName,
ChannelName,
OriginEndpointName,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource. Tags can
help you organize and categorize your resources. You can also use them to scope user
permissions, by granting a user permission to access or change only resources with certain
tag values. You can use the TagResource operation with a resource that already has tags. If
you specify a new tag key for the resource, this tag is appended to the list of tags
associated with the resource. If you specify a tag key that is already associated with the
resource, the new tag value that you specify replaces the previous value for that tag.
# Arguments
- `resource_arn`: The ARN of the MediaPackage resource that you're adding tags to.
- `tags`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the resource.
"""
function tag_resource(ResourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediapackagev2(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from the specified resource.
# Arguments
- `resource_arn`: The ARN of the MediaPackage resource that you're removing tags from.
- `tag_keys`: The list of tag keys to remove from the resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel(channel_group_name, channel_name)
update_channel(channel_group_name, channel_name, params::Dict{String,<:Any})
Update the specified channel. You can edit if MediaPackage sends ingest or egress access
logs to the CloudWatch log group, if content will be encrypted, the description on a
channel, and your channel's policy settings. You can't edit the name of the channel or
CloudFront distribution details. Any edits you make that impact the video output may not be
reflected for a few minutes.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Any descriptive information that you want to add to the channel for
future identification purposes.
- `"x-amzn-update-if-match"`: The expected current Entity Tag (ETag) for the resource. If
the specified ETag does not match the resource's current entity tag, the update request
will be rejected.
"""
function update_channel(
ChannelGroupName, ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel(
ChannelGroupName,
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel_group(channel_group_name)
update_channel_group(channel_group_name, params::Dict{String,<:Any})
Update the specified channel group. You can edit the description on a channel group for
easier identification later from the AWS Elemental MediaPackage console. You can't edit the
name of the channel group. Any edits you make that impact the video output may not be
reflected for a few minutes.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Any descriptive information that you want to add to the channel group
for future identification purposes.
- `"x-amzn-update-if-match"`: The expected current Entity Tag (ETag) for the resource. If
the specified ETag does not match the resource's current entity tag, the update request
will be rejected.
"""
function update_channel_group(
ChannelGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel_group(
ChannelGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_origin_endpoint(channel_group_name, channel_name, container_type, origin_endpoint_name)
update_origin_endpoint(channel_group_name, channel_name, container_type, origin_endpoint_name, params::Dict{String,<:Any})
Update the specified origin endpoint. Edit the packaging preferences on an endpoint to
optimize the viewing experience. You can't edit the name of the endpoint. Any edits you
make that impact the video output may not be reflected for a few minutes.
# Arguments
- `channel_group_name`: The name that describes the channel group. The name is the primary
identifier for the channel group, and must be unique for your account in the AWS Region.
- `channel_name`: The name that describes the channel. The name is the primary identifier
for the channel, and must be unique for your account in the AWS Region and channel group.
- `container_type`: The type of container attached to this origin endpoint. A container
type is a file format that encapsulates one or more media streams, such as audio and video,
into a single file.
- `origin_endpoint_name`: The name that describes the origin endpoint. The name is the
primary identifier for the origin endpoint, and and must be unique for your account in the
AWS Region and channel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DashManifests"`: A DASH manifest configuration.
- `"Description"`: Any descriptive information that you want to add to the origin endpoint
for future identification purposes.
- `"ForceEndpointErrorConfiguration"`: The failover settings for the endpoint.
- `"HlsManifests"`: An HTTP live streaming (HLS) manifest configuration.
- `"LowLatencyHlsManifests"`: A low-latency HLS manifest configuration.
- `"Segment"`: The segment configuration, including the segment name, duration, and other
configuration values.
- `"StartoverWindowSeconds"`: The size of the window (in seconds) to create a window of the
live stream that's available for on-demand viewing. Viewers can start-over or catch-up on
content that falls within the window. The maximum startover window is 1,209,600 seconds (14
days).
- `"x-amzn-update-if-match"`: The expected current Entity Tag (ETag) for the resource. If
the specified ETag does not match the resource's current entity tag, the update request
will be rejected.
"""
function update_origin_endpoint(
ChannelGroupName,
ChannelName,
ContainerType,
OriginEndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)",
Dict{String,Any}("ContainerType" => ContainerType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_origin_endpoint(
ChannelGroupName,
ChannelName,
ContainerType,
OriginEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediapackagev2(
"PUT",
"/channelGroup/$(ChannelGroupName)/channel/$(ChannelName)/originEndpoint/$(OriginEndpointName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerType" => ContainerType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 28046 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediastore
using AWS.Compat
using AWS.UUIDs
"""
create_container(container_name)
create_container(container_name, params::Dict{String,<:Any})
Creates a storage container to hold objects. A container is similar to a bucket in the
Amazon S3 service.
# Arguments
- `container_name`: The name for the container. The name must be from 1 to 255 characters.
Container names must be unique to your AWS account within a specific region. As an example,
you could create a container named movies in every region, as long as you don’t have an
existing container with that name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An array of key:value pairs that you define. These values can be anything that
you want. Typically, the tag key represents a category (such as \"environment\") and the
tag value represents a specific value within that category (such as \"test,\"
\"development,\" or \"production\"). You can add up to 50 tags to each container. For more
information about tagging, including naming and usage conventions, see Tagging Resources in
MediaStore.
"""
function create_container(ContainerName; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"CreateContainer",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_container(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"CreateContainer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_container(container_name)
delete_container(container_name, params::Dict{String,<:Any})
Deletes the specified container. Before you make a DeleteContainer request, delete any
objects in the container or in any folders in the container. You can delete only empty
containers.
# Arguments
- `container_name`: The name of the container to delete.
"""
function delete_container(ContainerName; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"DeleteContainer",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_container(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"DeleteContainer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_container_policy(container_name)
delete_container_policy(container_name, params::Dict{String,<:Any})
Deletes the access policy that is associated with the specified container.
# Arguments
- `container_name`: The name of the container that holds the policy.
"""
function delete_container_policy(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"DeleteContainerPolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_container_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"DeleteContainerPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cors_policy(container_name)
delete_cors_policy(container_name, params::Dict{String,<:Any})
Deletes the cross-origin resource sharing (CORS) configuration information that is set for
the container. To use this operation, you must have permission to perform the
MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and
can grant this permission to others.
# Arguments
- `container_name`: The name of the container to remove the policy from.
"""
function delete_cors_policy(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"DeleteCorsPolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cors_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"DeleteCorsPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lifecycle_policy(container_name)
delete_lifecycle_policy(container_name, params::Dict{String,<:Any})
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the
change to take effect.
# Arguments
- `container_name`: The name of the container that holds the object lifecycle policy.
"""
function delete_lifecycle_policy(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"DeleteLifecyclePolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lifecycle_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"DeleteLifecyclePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_metric_policy(container_name)
delete_metric_policy(container_name, params::Dict{String,<:Any})
Deletes the metric policy that is associated with the specified container. If there is no
metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.
# Arguments
- `container_name`: The name of the container that is associated with the metric policy
that you want to delete.
"""
function delete_metric_policy(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"DeleteMetricPolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_metric_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"DeleteMetricPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_container()
describe_container(params::Dict{String,<:Any})
Retrieves the properties of the requested container. This request is commonly used to
retrieve the endpoint of a container. An endpoint is a value assigned by the service when a
new container is created. A container's endpoint does not change after it has been
assigned. The DescribeContainer request returns a single Container object based on
ContainerName. To return all Container objects that are associated with a specified AWS
account, use ListContainers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContainerName"`: The name of the container to query.
"""
function describe_container(; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"DescribeContainer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_container(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"DescribeContainer", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_container_policy(container_name)
get_container_policy(container_name, params::Dict{String,<:Any})
Retrieves the access policy for the specified container. For information about the data
that is included in an access policy, see the AWS Identity and Access Management User Guide.
# Arguments
- `container_name`: The name of the container.
"""
function get_container_policy(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"GetContainerPolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"GetContainerPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cors_policy(container_name)
get_cors_policy(container_name, params::Dict{String,<:Any})
Returns the cross-origin resource sharing (CORS) configuration information that is set for
the container. To use this operation, you must have permission to perform the
MediaStore:GetCorsPolicy action. By default, the container owner has this permission and
can grant it to others.
# Arguments
- `container_name`: The name of the container that the policy is assigned to.
"""
function get_cors_policy(ContainerName; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"GetCorsPolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cors_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"GetCorsPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lifecycle_policy(container_name)
get_lifecycle_policy(container_name, params::Dict{String,<:Any})
Retrieves the object lifecycle policy that is assigned to a container.
# Arguments
- `container_name`: The name of the container that the object lifecycle policy is assigned
to.
"""
function get_lifecycle_policy(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"GetLifecyclePolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lifecycle_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"GetLifecyclePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_metric_policy(container_name)
get_metric_policy(container_name, params::Dict{String,<:Any})
Returns the metric policy for the specified container.
# Arguments
- `container_name`: The name of the container that is associated with the metric policy.
"""
function get_metric_policy(ContainerName; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"GetMetricPolicy",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_metric_policy(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"GetMetricPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_containers()
list_containers(params::Dict{String,<:Any})
Lists the properties of all containers in AWS Elemental MediaStore. You can query to
receive all the containers in one response. Or you can include the MaxResults parameter to
receive a limited number of containers in each response. In this case, the response
includes a token. To get the next set of containers, send the command again, this time with
the NextToken parameter (with the returned token as its value). The next set of responses
appears, with a token if there are still more containers to receive. See also
DescribeContainer, which gets the properties of one container.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Enter the maximum number of containers in the response. Use from 1 to 255
characters.
- `"NextToken"`: Only if you used MaxResults in the first command, enter the token (which
was included in the previous response) to obtain the next set of containers. This token is
included in a response only if there actually are more containers to list.
"""
function list_containers(; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"ListContainers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_containers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"ListContainers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource)
list_tags_for_resource(resource, params::Dict{String,<:Any})
Returns a list of the tags assigned to the specified container.
# Arguments
- `resource`: The Amazon Resource Name (ARN) for the container.
"""
function list_tags_for_resource(Resource; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"ListTagsForResource",
Dict{String,Any}("Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Resource" => Resource), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_container_policy(container_name, policy)
put_container_policy(container_name, policy, params::Dict{String,<:Any})
Creates an access policy for the specified container to restrict the users and clients that
can access it. For information about the data that is included in an access policy, see the
AWS Identity and Access Management User Guide. For this release of the REST API, you can
create only one policy for a container. If you enter PutContainerPolicy twice, the second
command modifies the existing policy.
# Arguments
- `container_name`: The name of the container.
- `policy`: The contents of the policy, which includes the following: One Version tag
One Statement tag that contains the standard tags for the policy.
"""
function put_container_policy(
ContainerName, Policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"PutContainerPolicy",
Dict{String,Any}("ContainerName" => ContainerName, "Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_container_policy(
ContainerName,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"PutContainerPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ContainerName" => ContainerName, "Policy" => Policy),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_cors_policy(container_name, cors_policy)
put_cors_policy(container_name, cors_policy, params::Dict{String,<:Any})
Sets the cross-origin resource sharing (CORS) configuration on a container so that the
container can service cross-origin requests. For example, you might want to enable a
request whose origin is http://www.example.com to access your AWS Elemental MediaStore
container at my.example.container.com by using the browser's XMLHttpRequest capability. To
enable CORS on a container, you attach a CORS policy to the container. In the CORS policy,
you configure rules that identify origins and the HTTP methods that can be executed on your
container. The policy can contain up to 398,000 characters. You can add up to 100 rules to
a CORS policy. If more than one rule applies, the service uses the first applicable rule
listed. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental
MediaStore.
# Arguments
- `container_name`: The name of the container that you want to assign the CORS policy to.
- `cors_policy`: The CORS policy to apply to the container.
"""
function put_cors_policy(
ContainerName, CorsPolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"PutCorsPolicy",
Dict{String,Any}("ContainerName" => ContainerName, "CorsPolicy" => CorsPolicy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_cors_policy(
ContainerName,
CorsPolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"PutCorsPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContainerName" => ContainerName, "CorsPolicy" => CorsPolicy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_lifecycle_policy(container_name, lifecycle_policy)
put_lifecycle_policy(container_name, lifecycle_policy, params::Dict{String,<:Any})
Writes an object lifecycle policy to a container. If the container already has an object
lifecycle policy, the service replaces the existing policy with the new policy. It takes up
to 20 minutes for the change to take effect. For information about how to construct an
object lifecycle policy, see Components of an Object Lifecycle Policy.
# Arguments
- `container_name`: The name of the container that you want to assign the object lifecycle
policy to.
- `lifecycle_policy`: The object lifecycle policy to apply to the container.
"""
function put_lifecycle_policy(
ContainerName, LifecyclePolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"PutLifecyclePolicy",
Dict{String,Any}(
"ContainerName" => ContainerName, "LifecyclePolicy" => LifecyclePolicy
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_lifecycle_policy(
ContainerName,
LifecyclePolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"PutLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContainerName" => ContainerName, "LifecyclePolicy" => LifecyclePolicy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_metric_policy(container_name, metric_policy)
put_metric_policy(container_name, metric_policy, params::Dict{String,<:Any})
The metric policy that you want to add to the container. A metric policy allows AWS
Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for
the new policy to take effect.
# Arguments
- `container_name`: The name of the container that you want to add the metric policy to.
- `metric_policy`: The metric policy that you want to associate with the container. In the
policy, you must indicate whether you want MediaStore to send container-level metrics. You
can also include up to five rules to define groups of objects that you want MediaStore to
send object-level metrics for. If you include rules in the policy, construct each rule with
both of the following: An object group that defines which objects to include in the
group. The definition can be a path or a file name, but it can't have more than 900
characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), .
(period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are
acceptable. An object group name that allows you to refer to the object group. The name
can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _
(underscore).
"""
function put_metric_policy(
ContainerName, MetricPolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"PutMetricPolicy",
Dict{String,Any}("ContainerName" => ContainerName, "MetricPolicy" => MetricPolicy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_metric_policy(
ContainerName,
MetricPolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"PutMetricPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContainerName" => ContainerName, "MetricPolicy" => MetricPolicy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_access_logging(container_name)
start_access_logging(container_name, params::Dict{String,<:Any})
Starts access logging on the specified container. When you enable access logging on a
container, MediaStore delivers access logs for objects stored in that container to Amazon
CloudWatch Logs.
# Arguments
- `container_name`: The name of the container that you want to start access logging on.
"""
function start_access_logging(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"StartAccessLogging",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_access_logging(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"StartAccessLogging",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_access_logging(container_name)
stop_access_logging(container_name, params::Dict{String,<:Any})
Stops access logging on the specified container. When you stop access logging on a
container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access
logs are not saved and are not retrievable.
# Arguments
- `container_name`: The name of the container that you want to stop access logging on.
"""
function stop_access_logging(
ContainerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"StopAccessLogging",
Dict{String,Any}("ContainerName" => ContainerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_access_logging(
ContainerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"StopAccessLogging",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContainerName" => ContainerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource, tags)
tag_resource(resource, tags, params::Dict{String,<:Any})
Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs
that you can associate with AWS resources. For example, the tag key might be \"customer\"
and the tag value might be \"companyA.\" You can specify one or more tags to add to each
container. You can add up to 50 tags to each container. For more information about tagging,
including naming and usage conventions, see Tagging Resources in MediaStore.
# Arguments
- `resource`: The Amazon Resource Name (ARN) for the container.
- `tags`: An array of key:value pairs that you want to add to the container. You need to
specify only the tags that you want to add or update. For example, suppose a container
already has two tags (customer:CompanyA and priority:High). You want to change the priority
tag and also add a third tag (type:Contract). For TagResource, you specify the following
tags: priority:Medium, type:Contract. The result is that your container has three tags:
customer:CompanyA, priority:Medium, and type:Contract.
"""
function tag_resource(Resource, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore(
"TagResource",
Dict{String,Any}("Resource" => Resource, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Resource,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"TagResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Resource" => Resource, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource, tag_keys)
untag_resource(resource, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified container. You can specify one or more tags to remove.
# Arguments
- `resource`: The Amazon Resource Name (ARN) for the container.
- `tag_keys`: A comma-separated list of keys for tags that you want to remove from the
container. For example, if your container has two tags (customer:CompanyA and
priority:High) and you want to remove one of the tags (priority:High), you specify the key
for the tag that you want to remove (priority).
"""
function untag_resource(
Resource, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore(
"UntagResource",
Dict{String,Any}("Resource" => Resource, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
Resource,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Resource" => Resource, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 8903 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediastore_data
using AWS.Compat
using AWS.UUIDs
"""
delete_object(path)
delete_object(path, params::Dict{String,<:Any})
Deletes an object at the specified path.
# Arguments
- `path`: The path (including the file name) where the object is stored in the container.
Format: <folder name>/<folder name>/<file name>
"""
function delete_object(Path; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore_data(
"DELETE", "/$(Path)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_object(
Path, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore_data(
"DELETE", "/$(Path)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_object(path)
describe_object(path, params::Dict{String,<:Any})
Gets the headers for an object at the specified path.
# Arguments
- `path`: The path (including the file name) where the object is stored in the container.
Format: <folder name>/<folder name>/<file name>
"""
function describe_object(Path; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore_data(
"HEAD", "/$(Path)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_object(
Path, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore_data(
"HEAD", "/$(Path)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_object(path)
get_object(path, params::Dict{String,<:Any})
Downloads the object at the specified path. If the object’s upload availability is set to
streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the
object.
# Arguments
- `path`: The path (including the file name) where the object is stored in the container.
Format: <folder name>/<folder name>/<file name> For example, to upload
the file mlaw.avi to the folder path premiumcanada in the container movies, enter the path
premium/canada/mlaw.avi. Do not include the container name in this path. If the path
includes any folders that don't exist yet, the service creates them. For example, suppose
you have an existing premium/usa subfolder. If you specify premium/canada, the service
creates a canada subfolder in the premium folder. You then have two subfolders, usa and
canada, in the premium folder. There is no correlation between the path to the source and
the path (folders) in the container in AWS Elemental MediaStore. For more information about
folders and how they exist in a container, see the AWS Elemental MediaStore User Guide. The
file name is the name that is assigned to the file that you upload. The file can have the
same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The
file name can include or omit an extension.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Range"`: The range bytes of an object to retrieve. For more information about the Range
header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental
MediaStore ignores this header for partially uploaded objects that have streaming upload
availability.
"""
function get_object(Path; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore_data(
"GET", "/$(Path)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_object(
Path, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore_data(
"GET", "/$(Path)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_items()
list_items(params::Dict{String,<:Any})
Provides a list of metadata entries about folders and objects in the specified folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per API request. For example, you
submit a ListItems request with MaxResults set at 500. Although 2,000 items match your
request, the service returns no more than the first 500 items. (The service also returns a
NextToken value that you can use to fetch the next batch of results.) The service might
return fewer results than the MaxResults value. If MaxResults is not included in the
request, the service defaults to pagination with a maximum of 1,000 results per page.
- `"NextToken"`: The token that identifies which batch of results that you want to see. For
example, you submit a ListItems request with MaxResults set at 500. The service returns the
first batch of results (up to 500) and a NextToken value. To see the next batch of results,
you can submit the ListItems request a second time and specify the NextToken value. Tokens
expire after 15 minutes.
- `"Path"`: The path in the container from which to retrieve items. Format: <folder
name>/<folder name>/<file name>
"""
function list_items(; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore_data(
"GET", "/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_items(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediastore_data(
"GET", "/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_object(body, path)
put_object(body, path, params::Dict{String,<:Any})
Uploads an object to the specified path. Object sizes are limited to 25 MB for standard
upload availability and 10 MB for streaming upload availability.
# Arguments
- `body`: The bytes to be stored.
- `path`: The path (including the file name) where the object is stored in the container.
Format: <folder name>/<folder name>/<file name> For example, to upload
the file mlaw.avi to the folder path premiumcanada in the container movies, enter the path
premium/canada/mlaw.avi. Do not include the container name in this path. If the path
includes any folders that don't exist yet, the service creates them. For example, suppose
you have an existing premium/usa subfolder. If you specify premium/canada, the service
creates a canada subfolder in the premium folder. You then have two subfolders, usa and
canada, in the premium folder. There is no correlation between the path to the source and
the path (folders) in the container in AWS Elemental MediaStore. For more information about
folders and how they exist in a container, see the AWS Elemental MediaStore User Guide. The
file name is the name that is assigned to the file that you upload. The file can have the
same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The
file name can include or omit an extension.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cache-Control"`: An optional CacheControl header that allows the caller to control the
object's cache behavior. Headers can be passed in as specified in the HTTP at
https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9. Headers with a custom
user-defined value are also accepted.
- `"Content-Type"`: The content type of the object.
- `"x-amz-storage-class"`: Indicates the storage class of a Put request. Defaults to
high-performance temporal storage class, and objects are persisted into durable storage
shortly after being received.
- `"x-amz-upload-availability"`: Indicates the availability of an object while it is still
uploading. If the value is set to streaming, the object is available for downloading after
some initial buffering but before the object is uploaded completely. If the value is set to
standard, the object is available for downloading only when it is uploaded completely. The
default value for this header is standard. To use this header, you must also set the HTTP
Transfer-Encoding header to chunked.
"""
function put_object(Body, Path; aws_config::AbstractAWSConfig=global_aws_config())
return mediastore_data(
"PUT",
"/$(Path)",
Dict{String,Any}("Body" => Body);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_object(
Body,
Path,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediastore_data(
"PUT",
"/$(Path)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Body" => Body), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 63786 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mediatailor
using AWS.Compat
using AWS.UUIDs
"""
configure_logs_for_channel(channel_name, log_types)
configure_logs_for_channel(channel_name, log_types, params::Dict{String,<:Any})
Configures Amazon CloudWatch log settings for a channel.
# Arguments
- `channel_name`: The name of the channel.
- `log_types`: The types of logs to collect.
"""
function configure_logs_for_channel(
ChannelName, LogTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"PUT",
"/configureLogs/channel",
Dict{String,Any}("ChannelName" => ChannelName, "LogTypes" => LogTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_logs_for_channel(
ChannelName,
LogTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/configureLogs/channel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChannelName" => ChannelName, "LogTypes" => LogTypes),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
configure_logs_for_playback_configuration(percent_enabled, playback_configuration_name)
configure_logs_for_playback_configuration(percent_enabled, playback_configuration_name, params::Dict{String,<:Any})
Amazon CloudWatch log settings for a playback configuration.
# Arguments
- `percent_enabled`: The percentage of session logs that MediaTailor sends to your
Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and
percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch
Logs. MediaTailor decides at random which of the playback configuration sessions to send
logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100
- `playback_configuration_name`: The name of the playback configuration.
"""
function configure_logs_for_playback_configuration(
PercentEnabled,
PlaybackConfigurationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/configureLogs/playbackConfiguration",
Dict{String,Any}(
"PercentEnabled" => PercentEnabled,
"PlaybackConfigurationName" => PlaybackConfigurationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_logs_for_playback_configuration(
PercentEnabled,
PlaybackConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/configureLogs/playbackConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PercentEnabled" => PercentEnabled,
"PlaybackConfigurationName" => PlaybackConfigurationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel(channel_name, outputs, playback_mode)
create_channel(channel_name, outputs, playback_mode, params::Dict{String,<:Any})
Creates a channel. For information about MediaTailor channels, see Working with channels in
the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
- `outputs`: The channel's output properties.
- `playback_mode`: The type of playback mode to use for this channel. LINEAR - The
programs in the schedule play once back-to-back in the schedule. LOOP - The programs in
the schedule play back-to-back in an endless loop. When the last program in the schedule
stops playing, playback loops back to the first program in the schedule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Audiences"`: The list of audiences defined in channel.
- `"FillerSlate"`: The slate used to fill gaps between programs in the schedule. You must
configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't
support filler slate for channels using the LOOP PlaybackMode.
- `"Tier"`: The tier of the channel.
- `"TimeShiftConfiguration"`: The time-shifted viewing configuration you want to associate
to the channel.
- `"tags"`: The tags to assign to the channel. Tags are key-value pairs that you can
associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
"""
function create_channel(
ChannelName, Outputs, PlaybackMode; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"POST",
"/channel/$(ChannelName)",
Dict{String,Any}("Outputs" => Outputs, "PlaybackMode" => PlaybackMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel(
ChannelName,
Outputs,
PlaybackMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/channel/$(ChannelName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Outputs" => Outputs, "PlaybackMode" => PlaybackMode),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_live_source(http_package_configurations, live_source_name, source_location_name)
create_live_source(http_package_configurations, live_source_name, source_location_name, params::Dict{String,<:Any})
The live source configuration.
# Arguments
- `http_package_configurations`: A list of HTTP package configuration parameters for this
live source.
- `live_source_name`: The name of the live source.
- `source_location_name`: The name of the source location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags to assign to the live source. Tags are key-value pairs that you can
associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
"""
function create_live_source(
HttpPackageConfigurations,
LiveSourceName,
SourceLocationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)",
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_live_source(
HttpPackageConfigurations,
LiveSourceName,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_prefetch_schedule(consumption, name, playback_configuration_name, retrieval)
create_prefetch_schedule(consumption, name, playback_configuration_name, retrieval, params::Dict{String,<:Any})
Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to
tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more
information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
# Arguments
- `consumption`: The configuration settings for MediaTailor's consumption of the prefetched
ads from the ad decision server. Each consumption configuration contains an end time and an
optional start time that define the consumption window. Prefetch schedules automatically
expire no earlier than seven days after the end time.
- `name`: The name to assign to the schedule request.
- `playback_configuration_name`: The name to assign to the playback configuration.
- `retrieval`: The configuration settings for retrieval of prefetched ads from the ad
decision server. Only one set of prefetched ads will be retrieved and subsequently consumed
for each ad break.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StreamId"`: An optional stream identifier that MediaTailor uses to prefetch ads for
multiple streams that use the same playback configuration. If StreamId is specified,
MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not
specified, MediaTailor returns all of the prefetch schedules for the playback
configuration, regardless of StreamId.
"""
function create_prefetch_schedule(
Consumption,
Name,
PlaybackConfigurationName,
Retrieval;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/prefetchSchedule/$(PlaybackConfigurationName)/$(Name)",
Dict{String,Any}("Consumption" => Consumption, "Retrieval" => Retrieval);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_prefetch_schedule(
Consumption,
Name,
PlaybackConfigurationName,
Retrieval,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/prefetchSchedule/$(PlaybackConfigurationName)/$(Name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Consumption" => Consumption, "Retrieval" => Retrieval),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_program(channel_name, program_name, schedule_configuration, source_location_name)
create_program(channel_name, program_name, schedule_configuration, source_location_name, params::Dict{String,<:Any})
Creates a program within a channel. For information about programs, see Working with
programs in the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel for this Program.
- `program_name`: The name of the Program.
- `schedule_configuration`: The schedule configuration settings.
- `source_location_name`: The name of the source location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdBreaks"`: The ad break configuration settings.
- `"AudienceMedia"`: The list of AudienceMedia defined in program.
- `"LiveSourceName"`: The name of the LiveSource for this Program.
- `"VodSourceName"`: The name that's used to refer to a VOD source.
"""
function create_program(
ChannelName,
ProgramName,
ScheduleConfiguration,
SourceLocationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/channel/$(ChannelName)/program/$(ProgramName)",
Dict{String,Any}(
"ScheduleConfiguration" => ScheduleConfiguration,
"SourceLocationName" => SourceLocationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_program(
ChannelName,
ProgramName,
ScheduleConfiguration,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/channel/$(ChannelName)/program/$(ProgramName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ScheduleConfiguration" => ScheduleConfiguration,
"SourceLocationName" => SourceLocationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_source_location(http_configuration, source_location_name)
create_source_location(http_configuration, source_location_name, params::Dict{String,<:Any})
Creates a source location. A source location is a container for sources. For more
information about source locations, see Working with source locations in the MediaTailor
User Guide.
# Arguments
- `http_configuration`: The source's HTTP package configurations.
- `source_location_name`: The name associated with the source location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessConfiguration"`: Access configuration parameters. Configures the type of
authentication used to access content from your source location.
- `"DefaultSegmentDeliveryConfiguration"`: The optional configuration for the server that
serves segments.
- `"SegmentDeliveryConfigurations"`: A list of the segment delivery configurations
associated with this resource.
- `"tags"`: The tags to assign to the source location. Tags are key-value pairs that you
can associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
"""
function create_source_location(
HttpConfiguration, SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"POST",
"/sourceLocation/$(SourceLocationName)",
Dict{String,Any}("HttpConfiguration" => HttpConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_source_location(
HttpConfiguration,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/sourceLocation/$(SourceLocationName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HttpConfiguration" => HttpConfiguration), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vod_source(http_package_configurations, source_location_name, vod_source_name)
create_vod_source(http_package_configurations, source_location_name, vod_source_name, params::Dict{String,<:Any})
The VOD source configuration parameters.
# Arguments
- `http_package_configurations`: A list of HTTP package configuration parameters for this
VOD source.
- `source_location_name`: The name of the source location for this VOD source.
- `vod_source_name`: The name associated with the VOD source.>
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags to assign to the VOD source. Tags are key-value pairs that you can
associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
"""
function create_vod_source(
HttpPackageConfigurations,
SourceLocationName,
VodSourceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)",
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vod_source(
HttpPackageConfigurations,
SourceLocationName,
VodSourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel(channel_name)
delete_channel(channel_name, params::Dict{String,<:Any})
Deletes a channel. For information about MediaTailor channels, see Working with channels in
the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
"""
function delete_channel(ChannelName; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"DELETE",
"/channel/$(ChannelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/channel/$(ChannelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel_policy(channel_name)
delete_channel_policy(channel_name, params::Dict{String,<:Any})
The channel policy to delete.
# Arguments
- `channel_name`: The name of the channel associated with this channel policy.
"""
function delete_channel_policy(
ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/channel/$(ChannelName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_channel_policy(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/channel/$(ChannelName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_live_source(live_source_name, source_location_name)
delete_live_source(live_source_name, source_location_name, params::Dict{String,<:Any})
The live source to delete.
# Arguments
- `live_source_name`: The name of the live source.
- `source_location_name`: The name of the source location associated with this Live Source.
"""
function delete_live_source(
LiveSourceName, SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_live_source(
LiveSourceName,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_playback_configuration(name)
delete_playback_configuration(name, params::Dict{String,<:Any})
Deletes a playback configuration. For information about MediaTailor configurations, see
Working with configurations in AWS Elemental MediaTailor.
# Arguments
- `name`: The name of the playback configuration.
"""
function delete_playback_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/playbackConfiguration/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_playback_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/playbackConfiguration/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_prefetch_schedule(name, playback_configuration_name)
delete_prefetch_schedule(name, playback_configuration_name, params::Dict{String,<:Any})
Deletes a prefetch schedule for a specific playback configuration. If you call
DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404
status code. For more information about ad prefetching, see Using ad prefetching in the
MediaTailor User Guide.
# Arguments
- `name`: The name of the prefetch schedule. If the action is successful, the service sends
back an HTTP 204 response with an empty HTTP body.
- `playback_configuration_name`: The name of the playback configuration for this prefetch
schedule.
"""
function delete_prefetch_schedule(
Name, PlaybackConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/prefetchSchedule/$(PlaybackConfigurationName)/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_prefetch_schedule(
Name,
PlaybackConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/prefetchSchedule/$(PlaybackConfigurationName)/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_program(channel_name, program_name)
delete_program(channel_name, program_name, params::Dict{String,<:Any})
Deletes a program within a channel. For information about programs, see Working with
programs in the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
- `program_name`: The name of the program.
"""
function delete_program(
ChannelName, ProgramName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/channel/$(ChannelName)/program/$(ProgramName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_program(
ChannelName,
ProgramName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/channel/$(ChannelName)/program/$(ProgramName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_source_location(source_location_name)
delete_source_location(source_location_name, params::Dict{String,<:Any})
Deletes a source location. A source location is a container for sources. For more
information about source locations, see Working with source locations in the MediaTailor
User Guide.
# Arguments
- `source_location_name`: The name of the source location.
"""
function delete_source_location(
SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/sourceLocation/$(SourceLocationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_source_location(
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/sourceLocation/$(SourceLocationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vod_source(source_location_name, vod_source_name)
delete_vod_source(source_location_name, vod_source_name, params::Dict{String,<:Any})
The video on demand (VOD) source to delete.
# Arguments
- `source_location_name`: The name of the source location associated with this VOD Source.
- `vod_source_name`: The name of the VOD source.
"""
function delete_vod_source(
SourceLocationName, VodSourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vod_source(
SourceLocationName,
VodSourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_channel(channel_name)
describe_channel(channel_name, params::Dict{String,<:Any})
Describes a channel. For information about MediaTailor channels, see Working with channels
in the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
"""
function describe_channel(ChannelName; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET",
"/channel/$(ChannelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_channel(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/channel/$(ChannelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_live_source(live_source_name, source_location_name)
describe_live_source(live_source_name, source_location_name, params::Dict{String,<:Any})
The live source to describe.
# Arguments
- `live_source_name`: The name of the live source.
- `source_location_name`: The name of the source location associated with this Live Source.
"""
function describe_live_source(
LiveSourceName, SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_live_source(
LiveSourceName,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_program(channel_name, program_name)
describe_program(channel_name, program_name, params::Dict{String,<:Any})
Describes a program within a channel. For information about programs, see Working with
programs in the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel associated with this Program.
- `program_name`: The name of the program.
"""
function describe_program(
ChannelName, ProgramName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/channel/$(ChannelName)/program/$(ProgramName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_program(
ChannelName,
ProgramName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/channel/$(ChannelName)/program/$(ProgramName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_source_location(source_location_name)
describe_source_location(source_location_name, params::Dict{String,<:Any})
Describes a source location. A source location is a container for sources. For more
information about source locations, see Working with source locations in the MediaTailor
User Guide.
# Arguments
- `source_location_name`: The name of the source location.
"""
function describe_source_location(
SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_source_location(
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vod_source(source_location_name, vod_source_name)
describe_vod_source(source_location_name, vod_source_name, params::Dict{String,<:Any})
Provides details about a specific video on demand (VOD) source in a specific source
location.
# Arguments
- `source_location_name`: The name of the source location associated with this VOD Source.
- `vod_source_name`: The name of the VOD Source.
"""
function describe_vod_source(
SourceLocationName, VodSourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vod_source(
SourceLocationName,
VodSourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channel_policy(channel_name)
get_channel_policy(channel_name, params::Dict{String,<:Any})
Returns the channel's IAM policy. IAM policies are used to control access to your channel.
# Arguments
- `channel_name`: The name of the channel associated with this Channel Policy.
"""
function get_channel_policy(ChannelName; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET",
"/channel/$(ChannelName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channel_policy(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/channel/$(ChannelName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channel_schedule(channel_name)
get_channel_schedule(channel_name, params::Dict{String,<:Any})
Retrieves information about your channel's schedule.
# Arguments
- `channel_name`: The name of the channel associated with this Channel Schedule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"audience"`: The single audience for GetChannelScheduleRequest.
- `"durationMinutes"`: The duration in minutes of the channel schedule.
- `"maxResults"`: The maximum number of channel schedules that you want MediaTailor to
return in response to the current request. If there are more than MaxResults channel
schedules, use the value of NextToken in the response to get the next page of results.
- `"nextToken"`: (Optional) If the playback configuration has more than MaxResults channel
schedules, use NextToken to get the second and subsequent pages of results. For the first
GetChannelScheduleRequest request, omit this value. For the second and subsequent requests,
get the value of NextToken from the previous response and specify that value for NextToken
in the request. If the previous response didn't include a NextToken element, there are no
more channel schedules to get.
"""
function get_channel_schedule(
ChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/channel/$(ChannelName)/schedule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channel_schedule(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/channel/$(ChannelName)/schedule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_playback_configuration(name)
get_playback_configuration(name, params::Dict{String,<:Any})
Retrieves a playback configuration. For information about MediaTailor configurations, see
Working with configurations in AWS Elemental MediaTailor.
# Arguments
- `name`: The identifier for the playback configuration.
"""
function get_playback_configuration(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET",
"/playbackConfiguration/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_playback_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/playbackConfiguration/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_prefetch_schedule(name, playback_configuration_name)
get_prefetch_schedule(name, playback_configuration_name, params::Dict{String,<:Any})
Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you
to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more
information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
# Arguments
- `name`: The name of the prefetch schedule. The name must be unique among all prefetch
schedules that are associated with the specified playback configuration.
- `playback_configuration_name`: Returns information about the prefetch schedule for a
specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch
schedule, MediaTailor returns an HTTP 404 status code.
"""
function get_prefetch_schedule(
Name, PlaybackConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/prefetchSchedule/$(PlaybackConfigurationName)/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_prefetch_schedule(
Name,
PlaybackConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/prefetchSchedule/$(PlaybackConfigurationName)/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_alerts(resource_arn)
list_alerts(resource_arn, params::Dict{String,<:Any})
Lists the alerts that are associated with a MediaTailor channel assembly resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of alerts that you want MediaTailor to return in
response to the current request. If there are more than MaxResults alerts, use the value of
NextToken in the response to get the next page of results.
- `"nextToken"`: Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
"""
function list_alerts(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET",
"/alerts",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_alerts(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/alerts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channels()
list_channels(params::Dict{String,<:Any})
Retrieves information about the channels that are associated with the current AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of channels that you want MediaTailor to return in
response to the current request. If there are more than MaxResults channels, use the value
of NextToken in the response to get the next page of results.
- `"nextToken"`: Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
"""
function list_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET", "/channels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET", "/channels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_live_sources(source_location_name)
list_live_sources(source_location_name, params::Dict{String,<:Any})
Lists the live sources contained in a source location. A source represents a piece of
content.
# Arguments
- `source_location_name`: The name of the source location associated with this Live Sources
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of live sources that you want MediaTailor to return in
response to the current request. If there are more than MaxResults live sources, use the
value of NextToken in the response to get the next page of results.
- `"nextToken"`: Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
"""
function list_live_sources(
SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/liveSources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_live_sources(
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/liveSources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_playback_configurations()
list_playback_configurations(params::Dict{String,<:Any})
Retrieves existing playback configurations. For information about MediaTailor
configurations, see Working with Configurations in AWS Elemental MediaTailor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of playback configurations that you want MediaTailor
to return in response to the current request. If there are more than MaxResults playback
configurations, use the value of NextToken in the response to get the next page of results.
- `"NextToken"`: Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
"""
function list_playback_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET",
"/playbackConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_playback_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/playbackConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_prefetch_schedules(playback_configuration_name)
list_prefetch_schedules(playback_configuration_name, params::Dict{String,<:Any})
Lists the prefetch schedules for a playback configuration.
# Arguments
- `playback_configuration_name`: Retrieves the prefetch schedule(s) for a specific playback
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of prefetch schedules that you want MediaTailor to
return in response to the current request. If there are more than MaxResults prefetch
schedules, use the value of NextToken in the response to get the next page of results.
- `"NextToken"`: (Optional) If the playback configuration has more than MaxResults prefetch
schedules, use NextToken to get the second and subsequent pages of results. For the first
ListPrefetchSchedulesRequest request, omit this value. For the second and subsequent
requests, get the value of NextToken from the previous response and specify that value for
NextToken in the request. If the previous response didn't include a NextToken element,
there are no more prefetch schedules to get.
- `"StreamId"`: An optional filtering parameter whereby MediaTailor filters the prefetch
schedules to include only specific streams.
"""
function list_prefetch_schedules(
PlaybackConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"POST",
"/prefetchSchedule/$(PlaybackConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_prefetch_schedules(
PlaybackConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/prefetchSchedule/$(PlaybackConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_source_locations()
list_source_locations(params::Dict{String,<:Any})
Lists the source locations for a channel. A source location defines the host server URL,
and contains a list of sources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of source locations that you want MediaTailor to
return in response to the current request. If there are more than MaxResults source
locations, use the value of NextToken in the response to get the next page of results.
- `"nextToken"`: Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
"""
function list_source_locations(; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"GET", "/sourceLocations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_source_locations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/sourceLocations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
A list of tags that are associated with this resource. Tags are key-value pairs that you
can associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) associated with this resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vod_sources(source_location_name)
list_vod_sources(source_location_name, params::Dict{String,<:Any})
Lists the VOD sources contained in a source location. A source represents a piece of
content.
# Arguments
- `source_location_name`: The name of the source location associated with this VOD Source
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of VOD sources that you want MediaTailor to return in
response to the current request. If there are more than MaxResults VOD sources, use the
value of NextToken in the response to get the next page of results.
- `"nextToken"`: Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
"""
function list_vod_sources(
SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/vodSources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vod_sources(
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"GET",
"/sourceLocation/$(SourceLocationName)/vodSources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_channel_policy(channel_name, policy)
put_channel_policy(channel_name, policy, params::Dict{String,<:Any})
Creates an IAM policy for the channel. IAM policies are used to control access to your
channel.
# Arguments
- `channel_name`: The channel name associated with this Channel Policy.
- `policy`: Adds an IAM role that determines the permissions of your channel.
"""
function put_channel_policy(
ChannelName, Policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)/policy",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_channel_policy(
ChannelName,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_playback_configuration(name)
put_playback_configuration(name, params::Dict{String,<:Any})
Creates a playback configuration. For information about MediaTailor configurations, see
Working with configurations in AWS Elemental MediaTailor.
# Arguments
- `name`: The identifier for the playback configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdDecisionServerUrl"`: The URL for the ad decision server (ADS). This includes the
specification of static parameters and placeholders for dynamic parameters. AWS Elemental
MediaTailor substitutes player-specific and session-specific parameters as needed when
calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum
length is 25,000 characters.
- `"AvailSuppression"`: The configuration for avail suppression, also known as ad
suppression. For more information about ad suppression, see Ad Suppression.
- `"Bumper"`: The configuration for bumpers. Bumpers are short audio or video clips that
play at the start or before the end of an ad break. To learn more about bumpers, see
Bumpers.
- `"CdnConfiguration"`: The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
- `"ConfigurationAliases"`: The player parameters and aliases used as dynamic variables
during session initialization. For more information, see Domain Variables.
- `"DashConfiguration"`: The configuration for DASH content.
- `"InsertionMode"`: The setting that controls whether players can use stitched or guided
ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched
(server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched
or guided ad insertion at session-initialization time. The default for players that do not
specify an insertion mode is stitched.
- `"LivePreRollConfiguration"`: The configuration for pre-roll ad insertion.
- `"ManifestProcessingRules"`: The configuration for manifest processing rules. Manifest
processing rules enable customization of the personalized manifests created by MediaTailor.
- `"PersonalizationThresholdSeconds"`: Defines the maximum duration of underfilled ad time
(in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the
personalization threshold, then the personalization of the ad break is abandoned and the
underlying content is shown. This feature applies to ad replacement in live and VOD
streams, rather than ad insertion, because it relies on an underlying content stream. For
more information about ad break behavior, including ad replacement and insertion, see Ad
Behavior in AWS Elemental MediaTailor.
- `"SlateAdUrl"`: The URL for a high-quality video asset to transcode and use to fill in
time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in
media content. Configuring the slate is optional for non-VPAID configurations. For VPAID,
the slate is required because MediaTailor provides it in the slots that are designated for
dynamic ad content. The slate must be a high-quality asset that contains both audio and
video.
- `"TranscodeProfileName"`: The name that is used to associate this playback configuration
with a custom transcode profile. This overrides the dynamic transcoding defaults of
MediaTailor. Use this only if you have already set up custom profiles with the help of AWS
Support.
- `"VideoContentSourceUrl"`: The URL prefix for the parent manifest for the stream, minus
the asset ID. The maximum length is 512 characters.
- `"tags"`: The tags to assign to the playback configuration. Tags are key-value pairs that
you can associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
"""
function put_playback_configuration(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"PUT",
"/playbackConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_playback_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"PUT",
"/playbackConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_channel(channel_name)
start_channel(channel_name, params::Dict{String,<:Any})
Starts a channel. For information about MediaTailor channels, see Working with channels in
the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
"""
function start_channel(ChannelName; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"PUT",
"/channel/$(ChannelName)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_channel(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_channel(channel_name)
stop_channel(channel_name, params::Dict{String,<:Any})
Stops a channel. For information about MediaTailor channels, see Working with channels in
the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
"""
function stop_channel(ChannelName; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"PUT",
"/channel/$(ChannelName)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_channel(
ChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
The resource to tag. Tags are key-value pairs that you can associate with Amazon resources
to help with organization, access control, and cost tracking. For more information, see
Tagging AWS Elemental MediaTailor Resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) associated with the resource.
- `tags`: The tags to assign to the resource. Tags are key-value pairs that you can
associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
"""
function tag_resource(ResourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mediatailor(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
The resource to untag.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to untag.
- `tag_keys`: The tag keys associated with the resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_channel(channel_name, outputs)
update_channel(channel_name, outputs, params::Dict{String,<:Any})
Updates a channel. For information about MediaTailor channels, see Working with channels in
the MediaTailor User Guide.
# Arguments
- `channel_name`: The name of the channel.
- `outputs`: The channel's output properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Audiences"`: The list of audiences defined in channel.
- `"FillerSlate"`: The slate used to fill gaps between programs in the schedule. You must
configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't
support filler slate for channels using the LOOP PlaybackMode.
- `"TimeShiftConfiguration"`: The time-shifted viewing configuration you want to associate
to the channel.
"""
function update_channel(
ChannelName, Outputs; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)",
Dict{String,Any}("Outputs" => Outputs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel(
ChannelName,
Outputs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Outputs" => Outputs), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_live_source(http_package_configurations, live_source_name, source_location_name)
update_live_source(http_package_configurations, live_source_name, source_location_name, params::Dict{String,<:Any})
Updates a live source's configuration.
# Arguments
- `http_package_configurations`: A list of HTTP package configurations for the live source
on this account.
- `live_source_name`: The name of the live source.
- `source_location_name`: The name of the source location associated with this Live Source.
"""
function update_live_source(
HttpPackageConfigurations,
LiveSourceName,
SourceLocationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)",
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_live_source(
HttpPackageConfigurations,
LiveSourceName,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/sourceLocation/$(SourceLocationName)/liveSource/$(LiveSourceName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_program(channel_name, program_name, schedule_configuration)
update_program(channel_name, program_name, schedule_configuration, params::Dict{String,<:Any})
Updates a program within a channel.
# Arguments
- `channel_name`: The name of the channel for this Program.
- `program_name`: The name of the Program.
- `schedule_configuration`: The schedule configuration settings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdBreaks"`: The ad break configuration settings.
- `"AudienceMedia"`: The list of AudienceMedia defined in program.
"""
function update_program(
ChannelName,
ProgramName,
ScheduleConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)/program/$(ProgramName)",
Dict{String,Any}("ScheduleConfiguration" => ScheduleConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_program(
ChannelName,
ProgramName,
ScheduleConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/channel/$(ChannelName)/program/$(ProgramName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ScheduleConfiguration" => ScheduleConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_source_location(http_configuration, source_location_name)
update_source_location(http_configuration, source_location_name, params::Dict{String,<:Any})
Updates a source location. A source location is a container for sources. For more
information about source locations, see Working with source locations in the MediaTailor
User Guide.
# Arguments
- `http_configuration`: The HTTP configuration for the source location.
- `source_location_name`: The name of the source location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessConfiguration"`: Access configuration parameters. Configures the type of
authentication used to access content from your source location.
- `"DefaultSegmentDeliveryConfiguration"`: The optional configuration for the host server
that serves segments.
- `"SegmentDeliveryConfigurations"`: A list of the segment delivery configurations
associated with this resource.
"""
function update_source_location(
HttpConfiguration, SourceLocationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return mediatailor(
"PUT",
"/sourceLocation/$(SourceLocationName)",
Dict{String,Any}("HttpConfiguration" => HttpConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_source_location(
HttpConfiguration,
SourceLocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/sourceLocation/$(SourceLocationName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HttpConfiguration" => HttpConfiguration), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vod_source(http_package_configurations, source_location_name, vod_source_name)
update_vod_source(http_package_configurations, source_location_name, vod_source_name, params::Dict{String,<:Any})
Updates a VOD source's configuration.
# Arguments
- `http_package_configurations`: A list of HTTP package configurations for the VOD source
on this account.
- `source_location_name`: The name of the source location associated with this VOD Source.
- `vod_source_name`: The name of the VOD source.
"""
function update_vod_source(
HttpPackageConfigurations,
SourceLocationName,
VodSourceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)",
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vod_source(
HttpPackageConfigurations,
SourceLocationName,
VodSourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mediatailor(
"PUT",
"/sourceLocation/$(SourceLocationName)/vodSource/$(VodSourceName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HttpPackageConfigurations" => HttpPackageConfigurations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 22688 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: medical_imaging
using AWS.Compat
using AWS.UUIDs
"""
copy_image_set(copy_image_set_information, datastore_id, source_image_set_id)
copy_image_set(copy_image_set_information, datastore_id, source_image_set_id, params::Dict{String,<:Any})
Copy an image set.
# Arguments
- `copy_image_set_information`: Copy image set information.
- `datastore_id`: The data store identifier.
- `source_image_set_id`: The source image set identifier.
"""
function copy_image_set(
copyImageSetInformation,
datastoreId,
sourceImageSetId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(sourceImageSetId)/copyImageSet",
Dict{String,Any}("copyImageSetInformation" => copyImageSetInformation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_image_set(
copyImageSetInformation,
datastoreId,
sourceImageSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(sourceImageSetId)/copyImageSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("copyImageSetInformation" => copyImageSetInformation),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_datastore(client_token)
create_datastore(client_token, params::Dict{String,<:Any})
Create a data store.
# Arguments
- `client_token`: A unique identifier for API idempotency.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datastoreName"`: The data store name.
- `"kmsKeyArn"`: The Amazon Resource Name (ARN) assigned to the Key Management Service
(KMS) key for accessing encrypted data.
- `"tags"`: The tags provided when creating a data store.
"""
function create_datastore(clientToken; aws_config::AbstractAWSConfig=global_aws_config())
return medical_imaging(
"POST",
"/datastore",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_datastore(
clientToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_datastore(datastore_id)
delete_datastore(datastore_id, params::Dict{String,<:Any})
Delete a data store. Before a data store can be deleted, you must first delete all image
sets within it.
# Arguments
- `datastore_id`: The data store identifier.
"""
function delete_datastore(datastoreId; aws_config::AbstractAWSConfig=global_aws_config())
return medical_imaging(
"DELETE",
"/datastore/$(datastoreId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_datastore(
datastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"DELETE",
"/datastore/$(datastoreId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_image_set(datastore_id, image_set_id)
delete_image_set(datastore_id, image_set_id, params::Dict{String,<:Any})
Delete an image set.
# Arguments
- `datastore_id`: The data store identifier.
- `image_set_id`: The image set identifier.
"""
function delete_image_set(
datastoreId, imageSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/deleteImageSet";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_image_set(
datastoreId,
imageSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/deleteImageSet",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_datastore(datastore_id)
get_datastore(datastore_id, params::Dict{String,<:Any})
Get data store properties.
# Arguments
- `datastore_id`: The data store identifier.
"""
function get_datastore(datastoreId; aws_config::AbstractAWSConfig=global_aws_config())
return medical_imaging(
"GET",
"/datastore/$(datastoreId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_datastore(
datastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"GET",
"/datastore/$(datastoreId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dicomimport_job(datastore_id, job_id)
get_dicomimport_job(datastore_id, job_id, params::Dict{String,<:Any})
Get the import job properties to learn more about the job or job progress. The jobStatus
refers to the execution of the import job. Therefore, an import job can return a jobStatus
as COMPLETED even if validation issues are discovered during the import process. If a
jobStatus returns as COMPLETED, we still recommend you review the output manifests written
to S3, as they provide details on the success or failure of individual P10 object imports.
# Arguments
- `datastore_id`: The data store identifier.
- `job_id`: The import job identifier.
"""
function get_dicomimport_job(
datastoreId, jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"GET",
"/getDICOMImportJob/datastore/$(datastoreId)/job/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dicomimport_job(
datastoreId,
jobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"GET",
"/getDICOMImportJob/datastore/$(datastoreId)/job/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_frame(datastore_id, image_frame_information, image_set_id)
get_image_frame(datastore_id, image_frame_information, image_set_id, params::Dict{String,<:Any})
Get an image frame (pixel data) for an image set.
# Arguments
- `datastore_id`: The data store identifier.
- `image_frame_information`: Information about the image frame (pixel data) identifier.
- `image_set_id`: The image set identifier.
"""
function get_image_frame(
datastoreId,
imageFrameInformation,
imageSetId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/getImageFrame",
Dict{String,Any}("imageFrameInformation" => imageFrameInformation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_frame(
datastoreId,
imageFrameInformation,
imageSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/getImageFrame",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageFrameInformation" => imageFrameInformation),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_set(datastore_id, image_set_id)
get_image_set(datastore_id, image_set_id, params::Dict{String,<:Any})
Get image set properties.
# Arguments
- `datastore_id`: The data store identifier.
- `image_set_id`: The image set identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The image set version identifier.
"""
function get_image_set(
datastoreId, imageSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/getImageSet";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_set(
datastoreId,
imageSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/getImageSet",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_set_metadata(datastore_id, image_set_id)
get_image_set_metadata(datastore_id, image_set_id, params::Dict{String,<:Any})
Get metadata attributes for an image set.
# Arguments
- `datastore_id`: The data store identifier.
- `image_set_id`: The image set identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The image set version identifier.
"""
function get_image_set_metadata(
datastoreId, imageSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/getImageSetMetadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_set_metadata(
datastoreId,
imageSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/getImageSetMetadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datastores()
list_datastores(params::Dict{String,<:Any})
List data stores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datastoreStatus"`: The data store status.
- `"maxResults"`: Valid Range: Minimum value of 1. Maximum value of 50.
- `"nextToken"`: The pagination token used to request the list of data stores on the next
page.
"""
function list_datastores(; aws_config::AbstractAWSConfig=global_aws_config())
return medical_imaging(
"GET", "/datastore"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datastores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"GET", "/datastore", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_dicomimport_jobs(datastore_id)
list_dicomimport_jobs(datastore_id, params::Dict{String,<:Any})
List import jobs created for a specific data store.
# Arguments
- `datastore_id`: The data store identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobStatus"`: The filters for listing import jobs based on status.
- `"maxResults"`: The max results count. The upper bound is determined by load testing.
- `"nextToken"`: The pagination token used to request the list of import jobs on the next
page.
"""
function list_dicomimport_jobs(
datastoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"GET",
"/listDICOMImportJobs/datastore/$(datastoreId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dicomimport_jobs(
datastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"GET",
"/listDICOMImportJobs/datastore/$(datastoreId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_set_versions(datastore_id, image_set_id)
list_image_set_versions(datastore_id, image_set_id, params::Dict{String,<:Any})
List image set versions.
# Arguments
- `datastore_id`: The data store identifier.
- `image_set_id`: The image set identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The max results count.
- `"nextToken"`: The pagination token used to request the list of image set versions on the
next page.
"""
function list_image_set_versions(
datastoreId, imageSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/listImageSetVersions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_set_versions(
datastoreId,
imageSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/listImageSetVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags associated with a medical imaging resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the medical imaging resource to list
tags for.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_image_sets(datastore_id)
search_image_sets(datastore_id, params::Dict{String,<:Any})
Search image sets based on defined input attributes. SearchImageSets accepts a single
search query parameter and returns a paginated response of all image sets that have the
matching criteria. All date range queries must be input as (lowerBound, upperBound). By
default, SearchImageSets uses the updatedAt field for sorting in descending order from
newest to oldest.
# Arguments
- `datastore_id`: The identifier of the data store where the image sets reside.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that can be returned in a search.
- `"nextToken"`: The token used for pagination of results returned in the response. Use the
token returned from the previous request to continue results where the previous request
ended.
- `"searchCriteria"`: The search criteria that filters by applying a maximum of 1 item to
SearchByAttribute.
"""
function search_image_sets(datastoreId; aws_config::AbstractAWSConfig=global_aws_config())
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/searchImageSets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_image_sets(
datastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/searchImageSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dicomimport_job(client_token, data_access_role_arn, datastore_id, input_s3_uri, output_s3_uri)
start_dicomimport_job(client_token, data_access_role_arn, datastore_id, input_s3_uri, output_s3_uri, params::Dict{String,<:Any})
Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files
found in the S3 prefix specified by the inputS3Uri parameter. The import job stores
processing results in the file specified by the outputS3Uri parameter.
# Arguments
- `client_token`: A unique identifier for API idempotency.
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants
permission to access medical imaging resources.
- `datastore_id`: The data store identifier.
- `input_s3_uri`: The input prefix path for the S3 bucket that contains the DICOM files to
be imported.
- `output_s3_uri`: The output prefix of the S3 bucket to upload the results of the DICOM
import job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"inputOwnerAccountId"`: The account ID of the source S3 bucket owner.
- `"jobName"`: The import job name.
"""
function start_dicomimport_job(
clientToken,
dataAccessRoleArn,
datastoreId,
inputS3Uri,
outputS3Uri;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/startDICOMImportJob/datastore/$(datastoreId)",
Dict{String,Any}(
"clientToken" => clientToken,
"dataAccessRoleArn" => dataAccessRoleArn,
"inputS3Uri" => inputS3Uri,
"outputS3Uri" => outputS3Uri,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_dicomimport_job(
clientToken,
dataAccessRoleArn,
datastoreId,
inputS3Uri,
outputS3Uri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/startDICOMImportJob/datastore/$(datastoreId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"dataAccessRoleArn" => dataAccessRoleArn,
"inputS3Uri" => inputS3Uri,
"outputS3Uri" => outputS3Uri,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds a user-specifed key and value tag to a medical imaging resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the medical imaging resource that tags
are being added to.
- `tags`: The user-specified key and value tag pairs added to a medical imaging resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return medical_imaging(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a medical imaging resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the medical imaging resource that tags
are being removed from.
- `tag_keys`: The keys for the tags to be removed from the medical imaging resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return medical_imaging(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_image_set_metadata(datastore_id, image_set_id, latest_version, update_image_set_metadata_updates)
update_image_set_metadata(datastore_id, image_set_id, latest_version, update_image_set_metadata_updates, params::Dict{String,<:Any})
Update image set metadata attributes.
# Arguments
- `datastore_id`: The data store identifier.
- `image_set_id`: The image set identifier.
- `latest_version`: The latest image set version identifier.
- `update_image_set_metadata_updates`: Update image set metadata updates.
"""
function update_image_set_metadata(
datastoreId,
imageSetId,
latestVersion,
updateImageSetMetadataUpdates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/updateImageSetMetadata",
Dict{String,Any}(
"latestVersion" => latestVersion,
"updateImageSetMetadataUpdates" => updateImageSetMetadataUpdates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_image_set_metadata(
datastoreId,
imageSetId,
latestVersion,
updateImageSetMetadataUpdates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return medical_imaging(
"POST",
"/datastore/$(datastoreId)/imageSet/$(imageSetId)/updateImageSetMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"latestVersion" => latestVersion,
"updateImageSetMetadataUpdates" => updateImageSetMetadataUpdates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 60909 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: memorydb
using AWS.Compat
using AWS.UUIDs
"""
batch_update_cluster(cluster_names)
batch_update_cluster(cluster_names, params::Dict{String,<:Any})
Apply the service update to a list of clusters supplied. For more information on service
updates and applying them, see Applying the service updates.
# Arguments
- `cluster_names`: The cluster names to apply the updates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ServiceUpdate"`: The unique ID of the service update
"""
function batch_update_cluster(
ClusterNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"BatchUpdateCluster",
Dict{String,Any}("ClusterNames" => ClusterNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_cluster(
ClusterNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"BatchUpdateCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterNames" => ClusterNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_snapshot(source_snapshot_name, target_snapshot_name)
copy_snapshot(source_snapshot_name, target_snapshot_name, params::Dict{String,<:Any})
Makes a copy of an existing snapshot.
# Arguments
- `source_snapshot_name`: The name of an existing snapshot from which to make a copy.
- `target_snapshot_name`: A name for the snapshot copy. MemoryDB does not permit
overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or
an Amazon S3 bucket if exporting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the target snapshot.
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
- `"TargetBucket"`: The Amazon S3 bucket to which the snapshot is exported. This parameter
is used only when exporting a snapshot for external access. When using this parameter to
export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more
information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.
"""
function copy_snapshot(
SourceSnapshotName,
TargetSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CopySnapshot",
Dict{String,Any}(
"SourceSnapshotName" => SourceSnapshotName,
"TargetSnapshotName" => TargetSnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_snapshot(
SourceSnapshotName,
TargetSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CopySnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceSnapshotName" => SourceSnapshotName,
"TargetSnapshotName" => TargetSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_acl(aclname)
create_acl(aclname, params::Dict{String,<:Any})
Creates an Access Control List. For more information, see Authenticating users with Access
Contol Lists (ACLs).
# Arguments
- `aclname`: The name of the Access Control List.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
- `"UserNames"`: The list of users that belong to the Access Control List.
"""
function create_acl(ACLName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"CreateACL",
Dict{String,Any}("ACLName" => ACLName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_acl(
ACLName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateACL",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ACLName" => ACLName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(aclname, cluster_name, node_type)
create_cluster(aclname, cluster_name, node_type, params::Dict{String,<:Any})
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
# Arguments
- `aclname`: The name of the Access Control List to associate with the cluster.
- `cluster_name`: The name of the cluster. This value must be unique as it also serves as
the cluster identifier.
- `node_type`: The compute and memory capacity of the nodes in the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoMinorVersionUpgrade"`: When set to true, the cluster will automatically receive
minor engine version upgrades after launch.
- `"DataTiering"`: Enables data tiering. Data tiering is only supported for clusters using
the r6gd node type. This parameter must be set when using r6gd nodes. For more information,
see Data tiering.
- `"Description"`: An optional description of the cluster.
- `"EngineVersion"`: The version number of the Redis engine to be used for the cluster.
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the cluster.
- `"MaintenanceWindow"`: Specifies the weekly time range during which maintenance on the
cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H
Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:
sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
- `"NumReplicasPerShard"`: The number of replicas to apply to each shard. The default value
is 1. The maximum is 5.
- `"NumShards"`: The number of shards the cluster will contain. The default value is 1.
- `"ParameterGroupName"`: The name of the parameter group associated with the cluster.
- `"Port"`: The port number on which each of the nodes accepts connections.
- `"SecurityGroupIds"`: A list of security group names to associate with this cluster.
- `"SnapshotArns"`: A list of Amazon Resource Names (ARN) that uniquely identify the RDB
snapshot files stored in Amazon S3. The snapshot files are used to populate the new
cluster. The Amazon S3 object name in the ARN cannot contain any commas.
- `"SnapshotName"`: The name of a snapshot from which to restore data into the new cluster.
The snapshot status changes to restoring while the new cluster is being created.
- `"SnapshotRetentionLimit"`: The number of days for which MemoryDB retains automatic
snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a
snapshot that was taken today is retained for 5 days before being deleted.
- `"SnapshotWindow"`: The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter,
MemoryDB automatically chooses an appropriate time range.
- `"SnsTopicArn"`: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(SNS) topic to which notifications are sent.
- `"SubnetGroupName"`: The name of the subnet group to be used for the cluster.
- `"TLSEnabled"`: A flag to enable in-transit encryption on the cluster.
- `"Tags"`: A list of tags to be added to this resource. Tags are comma-separated key,value
pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following:
Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
"""
function create_cluster(
ACLName, ClusterName, NodeType; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateCluster",
Dict{String,Any}(
"ACLName" => ACLName, "ClusterName" => ClusterName, "NodeType" => NodeType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
ACLName,
ClusterName,
NodeType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ACLName" => ACLName,
"ClusterName" => ClusterName,
"NodeType" => NodeType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_parameter_group(family, parameter_group_name)
create_parameter_group(family, parameter_group_name, params::Dict{String,<:Any})
Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and
their values that are applied to all of the nodes in any cluster. For more information, see
Configuring engine parameters using parameter groups.
# Arguments
- `family`: The name of the parameter group family that the parameter group can be used
with.
- `parameter_group_name`: The name of the parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description of the parameter group.
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
"""
function create_parameter_group(
Family, ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateParameterGroup",
Dict{String,Any}("Family" => Family, "ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_parameter_group(
Family,
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Family" => Family, "ParameterGroupName" => ParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(cluster_name, snapshot_name)
create_snapshot(cluster_name, snapshot_name, params::Dict{String,<:Any})
Creates a copy of an entire cluster at a specific moment in time.
# Arguments
- `cluster_name`: The snapshot is created from this cluster.
- `snapshot_name`: A name for the snapshot being created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the snapshot.
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
"""
function create_snapshot(
ClusterName, SnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateSnapshot",
Dict{String,Any}("ClusterName" => ClusterName, "SnapshotName" => SnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
ClusterName,
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName, "SnapshotName" => SnapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subnet_group(subnet_group_name, subnet_ids)
create_subnet_group(subnet_group_name, subnet_ids, params::Dict{String,<:Any})
Creates a subnet group. A subnet group is a collection of subnets (typically private) that
you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC)
environment. When you create a cluster in an Amazon VPC, you must specify a subnet group.
MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to
associate with your nodes. For more information, see Subnets and subnet groups.
# Arguments
- `subnet_group_name`: The name of the subnet group.
- `subnet_ids`: A list of VPC subnet IDs for the subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the subnet group.
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
"""
function create_subnet_group(
SubnetGroupName, SubnetIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateSubnetGroup",
Dict{String,Any}("SubnetGroupName" => SubnetGroupName, "SubnetIds" => SubnetIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subnet_group(
SubnetGroupName,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SubnetGroupName" => SubnetGroupName, "SubnetIds" => SubnetIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(access_string, authentication_mode, user_name)
create_user(access_string, authentication_mode, user_name, params::Dict{String,<:Any})
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol
Lists (ACLs).
# Arguments
- `access_string`: Access permissions string used for this user.
- `authentication_mode`: Denotes the user's authentication properties, such as whether it
requires a password to authenticate.
- `user_name`: The name of the user. This value must be unique as it also serves as the
user identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
"""
function create_user(
AccessString,
AuthenticationMode,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateUser",
Dict{String,Any}(
"AccessString" => AccessString,
"AuthenticationMode" => AuthenticationMode,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
AccessString,
AuthenticationMode,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessString" => AccessString,
"AuthenticationMode" => AuthenticationMode,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_acl(aclname)
delete_acl(aclname, params::Dict{String,<:Any})
Deletes an Access Control List. The ACL must first be disassociated from the cluster before
it can be deleted. For more information, see Authenticating users with Access Contol Lists
(ACLs).
# Arguments
- `aclname`: The name of the Access Control List to delete
"""
function delete_acl(ACLName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteACL",
Dict{String,Any}("ACLName" => ACLName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_acl(
ACLName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DeleteACL",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ACLName" => ACLName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_name)
delete_cluster(cluster_name, params::Dict{String,<:Any})
Deletes a cluster. It also deletes all associated nodes and node endpoints
# Arguments
- `cluster_name`: The name of the cluster to be deleted
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalSnapshotName"`: The user-supplied name of a final cluster snapshot. This is the
unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes
the cluster immediately afterward.
"""
function delete_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteCluster",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_parameter_group(parameter_group_name)
delete_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Deletes the specified parameter group. You cannot delete a parameter group if it is
associated with any clusters. You cannot delete the default parameter groups in your
account.
# Arguments
- `parameter_group_name`: The name of the parameter group to delete.
"""
function delete_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DeleteParameterGroup",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_parameter_group(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot(snapshot_name)
delete_snapshot(snapshot_name, params::Dict{String,<:Any})
Deletes an existing snapshot. When you receive a successful response from this operation,
MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this
operation.
# Arguments
- `snapshot_name`: The name of the snapshot to delete
"""
function delete_snapshot(SnapshotName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteSnapshot",
Dict{String,Any}("SnapshotName" => SnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot(
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotName" => SnapshotName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subnet_group(subnet_group_name)
delete_subnet_group(subnet_group_name, params::Dict{String,<:Any})
Deletes a subnet group. You cannot delete a default subnet group or one that is associated
with any clusters.
# Arguments
- `subnet_group_name`: The name of the subnet group to delete
"""
function delete_subnet_group(
SubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DeleteSubnetGroup",
Dict{String,Any}("SubnetGroupName" => SubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subnet_group(
SubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteSubnetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubnetGroupName" => SubnetGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(user_name)
delete_user(user_name, params::Dict{String,<:Any})
Deletes a user. The user will be removed from all ACLs and in turn removed from all
clusters.
# Arguments
- `user_name`: The name of the user to delete
"""
function delete_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteUser",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_acls()
describe_acls(params::Dict{String,<:Any})
Returns a list of ACLs
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ACLName"`: The name of the ACL
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
"""
function describe_acls(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb("DescribeACLs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_acls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeACLs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_clusters()
describe_clusters(params::Dict{String,<:Any})
Returns information about all provisioned clusters if no cluster identifier is specified,
or about a specific cluster if a cluster name is supplied.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterName"`: The name of the cluster
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"ShowShardDetails"`: An optional flag that can be included in the request to retrieve
information about the individual shard(s).
"""
function describe_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_engine_versions()
describe_engine_versions(params::Dict{String,<:Any})
Returns a list of the available Redis engine versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultOnly"`: If true, specifies that only the default version of the specified engine
or engine and major version combination is to be returned.
- `"EngineVersion"`: The Redis engine version
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"ParameterGroupFamily"`: The name of a specific parameter group family to return details
for.
"""
function describe_engine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeEngineVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_engine_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to clusters, security groups, and parameter groups. You can obtain
events specific to a particular cluster, security group, or parameter group by providing
the name as a parameter. By default, only the events occurring within the last hour are
returned; however, you can retrieve up to 14 days' worth of events if necessary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The number of minutes worth of events to retrieve.
- `"EndTime"`: The end of the time interval for which to retrieve events, specified in ISO
8601 format. Example: 2017-03-30T07:03:49.555Z
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"SourceName"`: The identifier of the event source for which events are returned. If not
specified, all sources are included in the response.
- `"SourceType"`: The event source to retrieve events for. If no value is specified, all
events are returned.
- `"StartTime"`: The beginning of the time interval to retrieve events for, specified in
ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_parameter_groups()
describe_parameter_groups(params::Dict{String,<:Any})
Returns a list of parameter group descriptions. If a parameter group name is specified, the
list contains only the descriptions for that group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"ParameterGroupName"`: The name of a specific parameter group to return details for.
"""
function describe_parameter_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeParameterGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_parameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_parameters(parameter_group_name)
describe_parameters(parameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular parameter group.
# Arguments
- `parameter_group_name`: he name of a specific parameter group to return details for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
"""
function describe_parameters(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeParameters",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_parameters(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DescribeParameters",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_nodes()
describe_reserved_nodes(params::Dict{String,<:Any})
Returns information about reserved nodes for this account, or about a specified reserved
node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The duration filter value, specified in years or seconds. Use this
parameter to show only reservations for this duration.
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a marker is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"NodeType"`: The node type filter value. Use this parameter to show only those
reservations matching the specified node type. For more information, see Supported node
types.
- `"OfferingType"`: The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values: \"All
Upfront\"|\"Partial Upfront\"| \"No Upfront\"
- `"ReservationId"`: The reserved node identifier filter value. Use this parameter to show
only the reservation that matches the specified reservation ID.
- `"ReservedNodesOfferingId"`: The offering identifier filter value. Use this parameter to
show only purchased reservations matching the specified offering identifier.
"""
function describe_reserved_nodes(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeReservedNodes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_reserved_nodes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeReservedNodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_nodes_offerings()
describe_reserved_nodes_offerings(params::Dict{String,<:Any})
Lists available reserved node offerings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: Duration filter value, specified in years or seconds. Use this parameter to
show only reservations for a given duration.
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a marker is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"NodeType"`: The node type for the reserved nodes. For more information, see Supported
node types.
- `"OfferingType"`: The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values: \"All
Upfront\"|\"Partial Upfront\"| \"No Upfront\"
- `"ReservedNodesOfferingId"`: The offering identifier filter value. Use this parameter to
show only the available offering that matches the specified reservation identifier.
"""
function describe_reserved_nodes_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeReservedNodesOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_nodes_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeReservedNodesOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_service_updates()
describe_service_updates(params::Dict{String,<:Any})
Returns details of the service updates
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterNames"`: The list of cluster names to identify service updates to apply
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"ServiceUpdateName"`: The unique ID of the service update to describe.
- `"Status"`: The status(es) of the service updates to filter on
"""
function describe_service_updates(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeServiceUpdates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_service_updates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeServiceUpdates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
Returns information about cluster snapshots. By default, DescribeSnapshots lists all of
your snapshots; it can optionally describe a single snapshot, or just the snapshots
associated with a particular cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterName"`: A user-supplied cluster identifier. If this parameter is specified, only
snapshots associated with that specific cluster are described.
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"ShowDetail"`: A Boolean value which if true, the shard configuration is included in the
snapshot description.
- `"SnapshotName"`: A user-supplied name of the snapshot. If this parameter is specified,
only this named snapshot is described.
- `"Source"`: If set to system, the output shows snapshots that were automatically created
by MemoryDB. If set to user the output shows snapshots that were manually created. If
omitted, the output shows both automatically and manually created snapshots.
"""
function describe_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_subnet_groups()
describe_subnet_groups(params::Dict{String,<:Any})
Returns a list of subnet group descriptions. If a subnet group name is specified, the list
contains only the description of that group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"SubnetGroupName"`: The name of the subnet group to return details for.
"""
function describe_subnet_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeSubnetGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_subnet_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeSubnetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_users()
describe_users(params::Dict{String,<:Any})
Returns a list of users.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filter to determine the list of users to return.
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken 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.
- `"UserName"`: The name of the user
"""
function describe_users(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb("DescribeUsers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_users(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeUsers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
failover_shard(cluster_name, shard_name)
failover_shard(cluster_name, shard_name, params::Dict{String,<:Any})
Used to failover a shard. This API is designed for testing the behavior of your application
in case of MemoryDB failover. It is not designed to be used as a production-level tool for
initiating a failover to overcome a problem you may have with the cluster. Moreover, in
certain conditions such as large scale operational events, Amazon may block this API.
# Arguments
- `cluster_name`: The cluster being failed over
- `shard_name`: The name of the shard
"""
function failover_shard(
ClusterName, ShardName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"FailoverShard",
Dict{String,Any}("ClusterName" => ClusterName, "ShardName" => ShardName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function failover_shard(
ClusterName,
ShardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"FailoverShard",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterName" => ClusterName, "ShardName" => ShardName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_allowed_node_type_updates(cluster_name)
list_allowed_node_type_updates(cluster_name, params::Dict{String,<:Any})
Lists all available node types that you can scale to from your cluster's current node type.
When you use the UpdateCluster operation to scale your cluster, the value of the NodeType
parameter must be one of the node types returned by this operation.
# Arguments
- `cluster_name`: The name of the cluster you want to scale. MemoryDB uses the cluster name
to identify the current node type being used by this cluster, and from that to create a
list of node types you can scale up to.
"""
function list_allowed_node_type_updates(
ClusterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"ListAllowedNodeTypeUpdates",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_allowed_node_type_updates(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"ListAllowedNodeTypeUpdates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(resource_arn)
list_tags(resource_arn, params::Dict{String,<:Any})
Lists all tags currently on a named resource. A tag is a key-value pair where the key and
value are case-sensitive. You can use tags to categorize and track your MemoryDB resources.
For more information, see Tagging your MemoryDB resources
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want the
list of tags
"""
function list_tags(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"ListTags",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"ListTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_nodes_offering(reserved_nodes_offering_id)
purchase_reserved_nodes_offering(reserved_nodes_offering_id, params::Dict{String,<:Any})
Allows you to purchase a reserved node offering. Reserved nodes are not eligible for
cancellation and are non-refundable.
# Arguments
- `reserved_nodes_offering_id`: The ID of the reserved node offering to purchase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NodeCount"`: The number of node instances to reserve.
- `"ReservationId"`: A customer-specified identifier to track this reservation.
- `"Tags"`: A list of tags to be added to this resource. A tag is a key-value pair. A tag
key must be accompanied by a tag value, although null is accepted.
"""
function purchase_reserved_nodes_offering(
ReservedNodesOfferingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"PurchaseReservedNodesOffering",
Dict{String,Any}("ReservedNodesOfferingId" => ReservedNodesOfferingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_nodes_offering(
ReservedNodesOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"PurchaseReservedNodesOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReservedNodesOfferingId" => ReservedNodesOfferingId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_parameter_group(parameter_group_name)
reset_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a parameter group to the engine or system default value. You can
reset specific parameters by submitting a list of parameter names. To reset the entire
parameter group, specify the AllParameters and ParameterGroupName parameters.
# Arguments
- `parameter_group_name`: The name of the parameter group to reset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllParameters"`: If true, all parameters in the parameter group are reset to their
default values. If false, only the parameters listed by ParameterNames are reset to their
default values.
- `"ParameterNames"`: An array of parameter names to reset to their default values. If
AllParameters is true, do not use ParameterNames. If AllParameters is false, you must
specify the name of at least one parameter to reset.
"""
function reset_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"ResetParameterGroup",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_parameter_group(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"ResetParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to
categorize and track all your MemoryDB resources. When you add or remove tags on clusters,
those actions will be replicated to all nodes in the cluster. For more information, see
Resource-level permissions. For example, you can use cost-allocation tags to your MemoryDB
resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file
with your usage and costs aggregated by your tags. You can apply tags that represent
business categories (such as cost centers, application names, or owners) to organize your
costs across multiple services. For more information, see Using Cost Allocation Tags.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which the tags are to
be added
- `tags`: A list of tags to be added to this resource. A tag is a key-value pair. A tag key
must be accompanied by a tag value, although null is accepted.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Use this operation to remove tags on a resource
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which the tags are to
be removed
- `tag_keys`: The list of keys of the tags that are to be removed
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_acl(aclname)
update_acl(aclname, params::Dict{String,<:Any})
Changes the list of users that belong to the Access Control List.
# Arguments
- `aclname`: The name of the Access Control List
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserNamesToAdd"`: The list of users to add to the Access Control List
- `"UserNamesToRemove"`: The list of users to remove from the Access Control List
"""
function update_acl(ACLName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"UpdateACL",
Dict{String,Any}("ACLName" => ACLName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_acl(
ACLName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"UpdateACL",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ACLName" => ACLName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster(cluster_name)
update_cluster(cluster_name, params::Dict{String,<:Any})
Modifies the settings for a cluster. You can use this operation to change one or more
cluster configuration settings by specifying the settings and the new values.
# Arguments
- `cluster_name`: The name of the cluster to update
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ACLName"`: The Access Control List that is associated with the cluster
- `"Description"`: The description of the cluster to update
- `"EngineVersion"`: The upgraded version of the engine to be run on the nodes. You can
upgrade to a newer engine version, but you cannot downgrade to an earlier engine version.
If you want to use an earlier engine version, you must delete the existing cluster and
create it anew with the earlier engine version.
- `"MaintenanceWindow"`: Specifies the weekly time range during which maintenance on the
cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H
Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:
sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
- `"NodeType"`: A valid node type that you want to scale this cluster up or down to.
- `"ParameterGroupName"`: The name of the parameter group to update
- `"ReplicaConfiguration"`: The number of replicas that will reside in each shard
- `"SecurityGroupIds"`: The SecurityGroupIds to update
- `"ShardConfiguration"`: The number of shards in the cluster
- `"SnapshotRetentionLimit"`: The number of days for which MemoryDB retains automatic
cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to
5, a snapshot that was taken today is retained for 5 days before being deleted.
- `"SnapshotWindow"`: The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your cluster.
- `"SnsTopicArn"`: The SNS topic ARN to update
- `"SnsTopicStatus"`: The status of the Amazon SNS notification topic. Notifications are
sent only if the status is active.
"""
function update_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"UpdateCluster",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"UpdateCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_parameter_group(parameter_group_name, parameter_name_values)
update_parameter_group(parameter_group_name, parameter_name_values, params::Dict{String,<:Any})
Updates the parameters of a parameter group. You can modify up to 20 parameters in a single
request by submitting a list parameter name and value pairs.
# Arguments
- `parameter_group_name`: The name of the parameter group to update.
- `parameter_name_values`: An array of parameter names and values for the parameter update.
You must supply at least one parameter name and value; subsequent arguments are optional. A
maximum of 20 parameters may be updated per request.
"""
function update_parameter_group(
ParameterGroupName,
ParameterNameValues;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"UpdateParameterGroup",
Dict{String,Any}(
"ParameterGroupName" => ParameterGroupName,
"ParameterNameValues" => ParameterNameValues,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_parameter_group(
ParameterGroupName,
ParameterNameValues,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"UpdateParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ParameterGroupName" => ParameterGroupName,
"ParameterNameValues" => ParameterNameValues,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subnet_group(subnet_group_name)
update_subnet_group(subnet_group_name, params::Dict{String,<:Any})
Updates a subnet group. For more information, see Updating a subnet group
# Arguments
- `subnet_group_name`: The name of the subnet group
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the subnet group
- `"SubnetIds"`: The EC2 subnet IDs for the subnet group.
"""
function update_subnet_group(
SubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"UpdateSubnetGroup",
Dict{String,Any}("SubnetGroupName" => SubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subnet_group(
SubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"UpdateSubnetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubnetGroupName" => SubnetGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(user_name)
update_user(user_name, params::Dict{String,<:Any})
Changes user password(s) and/or access string.
# Arguments
- `user_name`: The name of the user
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessString"`: Access permissions string used for this user.
- `"AuthenticationMode"`: Denotes the user's authentication properties, such as whether it
requires a password to authenticate.
"""
function update_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"UpdateUser",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"UpdateUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 95185 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mgn
using AWS.Compat
using AWS.UUIDs
"""
archive_application(application_id)
archive_application(application_id, params::Dict{String,<:Any})
Archive application.
# Arguments
- `application_id`: Application ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function archive_application(
applicationID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ArchiveApplication",
Dict{String,Any}("applicationID" => applicationID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function archive_application(
applicationID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ArchiveApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("applicationID" => applicationID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
archive_wave(wave_id)
archive_wave(wave_id, params::Dict{String,<:Any})
Archive wave.
# Arguments
- `wave_id`: Wave ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function archive_wave(waveID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/ArchiveWave",
Dict{String,Any}("waveID" => waveID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function archive_wave(
waveID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ArchiveWave",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("waveID" => waveID), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_applications(application_ids, wave_id)
associate_applications(application_ids, wave_id, params::Dict{String,<:Any})
Associate applications to wave.
# Arguments
- `application_ids`: Application IDs list.
- `wave_id`: Wave ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function associate_applications(
applicationIDs, waveID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/AssociateApplications",
Dict{String,Any}("applicationIDs" => applicationIDs, "waveID" => waveID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_applications(
applicationIDs,
waveID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/AssociateApplications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("applicationIDs" => applicationIDs, "waveID" => waveID),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_source_servers(application_id, source_server_ids)
associate_source_servers(application_id, source_server_ids, params::Dict{String,<:Any})
Associate source servers to application.
# Arguments
- `application_id`: Application ID.
- `source_server_ids`: Source server IDs list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function associate_source_servers(
applicationID, sourceServerIDs; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/AssociateSourceServers",
Dict{String,Any}(
"applicationID" => applicationID, "sourceServerIDs" => sourceServerIDs
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_source_servers(
applicationID,
sourceServerIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/AssociateSourceServers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicationID" => applicationID, "sourceServerIDs" => sourceServerIDs
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_server_life_cycle_state(life_cycle, source_server_id)
change_server_life_cycle_state(life_cycle, source_server_id, params::Dict{String,<:Any})
Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server
IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works
if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)
# Arguments
- `life_cycle`: The request to change the source server migration lifecycle state.
- `source_server_id`: The request to change the source server migration lifecycle state by
source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: The request to change the source server migration account ID.
"""
function change_server_life_cycle_state(
lifeCycle, sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ChangeServerLifeCycleState",
Dict{String,Any}("lifeCycle" => lifeCycle, "sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_server_life_cycle_state(
lifeCycle,
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ChangeServerLifeCycleState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"lifeCycle" => lifeCycle, "sourceServerID" => sourceServerID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(name)
create_application(name, params::Dict{String,<:Any})
Create application.
# Arguments
- `name`: Application name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
- `"description"`: Application description.
- `"tags"`: Application tags.
"""
function create_application(name; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/CreateApplication",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/CreateApplication",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector(name, ssm_instance_id)
create_connector(name, ssm_instance_id, params::Dict{String,<:Any})
Create Connector.
# Arguments
- `name`: Create Connector request name.
- `ssm_instance_id`: Create Connector request SSM instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ssmCommandConfig"`: Create Connector request SSM command config.
- `"tags"`: Create Connector request tags.
"""
function create_connector(
name, ssmInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/CreateConnector",
Dict{String,Any}("name" => name, "ssmInstanceID" => ssmInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector(
name,
ssmInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/CreateConnector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "ssmInstanceID" => ssmInstanceID),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_launch_configuration_template()
create_launch_configuration_template(params::Dict{String,<:Any})
Creates a new Launch Configuration Template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associatePublicIpAddress"`: Associate public Ip address.
- `"bootMode"`: Launch configuration template boot mode.
- `"copyPrivateIp"`: Copy private Ip.
- `"copyTags"`: Copy tags.
- `"enableMapAutoTagging"`: Enable map auto tagging.
- `"largeVolumeConf"`: Large volume config.
- `"launchDisposition"`: Launch disposition.
- `"licensing"`:
- `"mapAutoTaggingMpeID"`: Launch configuration template map auto tagging MPE ID.
- `"postLaunchActions"`: Launch configuration template post launch actions.
- `"smallVolumeConf"`: Small volume config.
- `"smallVolumeMaxSize"`: Small volume maximum size.
- `"tags"`: Request to associate tags during creation of a Launch Configuration Template.
- `"targetInstanceTypeRightSizingMethod"`: Target instance type right-sizing method.
"""
function create_launch_configuration_template(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/CreateLaunchConfigurationTemplate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_launch_configuration_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/CreateLaunchConfigurationTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_configuration_template(associate_default_security_group, bandwidth_throttling, create_public_ip, data_plane_routing, default_large_staging_disk_type, ebs_encryption, replication_server_instance_type, replication_servers_security_groups_ids, staging_area_subnet_id, staging_area_tags, use_dedicated_replication_server)
create_replication_configuration_template(associate_default_security_group, bandwidth_throttling, create_public_ip, data_plane_routing, default_large_staging_disk_type, ebs_encryption, replication_server_instance_type, replication_servers_security_groups_ids, staging_area_subnet_id, staging_area_tags, use_dedicated_replication_server, params::Dict{String,<:Any})
Creates a new ReplicationConfigurationTemplate.
# Arguments
- `associate_default_security_group`: Request to associate the default Application
Migration Service Security group with the Replication Settings template.
- `bandwidth_throttling`: Request to configure bandwidth throttling during Replication
Settings template creation.
- `create_public_ip`: Request to create Public IP during Replication Settings template
creation.
- `data_plane_routing`: Request to configure data plane routing during Replication Settings
template creation.
- `default_large_staging_disk_type`: Request to configure the default large staging disk
EBS volume type during Replication Settings template creation.
- `ebs_encryption`: Request to configure EBS encryption during Replication Settings
template creation.
- `replication_server_instance_type`: Request to configure the Replication Server instance
type during Replication Settings template creation.
- `replication_servers_security_groups_ids`: Request to configure the Replication Server
Security group ID during Replication Settings template creation.
- `staging_area_subnet_id`: Request to configure the Staging Area subnet ID during
Replication Settings template creation.
- `staging_area_tags`: Request to configure Staging Area tags during Replication Settings
template creation.
- `use_dedicated_replication_server`: Request to use Dedicated Replication Servers during
Replication Settings template creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ebsEncryptionKeyArn"`: Request to configure an EBS encryption key during Replication
Settings template creation.
- `"tags"`: Request to configure tags during Replication Settings template creation.
- `"useFipsEndpoint"`: Request to use Fips Endpoint during Replication Settings template
creation.
"""
function create_replication_configuration_template(
associateDefaultSecurityGroup,
bandwidthThrottling,
createPublicIP,
dataPlaneRouting,
defaultLargeStagingDiskType,
ebsEncryption,
replicationServerInstanceType,
replicationServersSecurityGroupsIDs,
stagingAreaSubnetId,
stagingAreaTags,
useDedicatedReplicationServer;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/CreateReplicationConfigurationTemplate",
Dict{String,Any}(
"associateDefaultSecurityGroup" => associateDefaultSecurityGroup,
"bandwidthThrottling" => bandwidthThrottling,
"createPublicIP" => createPublicIP,
"dataPlaneRouting" => dataPlaneRouting,
"defaultLargeStagingDiskType" => defaultLargeStagingDiskType,
"ebsEncryption" => ebsEncryption,
"replicationServerInstanceType" => replicationServerInstanceType,
"replicationServersSecurityGroupsIDs" => replicationServersSecurityGroupsIDs,
"stagingAreaSubnetId" => stagingAreaSubnetId,
"stagingAreaTags" => stagingAreaTags,
"useDedicatedReplicationServer" => useDedicatedReplicationServer,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_configuration_template(
associateDefaultSecurityGroup,
bandwidthThrottling,
createPublicIP,
dataPlaneRouting,
defaultLargeStagingDiskType,
ebsEncryption,
replicationServerInstanceType,
replicationServersSecurityGroupsIDs,
stagingAreaSubnetId,
stagingAreaTags,
useDedicatedReplicationServer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/CreateReplicationConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"associateDefaultSecurityGroup" => associateDefaultSecurityGroup,
"bandwidthThrottling" => bandwidthThrottling,
"createPublicIP" => createPublicIP,
"dataPlaneRouting" => dataPlaneRouting,
"defaultLargeStagingDiskType" => defaultLargeStagingDiskType,
"ebsEncryption" => ebsEncryption,
"replicationServerInstanceType" => replicationServerInstanceType,
"replicationServersSecurityGroupsIDs" =>
replicationServersSecurityGroupsIDs,
"stagingAreaSubnetId" => stagingAreaSubnetId,
"stagingAreaTags" => stagingAreaTags,
"useDedicatedReplicationServer" => useDedicatedReplicationServer,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_wave(name)
create_wave(name, params::Dict{String,<:Any})
Create wave.
# Arguments
- `name`: Wave name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
- `"description"`: Wave description.
- `"tags"`: Wave tags.
"""
function create_wave(name; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/CreateWave",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_wave(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/CreateWave",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Delete application.
# Arguments
- `application_id`: Application ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function delete_application(
applicationID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteApplication",
Dict{String,Any}("applicationID" => applicationID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
applicationID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DeleteApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("applicationID" => applicationID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector(connector_id)
delete_connector(connector_id, params::Dict{String,<:Any})
Delete Connector.
# Arguments
- `connector_id`: Delete Connector request connector ID.
"""
function delete_connector(connectorID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/DeleteConnector",
Dict{String,Any}("connectorID" => connectorID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector(
connectorID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DeleteConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectorID" => connectorID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job(job_id)
delete_job(job_id, params::Dict{String,<:Any})
Deletes a single Job by ID.
# Arguments
- `job_id`: Request to delete Job from service by Job ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to delete Job from service by Account ID.
"""
function delete_job(jobID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/DeleteJob",
Dict{String,Any}("jobID" => jobID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job(
jobID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobID" => jobID), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_launch_configuration_template(launch_configuration_template_id)
delete_launch_configuration_template(launch_configuration_template_id, params::Dict{String,<:Any})
Deletes a single Launch Configuration Template by ID.
# Arguments
- `launch_configuration_template_id`: ID of resource to be deleted.
"""
function delete_launch_configuration_template(
launchConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteLaunchConfigurationTemplate",
Dict{String,Any}("launchConfigurationTemplateID" => launchConfigurationTemplateID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_launch_configuration_template(
launchConfigurationTemplateID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DeleteLaunchConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"launchConfigurationTemplateID" => launchConfigurationTemplateID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_configuration_template(replication_configuration_template_id)
delete_replication_configuration_template(replication_configuration_template_id, params::Dict{String,<:Any})
Deletes a single Replication Configuration Template by ID
# Arguments
- `replication_configuration_template_id`: Request to delete Replication Configuration
Template from service by Replication Configuration Template ID.
"""
function delete_replication_configuration_template(
replicationConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteReplicationConfigurationTemplate",
Dict{String,Any}(
"replicationConfigurationTemplateID" => replicationConfigurationTemplateID
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_configuration_template(
replicationConfigurationTemplateID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DeleteReplicationConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"replicationConfigurationTemplateID" =>
replicationConfigurationTemplateID,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_source_server(source_server_id)
delete_source_server(source_server_id, params::Dict{String,<:Any})
Deletes a single source server by ID.
# Arguments
- `source_server_id`: Request to delete Source Server from service by Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to delete Source Server from service by Account ID.
"""
function delete_source_server(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteSourceServer",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_source_server(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DeleteSourceServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vcenter_client(vcenter_client_id)
delete_vcenter_client(vcenter_client_id, params::Dict{String,<:Any})
Deletes a given vCenter client by ID.
# Arguments
- `vcenter_client_id`: ID of resource to be deleted.
"""
function delete_vcenter_client(
vcenterClientID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteVcenterClient",
Dict{String,Any}("vcenterClientID" => vcenterClientID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vcenter_client(
vcenterClientID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DeleteVcenterClient",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("vcenterClientID" => vcenterClientID), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_wave(wave_id)
delete_wave(wave_id, params::Dict{String,<:Any})
Delete wave.
# Arguments
- `wave_id`: Wave ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function delete_wave(waveID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/DeleteWave",
Dict{String,Any}("waveID" => waveID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_wave(
waveID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DeleteWave",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("waveID" => waveID), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_log_items(job_id)
describe_job_log_items(job_id, params::Dict{String,<:Any})
Retrieves detailed job log items with paging.
# Arguments
- `job_id`: Request to describe Job log job ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to describe Job log Account ID.
- `"maxResults"`: Request to describe Job log item maximum results.
- `"nextToken"`: Request to describe Job log next token.
"""
function describe_job_log_items(jobID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/DescribeJobLogItems",
Dict{String,Any}("jobID" => jobID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_log_items(
jobID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeJobLogItems",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobID" => jobID), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_jobs()
describe_jobs(params::Dict{String,<:Any})
Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs
are returned. The response is sorted by creationDataTime - latest date first. Jobs are
normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs
are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs
available only to *Support* and only used in response to relevant support tickets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to describe job log items by Account ID.
- `"filters"`: Request to describe Job log filters.
- `"maxResults"`: Request to describe job log items by max results.
- `"nextToken"`: Request to describe job log items by next token.
"""
function describe_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST", "/DescribeJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_launch_configuration_templates()
describe_launch_configuration_templates(params::Dict{String,<:Any})
Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"launchConfigurationTemplateIDs"`: Request to filter Launch Configuration Templates list
by Launch Configuration Template ID.
- `"maxResults"`: Maximum results to be returned in DescribeLaunchConfigurationTemplates.
- `"nextToken"`: Next pagination token returned from DescribeLaunchConfigurationTemplates.
"""
function describe_launch_configuration_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeLaunchConfigurationTemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_launch_configuration_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeLaunchConfigurationTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_configuration_templates()
describe_replication_configuration_templates(params::Dict{String,<:Any})
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Request to describe Replication Configuration template by max results.
- `"nextToken"`: Request to describe Replication Configuration template by next token.
- `"replicationConfigurationTemplateIDs"`: Request to describe Replication Configuration
template by template IDs.
"""
function describe_replication_configuration_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeReplicationConfigurationTemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_configuration_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeReplicationConfigurationTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_source_servers()
describe_source_servers(params::Dict{String,<:Any})
Retrieves all SourceServers or multiple SourceServers by ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to filter Source Servers list by Accoun ID.
- `"filters"`: Request to filter Source Servers list.
- `"maxResults"`: Request to filter Source Servers list by maximum results.
- `"nextToken"`: Request to filter Source Servers list by next token.
"""
function describe_source_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/DescribeSourceServers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_source_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DescribeSourceServers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vcenter_clients()
describe_vcenter_clients(params::Dict{String,<:Any})
Returns a list of the installed vCenter clients.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum results to be returned in DescribeVcenterClients.
- `"nextToken"`: Next pagination token to be provided for DescribeVcenterClients.
"""
function describe_vcenter_clients(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"GET",
"/DescribeVcenterClients";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vcenter_clients(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"GET",
"/DescribeVcenterClients",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_applications(application_ids, wave_id)
disassociate_applications(application_ids, wave_id, params::Dict{String,<:Any})
Disassociate applications from wave.
# Arguments
- `application_ids`: Application IDs list.
- `wave_id`: Wave ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function disassociate_applications(
applicationIDs, waveID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DisassociateApplications",
Dict{String,Any}("applicationIDs" => applicationIDs, "waveID" => waveID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_applications(
applicationIDs,
waveID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DisassociateApplications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("applicationIDs" => applicationIDs, "waveID" => waveID),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_source_servers(application_id, source_server_ids)
disassociate_source_servers(application_id, source_server_ids, params::Dict{String,<:Any})
Disassociate source servers from application.
# Arguments
- `application_id`: Application ID.
- `source_server_ids`: Source server IDs list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function disassociate_source_servers(
applicationID, sourceServerIDs; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DisassociateSourceServers",
Dict{String,Any}(
"applicationID" => applicationID, "sourceServerIDs" => sourceServerIDs
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_source_servers(
applicationID,
sourceServerIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DisassociateSourceServers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicationID" => applicationID, "sourceServerIDs" => sourceServerIDs
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_from_service(source_server_id)
disconnect_from_service(source_server_id, params::Dict{String,<:Any})
Disconnects specific Source Servers from Application Migration Service. Data replication is
stopped immediately. All AWS resources created by Application Migration Service for
enabling the replication of these source servers will be terminated / deleted within 90
minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the
source server has not been prevented from communicating with the Application Migration
Service service, then it will receive a command to uninstall itself (within approximately
10 minutes). The following properties of the SourceServer will be changed immediately:
dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes
property for each of dataReplicationInfo.replicatedDisks will be set to zero;
dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
# Arguments
- `source_server_id`: Request to disconnect Source Server from service by Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to disconnect Source Server from service by Account ID.
"""
function disconnect_from_service(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/DisconnectFromService",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_from_service(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/DisconnectFromService",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
finalize_cutover(source_server_id)
finalize_cutover(source_server_id, params::Dict{String,<:Any})
Finalizes the cutover immediately for specific Source Servers. All AWS resources created by
Application Migration Service for enabling the replication of these source servers will be
terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be
terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10
minutes). The following properties of the SourceServer will be changed immediately:
dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The
SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo
each of dataReplicationInfo.replicatedDisks will be set to zero;
dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
# Arguments
- `source_server_id`: Request to finalize Cutover by Source Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to finalize Cutover by Source Account ID.
"""
function finalize_cutover(sourceServerID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/FinalizeCutover",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function finalize_cutover(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/FinalizeCutover",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch_configuration(source_server_id)
get_launch_configuration(source_server_id, params::Dict{String,<:Any})
Lists all LaunchConfigurations available, filtered by Source Server IDs.
# Arguments
- `source_server_id`: Request to get Launch Configuration information by Source Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to get Launch Configuration information by Account ID.
"""
function get_launch_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/GetLaunchConfiguration",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch_configuration(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/GetLaunchConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_replication_configuration(source_server_id)
get_replication_configuration(source_server_id, params::Dict{String,<:Any})
Lists all ReplicationConfigurations, filtered by Source Server ID.
# Arguments
- `source_server_id`: Request to get Replication Configuration by Source Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request to get Replication Configuration by Account ID.
"""
function get_replication_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/GetReplicationConfiguration",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_replication_configuration(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/GetReplicationConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initialize_service()
initialize_service(params::Dict{String,<:Any})
Initialize Application Migration Service.
"""
function initialize_service(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST", "/InitializeService"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function initialize_service(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/InitializeService",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Retrieves all applications or multiple applications by ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Applications list Account ID.
- `"filters"`: Applications list filters.
- `"maxResults"`: Maximum results to return when listing applications.
- `"nextToken"`: Request next token.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST", "/ListApplications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListApplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connectors()
list_connectors(params::Dict{String,<:Any})
List Connectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: List Connectors Request filters.
- `"maxResults"`: List Connectors Request max results.
- `"nextToken"`: List Connectors Request next token.
"""
function list_connectors(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST", "/ListConnectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListConnectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_export_errors(export_id)
list_export_errors(export_id, params::Dict{String,<:Any})
List export errors.
# Arguments
- `export_id`: List export errors request export id.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: List export errors request max results.
- `"nextToken"`: List export errors request next token.
"""
function list_export_errors(exportID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/ListExportErrors",
Dict{String,Any}("exportID" => exportID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_export_errors(
exportID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ListExportErrors",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("exportID" => exportID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_exports()
list_exports(params::Dict{String,<:Any})
List exports.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`:
- `"maxResults"`: List export request max results.
- `"nextToken"`: List export request next token.
"""
function list_exports(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST", "/ListExports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_exports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListExports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_import_errors(import_id)
list_import_errors(import_id, params::Dict{String,<:Any})
List import errors.
# Arguments
- `import_id`: List import errors request import id.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: List import errors request max results.
- `"nextToken"`: List import errors request next token.
"""
function list_import_errors(importID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/ListImportErrors",
Dict{String,Any}("importID" => importID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_import_errors(
importID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ListImportErrors",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("importID" => importID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_imports()
list_imports(params::Dict{String,<:Any})
List imports.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: List imports request filters.
- `"maxResults"`: List imports request max results.
- `"nextToken"`: List imports request next token.
"""
function list_imports(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST", "/ListImports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_imports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListImports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_managed_accounts()
list_managed_accounts(params::Dict{String,<:Any})
List Managed Accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: List managed accounts request max results.
- `"nextToken"`: List managed accounts request next token.
"""
function list_managed_accounts(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/ListManagedAccounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_managed_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListManagedAccounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_source_server_actions(source_server_id)
list_source_server_actions(source_server_id, params::Dict{String,<:Any})
List source server post migration custom actions.
# Arguments
- `source_server_id`: Source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID to return when listing source server post migration custom
actions.
- `"filters"`: Filters to apply when listing source server post migration custom actions.
- `"maxResults"`: Maximum amount of items to return when listing source server post
migration custom actions.
- `"nextToken"`: Next token to use when listing source server post migration custom actions.
"""
function list_source_server_actions(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListSourceServerActions",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_source_server_actions(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ListSourceServerActions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
List all tags for your Application Migration Service resources.
# Arguments
- `resource_arn`: List tags for resource request by ARN.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_actions(launch_configuration_template_id)
list_template_actions(launch_configuration_template_id, params::Dict{String,<:Any})
List template post migration custom actions.
# Arguments
- `launch_configuration_template_id`: Launch configuration template ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Filters to apply when listing template post migration custom actions.
- `"maxResults"`: Maximum amount of items to return when listing template post migration
custom actions.
- `"nextToken"`: Next token to use when listing template post migration custom actions.
"""
function list_template_actions(
launchConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ListTemplateActions",
Dict{String,Any}("launchConfigurationTemplateID" => launchConfigurationTemplateID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_actions(
launchConfigurationTemplateID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ListTemplateActions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"launchConfigurationTemplateID" => launchConfigurationTemplateID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_waves()
list_waves(params::Dict{String,<:Any})
Retrieves all waves or multiple waves by ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Request account ID.
- `"filters"`: Waves list filters.
- `"maxResults"`: Maximum results to return when listing waves.
- `"nextToken"`: Request next token.
"""
function list_waves(; aws_config::AbstractAWSConfig=global_aws_config())
return mgn("POST", "/ListWaves"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_waves(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST", "/ListWaves", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
mark_as_archived(source_server_id)
mark_as_archived(source_server_id, params::Dict{String,<:Any})
Archives specific Source Servers by setting the SourceServer.isArchived property to true
for specified SourceServers by ID. This command only works for SourceServers with a
lifecycle. state which equals DISCONNECTED or CUTOVER.
# Arguments
- `source_server_id`: Mark as archived by Source Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Mark as archived by Account ID.
"""
function mark_as_archived(sourceServerID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/MarkAsArchived",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function mark_as_archived(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/MarkAsArchived",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
pause_replication(source_server_id)
pause_replication(source_server_id, params::Dict{String,<:Any})
Pause Replication.
# Arguments
- `source_server_id`: Pause Replication Request source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Pause Replication Request account ID.
"""
function pause_replication(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/PauseReplication",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function pause_replication(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/PauseReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_source_server_action(action_id, action_name, document_identifier, order, source_server_id)
put_source_server_action(action_id, action_name, document_identifier, order, source_server_id, params::Dict{String,<:Any})
Put source server post migration custom action.
# Arguments
- `action_id`: Source server post migration custom action ID.
- `action_name`: Source server post migration custom action name.
- `document_identifier`: Source server post migration custom action document identifier.
- `order`: Source server post migration custom action order.
- `source_server_id`: Source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Source server post migration custom account ID.
- `"active"`: Source server post migration custom action active status.
- `"category"`: Source server post migration custom action category.
- `"description"`: Source server post migration custom action description.
- `"documentVersion"`: Source server post migration custom action document version.
- `"externalParameters"`: Source server post migration custom action external parameters.
- `"mustSucceedForCutover"`: Source server post migration custom action must succeed for
cutover.
- `"parameters"`: Source server post migration custom action parameters.
- `"timeoutSeconds"`: Source server post migration custom action timeout in seconds.
"""
function put_source_server_action(
actionID,
actionName,
documentIdentifier,
order,
sourceServerID;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/PutSourceServerAction",
Dict{String,Any}(
"actionID" => actionID,
"actionName" => actionName,
"documentIdentifier" => documentIdentifier,
"order" => order,
"sourceServerID" => sourceServerID,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_source_server_action(
actionID,
actionName,
documentIdentifier,
order,
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/PutSourceServerAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionID" => actionID,
"actionName" => actionName,
"documentIdentifier" => documentIdentifier,
"order" => order,
"sourceServerID" => sourceServerID,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_template_action(action_id, action_name, document_identifier, launch_configuration_template_id, order)
put_template_action(action_id, action_name, document_identifier, launch_configuration_template_id, order, params::Dict{String,<:Any})
Put template post migration custom action.
# Arguments
- `action_id`: Template post migration custom action ID.
- `action_name`: Template post migration custom action name.
- `document_identifier`: Template post migration custom action document identifier.
- `launch_configuration_template_id`: Launch configuration template ID.
- `order`: Template post migration custom action order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"active"`: Template post migration custom action active status.
- `"category"`: Template post migration custom action category.
- `"description"`: Template post migration custom action description.
- `"documentVersion"`: Template post migration custom action document version.
- `"externalParameters"`: Template post migration custom action external parameters.
- `"mustSucceedForCutover"`: Template post migration custom action must succeed for cutover.
- `"operatingSystem"`: Operating system eligible for this template post migration custom
action.
- `"parameters"`: Template post migration custom action parameters.
- `"timeoutSeconds"`: Template post migration custom action timeout in seconds.
"""
function put_template_action(
actionID,
actionName,
documentIdentifier,
launchConfigurationTemplateID,
order;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/PutTemplateAction",
Dict{String,Any}(
"actionID" => actionID,
"actionName" => actionName,
"documentIdentifier" => documentIdentifier,
"launchConfigurationTemplateID" => launchConfigurationTemplateID,
"order" => order,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_template_action(
actionID,
actionName,
documentIdentifier,
launchConfigurationTemplateID,
order,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/PutTemplateAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionID" => actionID,
"actionName" => actionName,
"documentIdentifier" => documentIdentifier,
"launchConfigurationTemplateID" => launchConfigurationTemplateID,
"order" => order,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_source_server_action(action_id, source_server_id)
remove_source_server_action(action_id, source_server_id, params::Dict{String,<:Any})
Remove source server post migration custom action.
# Arguments
- `action_id`: Source server post migration custom action ID to remove.
- `source_server_id`: Source server ID of the post migration custom action to remove.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Source server post migration account ID.
"""
function remove_source_server_action(
actionID, sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/RemoveSourceServerAction",
Dict{String,Any}("actionID" => actionID, "sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_source_server_action(
actionID,
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/RemoveSourceServerAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionID" => actionID, "sourceServerID" => sourceServerID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_template_action(action_id, launch_configuration_template_id)
remove_template_action(action_id, launch_configuration_template_id, params::Dict{String,<:Any})
Remove template post migration custom action.
# Arguments
- `action_id`: Template post migration custom action ID to remove.
- `launch_configuration_template_id`: Launch configuration template ID of the post
migration custom action to remove.
"""
function remove_template_action(
actionID,
launchConfigurationTemplateID;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/RemoveTemplateAction",
Dict{String,Any}(
"actionID" => actionID,
"launchConfigurationTemplateID" => launchConfigurationTemplateID,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_template_action(
actionID,
launchConfigurationTemplateID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/RemoveTemplateAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionID" => actionID,
"launchConfigurationTemplateID" => launchConfigurationTemplateID,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_replication(source_server_id)
resume_replication(source_server_id, params::Dict{String,<:Any})
Resume Replication.
# Arguments
- `source_server_id`: Resume Replication Request source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Resume Replication Request account ID.
"""
function resume_replication(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/ResumeReplication",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_replication(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/ResumeReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retry_data_replication(source_server_id)
retry_data_replication(source_server_id, params::Dict{String,<:Any})
Causes the data replication initiation sequence to begin immediately upon next Handshake
for specified SourceServer IDs, regardless of when the previous initiation started. This
command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED
state.
# Arguments
- `source_server_id`: Retry data replication for Source Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Retry data replication for Account ID.
"""
function retry_data_replication(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/RetryDataReplication",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retry_data_replication(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/RetryDataReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_cutover(source_server_ids)
start_cutover(source_server_ids, params::Dict{String,<:Any})
Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job
whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state
property to CUTTING_OVER.
# Arguments
- `source_server_ids`: Start Cutover by Source Server IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Start Cutover by Account IDs
- `"tags"`: Start Cutover by Tags.
"""
function start_cutover(sourceServerIDs; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/StartCutover",
Dict{String,Any}("sourceServerIDs" => sourceServerIDs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_cutover(
sourceServerIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/StartCutover",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceServerIDs" => sourceServerIDs), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_export(s3_bucket, s3_key)
start_export(s3_bucket, s3_key, params::Dict{String,<:Any})
Start export.
# Arguments
- `s3_bucket`: Start export request s3 bucket.
- `s3_key`: Start export request s3key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"s3BucketOwner"`: Start export request s3 bucket owner.
"""
function start_export(s3Bucket, s3Key; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/StartExport",
Dict{String,Any}("s3Bucket" => s3Bucket, "s3Key" => s3Key);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_export(
s3Bucket,
s3Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/StartExport",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("s3Bucket" => s3Bucket, "s3Key" => s3Key), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import(s3_bucket_source)
start_import(s3_bucket_source, params::Dict{String,<:Any})
Start import.
# Arguments
- `s3_bucket_source`: Start import request s3 bucket source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Start import request client token.
"""
function start_import(s3BucketSource; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/StartImport",
Dict{String,Any}(
"s3BucketSource" => s3BucketSource, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import(
s3BucketSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/StartImport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"s3BucketSource" => s3BucketSource, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_replication(source_server_id)
start_replication(source_server_id, params::Dict{String,<:Any})
Starts replication for SNAPSHOT_SHIPPING agents.
# Arguments
- `source_server_id`: ID of source server on which to start replication.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID on which to start replication.
"""
function start_replication(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/StartReplication",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_replication(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/StartReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_test(source_server_ids)
start_test(source_server_ids, params::Dict{String,<:Any})
Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job
whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state
property to TESTING.
# Arguments
- `source_server_ids`: Start Test for Source Server IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Start Test for Account ID.
- `"tags"`: Start Test by Tags.
"""
function start_test(sourceServerIDs; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/StartTest",
Dict{String,Any}("sourceServerIDs" => sourceServerIDs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_test(
sourceServerIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/StartTest",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceServerIDs" => sourceServerIDs), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_replication(source_server_id)
stop_replication(source_server_id, params::Dict{String,<:Any})
Stop Replication.
# Arguments
- `source_server_id`: Stop Replication Request source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Stop Replication Request account ID.
"""
function stop_replication(sourceServerID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/StopReplication",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_replication(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/StopReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or overwrites only the specified tags for the specified Application Migration Service
resource or resources. When you specify an existing tag key, the value is overwritten with
the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and
optional value.
# Arguments
- `resource_arn`: Tag resource by ARN.
- `tags`: Tag resource by Tags.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_target_instances(source_server_ids)
terminate_target_instances(source_server_ids, params::Dict{String,<:Any})
Starts a job that terminates specific launched EC2 Test and Cutover instances. This command
will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or
CUTOVER.
# Arguments
- `source_server_ids`: Terminate Target instance by Source Server IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Terminate Target instance by Account ID
- `"tags"`: Terminate Target instance by Tags.
"""
function terminate_target_instances(
sourceServerIDs; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/TerminateTargetInstances",
Dict{String,Any}("sourceServerIDs" => sourceServerIDs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_target_instances(
sourceServerIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/TerminateTargetInstances",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceServerIDs" => sourceServerIDs), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unarchive_application(application_id)
unarchive_application(application_id, params::Dict{String,<:Any})
Unarchive application.
# Arguments
- `application_id`: Application ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function unarchive_application(
applicationID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UnarchiveApplication",
Dict{String,Any}("applicationID" => applicationID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unarchive_application(
applicationID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UnarchiveApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("applicationID" => applicationID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unarchive_wave(wave_id)
unarchive_wave(wave_id, params::Dict{String,<:Any})
Unarchive wave.
# Arguments
- `wave_id`: Wave ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
"""
function unarchive_wave(waveID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/UnarchiveWave",
Dict{String,Any}("waveID" => waveID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unarchive_wave(
waveID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UnarchiveWave",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("waveID" => waveID), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Deletes the specified set of tags from the specified set of Application Migration Service
resources.
# Arguments
- `resource_arn`: Untag resource by ARN.
- `tag_keys`: Untag resource by Keys.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_id)
update_application(application_id, params::Dict{String,<:Any})
Update application.
# Arguments
- `application_id`: Application ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
- `"description"`: Application description.
- `"name"`: Application name.
"""
function update_application(
applicationID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateApplication",
Dict{String,Any}("applicationID" => applicationID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
applicationID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("applicationID" => applicationID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connector(connector_id)
update_connector(connector_id, params::Dict{String,<:Any})
Update Connector.
# Arguments
- `connector_id`: Update Connector request connector ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: Update Connector request name.
- `"ssmCommandConfig"`: Update Connector request SSM command config.
"""
function update_connector(connectorID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/UpdateConnector",
Dict{String,Any}("connectorID" => connectorID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connector(
connectorID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectorID" => connectorID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_launch_configuration(source_server_id)
update_launch_configuration(source_server_id, params::Dict{String,<:Any})
Updates multiple LaunchConfigurations by Source Server ID. bootMode valid values are
LEGACY_BIOS | UEFI
# Arguments
- `source_server_id`: Update Launch configuration by Source Server ID request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Update Launch configuration Account ID.
- `"bootMode"`: Update Launch configuration boot mode request.
- `"copyPrivateIp"`: Update Launch configuration copy Private IP request.
- `"copyTags"`: Update Launch configuration copy Tags request.
- `"enableMapAutoTagging"`: Enable map auto tagging.
- `"launchDisposition"`: Update Launch configuration launch disposition request.
- `"licensing"`: Update Launch configuration licensing request.
- `"mapAutoTaggingMpeID"`: Launch configuration map auto tagging MPE ID.
- `"name"`: Update Launch configuration name request.
- `"postLaunchActions"`:
- `"targetInstanceTypeRightSizingMethod"`: Update Launch configuration Target instance
right sizing request.
"""
function update_launch_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateLaunchConfiguration",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_launch_configuration(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateLaunchConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_launch_configuration_template(launch_configuration_template_id)
update_launch_configuration_template(launch_configuration_template_id, params::Dict{String,<:Any})
Updates an existing Launch Configuration Template by ID.
# Arguments
- `launch_configuration_template_id`: Launch Configuration Template ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associatePublicIpAddress"`: Associate public Ip address.
- `"bootMode"`: Launch configuration template boot mode.
- `"copyPrivateIp"`: Copy private Ip.
- `"copyTags"`: Copy tags.
- `"enableMapAutoTagging"`: Enable map auto tagging.
- `"largeVolumeConf"`: Large volume config.
- `"launchDisposition"`: Launch disposition.
- `"licensing"`:
- `"mapAutoTaggingMpeID"`: Launch configuration template map auto tagging MPE ID.
- `"postLaunchActions"`: Post Launch Action to execute on the Test or Cutover instance.
- `"smallVolumeConf"`: Small volume config.
- `"smallVolumeMaxSize"`: Small volume maximum size.
- `"targetInstanceTypeRightSizingMethod"`: Target instance type right-sizing method.
"""
function update_launch_configuration_template(
launchConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateLaunchConfigurationTemplate",
Dict{String,Any}("launchConfigurationTemplateID" => launchConfigurationTemplateID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_launch_configuration_template(
launchConfigurationTemplateID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateLaunchConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"launchConfigurationTemplateID" => launchConfigurationTemplateID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_replication_configuration(source_server_id)
update_replication_configuration(source_server_id, params::Dict{String,<:Any})
Allows you to update multiple ReplicationConfigurations by Source Server ID.
# Arguments
- `source_server_id`: Update replication configuration Source Server ID request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Update replication configuration Account ID request.
- `"associateDefaultSecurityGroup"`: Update replication configuration associate default
Application Migration Service Security group request.
- `"bandwidthThrottling"`: Update replication configuration bandwidth throttling request.
- `"createPublicIP"`: Update replication configuration create Public IP request.
- `"dataPlaneRouting"`: Update replication configuration data plane routing request.
- `"defaultLargeStagingDiskType"`: Update replication configuration use default large
Staging Disk type request.
- `"ebsEncryption"`: Update replication configuration EBS encryption request.
- `"ebsEncryptionKeyArn"`: Update replication configuration EBS encryption key ARN request.
- `"name"`: Update replication configuration name request.
- `"replicatedDisks"`: Update replication configuration replicated disks request.
- `"replicationServerInstanceType"`: Update replication configuration Replication Server
instance type request.
- `"replicationServersSecurityGroupsIDs"`: Update replication configuration Replication
Server Security Groups IDs request.
- `"stagingAreaSubnetId"`: Update replication configuration Staging Area subnet request.
- `"stagingAreaTags"`: Update replication configuration Staging Area Tags request.
- `"useDedicatedReplicationServer"`: Update replication configuration use dedicated
Replication Server request.
- `"useFipsEndpoint"`: Update replication configuration use Fips Endpoint.
"""
function update_replication_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateReplicationConfiguration",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_replication_configuration(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateReplicationConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_replication_configuration_template(replication_configuration_template_id)
update_replication_configuration_template(replication_configuration_template_id, params::Dict{String,<:Any})
Updates multiple ReplicationConfigurationTemplates by ID.
# Arguments
- `replication_configuration_template_id`: Update replication configuration template
template ID request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"arn"`: Update replication configuration template ARN request.
- `"associateDefaultSecurityGroup"`: Update replication configuration template associate
default Application Migration Service Security group request.
- `"bandwidthThrottling"`: Update replication configuration template bandwidth throttling
request.
- `"createPublicIP"`: Update replication configuration template create Public IP request.
- `"dataPlaneRouting"`: Update replication configuration template data plane routing
request.
- `"defaultLargeStagingDiskType"`: Update replication configuration template use default
large Staging Disk type request.
- `"ebsEncryption"`: Update replication configuration template EBS encryption request.
- `"ebsEncryptionKeyArn"`: Update replication configuration template EBS encryption key ARN
request.
- `"replicationServerInstanceType"`: Update replication configuration template Replication
Server instance type request.
- `"replicationServersSecurityGroupsIDs"`: Update replication configuration template
Replication Server Security groups IDs request.
- `"stagingAreaSubnetId"`: Update replication configuration template Staging Area subnet ID
request.
- `"stagingAreaTags"`: Update replication configuration template Staging Area Tags request.
- `"useDedicatedReplicationServer"`: Update replication configuration template use
dedicated Replication Server request.
- `"useFipsEndpoint"`: Update replication configuration template use Fips Endpoint request.
"""
function update_replication_configuration_template(
replicationConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateReplicationConfigurationTemplate",
Dict{String,Any}(
"replicationConfigurationTemplateID" => replicationConfigurationTemplateID
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_replication_configuration_template(
replicationConfigurationTemplateID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateReplicationConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"replicationConfigurationTemplateID" =>
replicationConfigurationTemplateID,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_source_server(source_server_id)
update_source_server(source_server_id, params::Dict{String,<:Any})
Update Source Server.
# Arguments
- `source_server_id`: Update Source Server request source server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Update Source Server request account ID.
- `"connectorAction"`: Update Source Server request connector action.
"""
function update_source_server(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateSourceServer",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_source_server(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateSourceServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_source_server_replication_type(replication_type, source_server_id)
update_source_server_replication_type(replication_type, source_server_id, params::Dict{String,<:Any})
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING
replication type.
# Arguments
- `replication_type`: Replication type to which to update source server.
- `source_server_id`: ID of source server on which to update replication type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID on which to update replication type.
"""
function update_source_server_replication_type(
replicationType, sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateSourceServerReplicationType",
Dict{String,Any}(
"replicationType" => replicationType, "sourceServerID" => sourceServerID
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_source_server_replication_type(
replicationType,
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mgn(
"POST",
"/UpdateSourceServerReplicationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"replicationType" => replicationType, "sourceServerID" => sourceServerID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_wave(wave_id)
update_wave(wave_id, params::Dict{String,<:Any})
Update wave.
# Arguments
- `wave_id`: Wave ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountID"`: Account ID.
- `"description"`: Wave description.
- `"name"`: Wave name.
"""
function update_wave(waveID; aws_config::AbstractAWSConfig=global_aws_config())
return mgn(
"POST",
"/UpdateWave",
Dict{String,Any}("waveID" => waveID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_wave(
waveID, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mgn(
"POST",
"/UpdateWave",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("waveID" => waveID), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 34936 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: migration_hub
using AWS.Compat
using AWS.UUIDs
"""
associate_created_artifact(created_artifact, migration_task_name, progress_update_stream)
associate_created_artifact(created_artifact, migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Associates a created artifact of an AWS cloud resource, the target receiving the migration,
with the migration task performed by a migration tool. This API has the following traits:
Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS
artifact is associated with a migration task. The created artifact name must be provided
in ARN (Amazon Resource Name) format which will contain information about type and region;
for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS
resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.
# Arguments
- `created_artifact`: An ARN of the AWS resource related to the migration (e.g., AMI, EC2
instance, RDS instance, etc.)
- `migration_task_name`: Unique identifier that references the migration task. Do not store
personal data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function associate_created_artifact(
CreatedArtifact,
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"AssociateCreatedArtifact",
Dict{String,Any}(
"CreatedArtifact" => CreatedArtifact,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_created_artifact(
CreatedArtifact,
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"AssociateCreatedArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatedArtifact" => CreatedArtifact,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_discovered_resource(discovered_resource, migration_task_name, progress_update_stream)
associate_discovered_resource(discovered_resource, migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Associates a discovered resource ID from Application Discovery Service with a migration
task.
# Arguments
- `discovered_resource`: Object representing a Resource.
- `migration_task_name`: The identifier given to the MigrationTask. Do not store personal
data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function associate_discovered_resource(
DiscoveredResource,
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"AssociateDiscoveredResource",
Dict{String,Any}(
"DiscoveredResource" => DiscoveredResource,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_discovered_resource(
DiscoveredResource,
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"AssociateDiscoveredResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiscoveredResource" => DiscoveredResource,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_progress_update_stream(progress_update_stream_name)
create_progress_update_stream(progress_update_stream_name, params::Dict{String,<:Any})
Creates a progress update stream which is an AWS resource used for access control as well
as a namespace for migration task names that is implicitly linked to your AWS account. It
must uniquely identify the migration tool as it is used for all updates made by the tool;
however, it does not need to be unique for each AWS account because it is scoped to the AWS
account.
# Arguments
- `progress_update_stream_name`: The name of the ProgressUpdateStream. Do not store
personal data in this field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function create_progress_update_stream(
ProgressUpdateStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"CreateProgressUpdateStream",
Dict{String,Any}("ProgressUpdateStreamName" => ProgressUpdateStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_progress_update_stream(
ProgressUpdateStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"CreateProgressUpdateStream",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ProgressUpdateStreamName" => ProgressUpdateStreamName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_progress_update_stream(progress_update_stream_name)
delete_progress_update_stream(progress_update_stream_name, params::Dict{String,<:Any})
Deletes a progress update stream, including all of its tasks, which was previously created
as an AWS resource used for access control. This API has the following traits: The only
parameter needed for DeleteProgressUpdateStream is the stream name (same as a
CreateProgressUpdateStream call). The call will return, and a background process will
asynchronously delete the stream and all of its resources (tasks, associated resources,
resource attributes, created artifacts). If the stream takes time to be deleted, it might
still show up on a ListProgressUpdateStreams call. CreateProgressUpdateStream,
ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs related to the
tasks belonging to the stream will throw \"InvalidInputException\" if the stream of the
same name is in the process of being deleted. Once the stream and all of its resources
are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and
that stream will be an entirely new logical resource (without any resources associated with
the old stream).
# Arguments
- `progress_update_stream_name`: The name of the ProgressUpdateStream. Do not store
personal data in this field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function delete_progress_update_stream(
ProgressUpdateStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"DeleteProgressUpdateStream",
Dict{String,Any}("ProgressUpdateStreamName" => ProgressUpdateStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_progress_update_stream(
ProgressUpdateStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DeleteProgressUpdateStream",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ProgressUpdateStreamName" => ProgressUpdateStreamName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_state(application_id)
describe_application_state(application_id, params::Dict{String,<:Any})
Gets the migration status of an application.
# Arguments
- `application_id`: The configurationId in Application Discovery Service that uniquely
identifies the grouped application.
"""
function describe_application_state(
ApplicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"DescribeApplicationState",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_state(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DescribeApplicationState",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_migration_task(migration_task_name, progress_update_stream)
describe_migration_task(migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Retrieves a list of all attributes associated with a specific migration task.
# Arguments
- `migration_task_name`: The identifier given to the MigrationTask. Do not store personal
data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
"""
function describe_migration_task(
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DescribeMigrationTask",
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_migration_task(
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DescribeMigrationTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_created_artifact(created_artifact_name, migration_task_name, progress_update_stream)
disassociate_created_artifact(created_artifact_name, migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Disassociates a created artifact of an AWS resource with a migration task performed by a
migration tool that was previously associated. This API has the following traits: A
migration user can call the DisassociateCreatedArtifacts operation to disassociate a
created AWS Artifact from a migration task. The created artifact name must be provided in
ARN (Amazon Resource Name) format which will contain information about type and region; for
example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS
resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.
# Arguments
- `created_artifact_name`: An ARN of the AWS resource related to the migration (e.g., AMI,
EC2 instance, RDS instance, etc.)
- `migration_task_name`: Unique identifier that references the migration task to be
disassociated with the artifact. Do not store personal data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function disassociate_created_artifact(
CreatedArtifactName,
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DisassociateCreatedArtifact",
Dict{String,Any}(
"CreatedArtifactName" => CreatedArtifactName,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_created_artifact(
CreatedArtifactName,
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DisassociateCreatedArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatedArtifactName" => CreatedArtifactName,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_discovered_resource(configuration_id, migration_task_name, progress_update_stream)
disassociate_discovered_resource(configuration_id, migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Disassociate an Application Discovery Service discovered resource from a migration task.
# Arguments
- `configuration_id`: ConfigurationId of the Application Discovery Service resource to be
disassociated.
- `migration_task_name`: The identifier given to the MigrationTask. Do not store personal
data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function disassociate_discovered_resource(
ConfigurationId,
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DisassociateDiscoveredResource",
Dict{String,Any}(
"ConfigurationId" => ConfigurationId,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_discovered_resource(
ConfigurationId,
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"DisassociateDiscoveredResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationId" => ConfigurationId,
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_migration_task(migration_task_name, progress_update_stream)
import_migration_task(migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Registers a new migration task which represents a server, database, etc., being migrated to
AWS by a migration tool. This API is a prerequisite to calling the NotifyMigrationTaskState
API as the migration tool must first register the migration task with Migration Hub.
# Arguments
- `migration_task_name`: Unique identifier that references the migration task. Do not store
personal data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream. >
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function import_migration_task(
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"ImportMigrationTask",
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_migration_task(
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"ImportMigrationTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_states()
list_application_states(params::Dict{String,<:Any})
Lists all the migration statuses for your applications. If you use the optional
ApplicationIds parameter, only the migration statuses for those applications will be
returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationIds"`: The configurationIds from the Application Discovery Service that
uniquely identifies your applications.
- `"MaxResults"`: Maximum number of results to be returned per page.
- `"NextToken"`: If a NextToken was returned by a previous call, there are more results
available. To retrieve the next page of results, make the call again using the returned
token in NextToken.
"""
function list_application_states(; aws_config::AbstractAWSConfig=global_aws_config())
return migration_hub(
"ListApplicationStates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_application_states(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"ListApplicationStates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_created_artifacts(migration_task_name, progress_update_stream)
list_created_artifacts(migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Lists the created artifacts attached to a given migration task in an update stream. This
API has the following traits: Gets the list of the created artifacts while migration is
taking place. Shows the artifacts created by the migration tool that was associated by
the AssociateCreatedArtifact API. Lists created artifacts in a paginated interface.
# Arguments
- `migration_task_name`: Unique identifier that references the migration task. Do not store
personal data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to be returned per page.
- `"NextToken"`: If a NextToken was returned by a previous call, there are more results
available. To retrieve the next page of results, make the call again using the returned
token in NextToken.
"""
function list_created_artifacts(
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"ListCreatedArtifacts",
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_created_artifacts(
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"ListCreatedArtifacts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_discovered_resources(migration_task_name, progress_update_stream)
list_discovered_resources(migration_task_name, progress_update_stream, params::Dict{String,<:Any})
Lists discovered resources associated with the given MigrationTask.
# Arguments
- `migration_task_name`: The name of the MigrationTask. Do not store personal data in this
field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results returned per page.
- `"NextToken"`: If a NextToken was returned by a previous call, there are more results
available. To retrieve the next page of results, make the call again using the returned
token in NextToken.
"""
function list_discovered_resources(
MigrationTaskName,
ProgressUpdateStream;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"ListDiscoveredResources",
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_discovered_resources(
MigrationTaskName,
ProgressUpdateStream,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"ListDiscoveredResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_migration_tasks()
list_migration_tasks(params::Dict{String,<:Any})
Lists all, or filtered by resource name, migration tasks associated with the user account
making this call. This API has the following traits: Can show a summary list of the most
recent migration tasks. Can show a summary list of migration tasks associated with a
given discovered resource. Lists migration tasks in a paginated interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Value to specify how many results are returned per page.
- `"NextToken"`: If a NextToken was returned by a previous call, there are more results
available. To retrieve the next page of results, make the call again using the returned
token in NextToken.
- `"ResourceName"`: Filter migration tasks by discovered resource name.
"""
function list_migration_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return migration_hub(
"ListMigrationTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_migration_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"ListMigrationTasks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_progress_update_streams()
list_progress_update_streams(params::Dict{String,<:Any})
Lists progress update streams associated with the user account making this call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Filter to limit the maximum number of results to list per page.
- `"NextToken"`: If a NextToken was returned by a previous call, there are more results
available. To retrieve the next page of results, make the call again using the returned
token in NextToken.
"""
function list_progress_update_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return migration_hub(
"ListProgressUpdateStreams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_progress_update_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"ListProgressUpdateStreams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_application_state(application_id, status)
notify_application_state(application_id, status, params::Dict{String,<:Any})
Sets the migration state of an application. For a given application identified by the value
passed to ApplicationId, its status is set or updated by passing one of three values to
Status: NOT_STARTED | IN_PROGRESS | COMPLETED.
# Arguments
- `application_id`: The configurationId in Application Discovery Service that uniquely
identifies the grouped application.
- `status`: Status of the application - Not Started, In-Progress, Complete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
- `"UpdateDateTime"`: The timestamp when the application state changed.
"""
function notify_application_state(
ApplicationId, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub(
"NotifyApplicationState",
Dict{String,Any}("ApplicationId" => ApplicationId, "Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_application_state(
ApplicationId,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"NotifyApplicationState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ApplicationId" => ApplicationId, "Status" => Status),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_migration_task_state(migration_task_name, next_update_seconds, progress_update_stream, task, update_date_time)
notify_migration_task_state(migration_task_name, next_update_seconds, progress_update_stream, task, update_date_time, params::Dict{String,<:Any})
Notifies Migration Hub of the current status, progress, or other detail regarding a
migration task. This API has the following traits: Migration tools will call the
NotifyMigrationTaskState API to share the latest progress and status. MigrationTaskName
is used for addressing updates to the correct target. ProgressUpdateStream is used for
access control and to provide a namespace for each migration tool.
# Arguments
- `migration_task_name`: Unique identifier that references the migration task. Do not store
personal data in this field.
- `next_update_seconds`: Number of seconds after the UpdateDateTime within which the
Migration Hub can expect an update. If Migration Hub does not receive an update within the
specified interval, then the migration task will be considered stale.
- `progress_update_stream`: The name of the ProgressUpdateStream.
- `task`: Information about the task's progress and status.
- `update_date_time`: The timestamp when the task was gathered.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function notify_migration_task_state(
MigrationTaskName,
NextUpdateSeconds,
ProgressUpdateStream,
Task,
UpdateDateTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"NotifyMigrationTaskState",
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"NextUpdateSeconds" => NextUpdateSeconds,
"ProgressUpdateStream" => ProgressUpdateStream,
"Task" => Task,
"UpdateDateTime" => UpdateDateTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_migration_task_state(
MigrationTaskName,
NextUpdateSeconds,
ProgressUpdateStream,
Task,
UpdateDateTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"NotifyMigrationTaskState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"NextUpdateSeconds" => NextUpdateSeconds,
"ProgressUpdateStream" => ProgressUpdateStream,
"Task" => Task,
"UpdateDateTime" => UpdateDateTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_attributes(migration_task_name, progress_update_stream, resource_attribute_list)
put_resource_attributes(migration_task_name, progress_update_stream, resource_attribute_list, params::Dict{String,<:Any})
Provides identifying details of the resource being migrated so that it can be associated in
the Application Discovery Service repository. This association occurs asynchronously after
PutResourceAttributes returns. Keep in mind that subsequent calls to
PutResourceAttributes will override previously stored attributes. For example, if it is
first called with a MAC address, but later, it is desired to add an IP address, it will
then be required to call it with both the IP and MAC addresses to prevent overriding the
MAC address. Note the instructions regarding the special use case of the
ResourceAttributeList parameter when specifying any \"VM\" related value. Because this
is an asynchronous call, it will always return 200, whether an association occurs or not.
To confirm if an association was found based on the provided details, call
ListDiscoveredResources.
# Arguments
- `migration_task_name`: Unique identifier that references the migration task. Do not store
personal data in this field.
- `progress_update_stream`: The name of the ProgressUpdateStream.
- `resource_attribute_list`: Information about the resource that is being migrated. This
data will be used to map the task to a resource in the Application Discovery Service
repository. Takes the object array of ResourceAttribute where the Type field is reserved
for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID
| VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER
where the identifying value can be a string up to 256 characters. If any \"VM\" related
value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a
minimum, is always set. If VM_MANAGER_ID is not set, then all \"VM\" fields will be
discarded and \"VM\" fields will not be used for matching the migration task to a server in
Application Discovery Service repository. See the Example section below for a use case of
specifying \"VM\" related values. If a server you are trying to match has multiple IP or
MAC addresses, you should provide as many as you know in separate type/value pairs passed
to the ResourceAttributeList parameter to maximize the chances of matching.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional boolean flag to indicate whether any effect should take place. Used
to test if the caller has permission to make the call.
"""
function put_resource_attributes(
MigrationTaskName,
ProgressUpdateStream,
ResourceAttributeList;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"PutResourceAttributes",
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
"ResourceAttributeList" => ResourceAttributeList,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_attributes(
MigrationTaskName,
ProgressUpdateStream,
ResourceAttributeList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub(
"PutResourceAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationTaskName" => MigrationTaskName,
"ProgressUpdateStream" => ProgressUpdateStream,
"ResourceAttributeList" => ResourceAttributeList,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 41031 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: migration_hub_refactor_spaces
using AWS.Compat
using AWS.UUIDs
"""
create_application(environment_identifier, name, proxy_type, vpc_id)
create_application(environment_identifier, name, proxy_type, vpc_id, params::Dict{String,<:Any})
Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that
owns the environment also owns the applications created inside the environment, regardless
of the account that creates the application. Refactor Spaces provisions an Amazon API
Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside
your account. In environments created with a CreateEnvironment:NetworkFabricType of NONE
you need to configure VPC to VPC connectivity between your service VPC and the application
proxy VPC to route traffic through the application proxy to a service with a private URL
endpoint. For more information, see Create an application in the Refactor Spaces User
Guide.
# Arguments
- `environment_identifier`: The unique identifier of the environment.
- `name`: The name to use for the application.
- `proxy_type`: The proxy type of the proxy created within the application.
- `vpc_id`: The ID of the virtual private cloud (VPC).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApiGatewayProxy"`: A wrapper object holding the API Gateway endpoint type and stage
name for the proxy.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"Tags"`: The tags to assign to the application. A tag is a label that you assign to an
Amazon Web Services resource. Each tag consists of a key-value pair.
"""
function create_application(
EnvironmentIdentifier,
Name,
ProxyType,
VpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments/$(EnvironmentIdentifier)/applications",
Dict{String,Any}(
"Name" => Name,
"ProxyType" => ProxyType,
"VpcId" => VpcId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
EnvironmentIdentifier,
Name,
ProxyType,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments/$(EnvironmentIdentifier)/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"ProxyType" => ProxyType,
"VpcId" => VpcId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(name, network_fabric_type)
create_environment(name, network_fabric_type, params::Dict{String,<:Any})
Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns
the environment resource, and all Refactor Spaces applications, services, and routes
created within the environment. They are referred to as the environment owner. The
environment owner has cross-account visibility and control of Refactor Spaces resources
that are added to the environment by other accounts that the environment is shared with.
When creating an environment with a CreateEnvironment:NetworkFabricType of TRANSIT_GATEWAY,
Refactor Spaces provisions a transit gateway to enable services in VPCs to communicate
directly across accounts. If CreateEnvironment:NetworkFabricType is NONE, Refactor Spaces
does not create a transit gateway and you must use your network infrastructure to route
traffic to services with private URL endpoints.
# Arguments
- `name`: The name of the environment.
- `network_fabric_type`: The network fabric type of the environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"Description"`: The description of the environment.
- `"Tags"`: The tags to assign to the environment. A tag is a label that you assign to an
Amazon Web Services resource. Each tag consists of a key-value pair.
"""
function create_environment(
Name, NetworkFabricType; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"POST",
"/environments",
Dict{String,Any}(
"Name" => Name,
"NetworkFabricType" => NetworkFabricType,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
Name,
NetworkFabricType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"NetworkFabricType" => NetworkFabricType,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_route(application_identifier, environment_identifier, route_type, service_identifier)
create_route(application_identifier, environment_identifier, route_type, service_identifier, params::Dict{String,<:Any})
Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of
the service resource is always the environment owner, regardless of which account creates
the route. Routes target a service in the application. If an application does not have any
routes, then the first route must be created as a DEFAULT RouteType. When created, the
default route defaults to an active state so state is not a required input. However, like
all other state values the state of the default route can be updated after creation, but
only when all other routes are also inactive. Conversely, no route can be active without
the default route also being active. When you create a route, Refactor Spaces configures
the Amazon API Gateway to send traffic to the target service as follows: URL Endpoints
If the service has a URL endpoint, and the endpoint resolves to a private IP address,
Refactor Spaces routes traffic using the API Gateway VPC link. If a service endpoint
resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates
are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain
is also publicly resolvable. Refactor Spaces automatically resolves the public Domain Name
System (DNS) names that are set in CreateService:UrlEndpoint when you create a service. The
DNS names resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs
less than 60 seconds. This periodic DNS resolution ensures that the route configuration
remains up-to-date. One-time health check A one-time health check is performed on the
service when either the route is updated from inactive to active, or when it is created
with an active state. If the health check fails, the route transitions the route state to
FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic
is sent to the service. For private URLs, a target group is created on the Network Load
Balancer and the load balancer target group runs default target health checks. By default,
the health check is run against the service endpoint URL. Optionally, the health check can
be performed against a different protocol, port, and/or path using the
CreateService:UrlEndpoint parameter. All other health check settings for the load balancer
use the default values described in the Health checks for your target groups in the Elastic
Load Balancing guide. The health check is considered successful if at least one target
within the target group transitions to a healthy state. Lambda function endpoints If
the service has an Lambda function endpoint, then Refactor Spaces configures the Lambda
function's resource policy to allow the application's API Gateway to invoke the function.
The Lambda function state is checked. If the function is not active, the function
configuration is updated so that Lambda resources are provisioned. If the Lambda state is
Failed, then the route creation fails. For more information, see the
GetFunctionConfiguration's State response parameter in the Lambda Developer Guide. A check
is performed to determine that a Lambda function with the specified ARN exists. If it does
not exist, the health check fails. For public URLs, a connection is opened to the public
endpoint. If the URL is not reachable, the health check fails. Environments without a
network bridge When you create environments without a network bridge
(CreateEnvironment:NetworkFabricType is NONE) and you use your own networking
infrastructure, you need to configure VPC to VPC connectivity between your network and the
application proxy VPC. Route creation from the application proxy to service endpoints will
fail if your network is not configured to connect to the application proxy VPC. For more
information, see Create a route in the Refactor Spaces User Guide.
# Arguments
- `application_identifier`: The ID of the application within which the route is being
created.
- `environment_identifier`: The ID of the environment in which the route is created.
- `route_type`: The route type of the route. DEFAULT indicates that all traffic that does
not match another route is forwarded to the default route. Applications must have a default
route before any other routes can be created. URI_PATH indicates a route that is based on a
URI path.
- `service_identifier`: The ID of the service in which the route is created. Traffic that
matches this route is forwarded to this service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"DefaultRoute"`: Configuration for the default route type.
- `"Tags"`: The tags to assign to the route. A tag is a label that you assign to an Amazon
Web Services resource. Each tag consists of a key-value pair..
- `"UriPathRoute"`: The configuration for the URI path route type.
"""
function create_route(
ApplicationIdentifier,
EnvironmentIdentifier,
RouteType,
ServiceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes",
Dict{String,Any}(
"RouteType" => RouteType,
"ServiceIdentifier" => ServiceIdentifier,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_route(
ApplicationIdentifier,
EnvironmentIdentifier,
RouteType,
ServiceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RouteType" => RouteType,
"ServiceIdentifier" => ServiceIdentifier,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service(application_identifier, endpoint_type, environment_identifier, name)
create_service(application_identifier, endpoint_type, environment_identifier, name, params::Dict{String,<:Any})
Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of
the service is always the environment owner, regardless of which account in the environment
creates the service. Services have either a URL endpoint in a virtual private cloud (VPC),
or a Lambda function endpoint. If an Amazon Web Services resource is launched in a service
VPC, and you want it to be accessible to all of an environment’s services with VPCs and
routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more
cross-account constraints, apply your own security group.
# Arguments
- `application_identifier`: The ID of the application which the service is created.
- `endpoint_type`: The type of endpoint to use for the service. The type can be a URL in a
VPC or an Lambda function.
- `environment_identifier`: The ID of the environment in which the service is created.
- `name`: The name of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"Description"`: The description of the service.
- `"LambdaEndpoint"`: The configuration for the Lambda endpoint type.
- `"Tags"`: The tags to assign to the service. A tag is a label that you assign to an
Amazon Web Services resource. Each tag consists of a key-value pair..
- `"UrlEndpoint"`: The configuration for the URL endpoint type. When creating a route to a
service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object
URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for
TTLs less than 60 seconds.
- `"VpcId"`: The ID of the VPC.
"""
function create_service(
ApplicationIdentifier,
EndpointType,
EnvironmentIdentifier,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services",
Dict{String,Any}(
"EndpointType" => EndpointType, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service(
ApplicationIdentifier,
EndpointType,
EnvironmentIdentifier,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointType" => EndpointType,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_identifier, environment_identifier)
delete_application(application_identifier, environment_identifier, params::Dict{String,<:Any})
Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can
delete an application, you must first delete any services or routes within the application.
# Arguments
- `application_identifier`: The ID of the application.
- `environment_identifier`: The ID of the environment.
"""
function delete_application(
ApplicationIdentifier,
EnvironmentIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
ApplicationIdentifier,
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(environment_identifier)
delete_environment(environment_identifier, params::Dict{String,<:Any})
Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can
delete an environment, you must first delete any applications and services within the
environment.
# Arguments
- `environment_identifier`: The ID of the environment.
"""
function delete_environment(
EnvironmentIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment(
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(identifier)
delete_resource_policy(identifier, params::Dict{String,<:Any})
Deletes the resource policy set for the environment.
# Arguments
- `identifier`: Amazon Resource Name (ARN) of the resource associated with the policy.
"""
function delete_resource_policy(
Identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"DELETE",
"/resourcepolicy/$(Identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/resourcepolicy/$(Identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_route(application_identifier, environment_identifier, route_identifier)
delete_route(application_identifier, environment_identifier, route_identifier, params::Dict{String,<:Any})
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
# Arguments
- `application_identifier`: The ID of the application to delete the route from.
- `environment_identifier`: The ID of the environment to delete the route from.
- `route_identifier`: The ID of the route to delete.
"""
function delete_route(
ApplicationIdentifier,
EnvironmentIdentifier,
RouteIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes/$(RouteIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_route(
ApplicationIdentifier,
EnvironmentIdentifier,
RouteIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes/$(RouteIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service(application_identifier, environment_identifier, service_identifier)
delete_service(application_identifier, environment_identifier, service_identifier, params::Dict{String,<:Any})
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
# Arguments
- `application_identifier`: Deletes a Refactor Spaces service. The
RefactorSpacesSecurityGroup security group must be removed from all Amazon Web Services
resources in the virtual private cloud (VPC) prior to deleting a service with a URL
endpoint in a VPC.
- `environment_identifier`: The ID of the environment that the service is in.
- `service_identifier`: The ID of the service to delete.
"""
function delete_service(
ApplicationIdentifier,
EnvironmentIdentifier,
ServiceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services/$(ServiceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service(
ApplicationIdentifier,
EnvironmentIdentifier,
ServiceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services/$(ServiceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application(application_identifier, environment_identifier)
get_application(application_identifier, environment_identifier, params::Dict{String,<:Any})
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
# Arguments
- `application_identifier`: The ID of the application.
- `environment_identifier`: The ID of the environment.
"""
function get_application(
ApplicationIdentifier,
EnvironmentIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application(
ApplicationIdentifier,
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(environment_identifier)
get_environment(environment_identifier, params::Dict{String,<:Any})
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
# Arguments
- `environment_identifier`: The ID of the environment.
"""
function get_environment(
EnvironmentIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment(
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy(identifier)
get_resource_policy(identifier, params::Dict{String,<:Any})
Gets the resource-based permission policy that is set for the given environment.
# Arguments
- `identifier`: The Amazon Resource Name (ARN) of the resource associated with the policy.
"""
function get_resource_policy(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return migration_hub_refactor_spaces(
"GET",
"/resourcepolicy/$(Identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policy(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/resourcepolicy/$(Identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_route(application_identifier, environment_identifier, route_identifier)
get_route(application_identifier, environment_identifier, route_identifier, params::Dict{String,<:Any})
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
# Arguments
- `application_identifier`: The ID of the application.
- `environment_identifier`: The ID of the environment.
- `route_identifier`: The ID of the route.
"""
function get_route(
ApplicationIdentifier,
EnvironmentIdentifier,
RouteIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes/$(RouteIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_route(
ApplicationIdentifier,
EnvironmentIdentifier,
RouteIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes/$(RouteIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service(application_identifier, environment_identifier, service_identifier)
get_service(application_identifier, environment_identifier, service_identifier, params::Dict{String,<:Any})
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
# Arguments
- `application_identifier`: The ID of the application.
- `environment_identifier`: The ID of the environment.
- `service_identifier`: The ID of the service.
"""
function get_service(
ApplicationIdentifier,
EnvironmentIdentifier,
ServiceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services/$(ServiceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service(
ApplicationIdentifier,
EnvironmentIdentifier,
ServiceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services/$(ServiceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications(environment_identifier)
list_applications(environment_identifier, params::Dict{String,<:Any})
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an
environment.
# Arguments
- `environment_identifier`: The ID of the environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
- `"nextToken"`: The token for the next page of results.
"""
function list_applications(
EnvironmentIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_applications(
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_vpcs(environment_identifier)
list_environment_vpcs(environment_identifier, params::Dict{String,<:Any})
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds
(VPCs) that are part of the environment.
# Arguments
- `environment_identifier`: The ID of the environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
- `"nextToken"`: The token for the next page of results.
"""
function list_environment_vpcs(
EnvironmentIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/vpcs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_vpcs(
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/vpcs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments()
list_environments(params::Dict{String,<:Any})
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller
account or shared with the caller account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
- `"nextToken"`: The token for the next page of results.
"""
function list_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return migration_hub_refactor_spaces(
"GET", "/environments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"GET",
"/environments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_routes(application_identifier, environment_identifier)
list_routes(application_identifier, environment_identifier, params::Dict{String,<:Any})
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an
application.
# Arguments
- `application_identifier`: The ID of the application.
- `environment_identifier`: The ID of the environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
- `"nextToken"`: The token for the next page of results.
"""
function list_routes(
ApplicationIdentifier,
EnvironmentIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_routes(
ApplicationIdentifier,
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_services(application_identifier, environment_identifier)
list_services(application_identifier, environment_identifier, params::Dict{String,<:Any})
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an
application.
# Arguments
- `application_identifier`: The ID of the application.
- `environment_identifier`: The ID of the environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
- `"nextToken"`: The token for the next page of results.
"""
function list_services(
ApplicationIdentifier,
EnvironmentIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_services(
ApplicationIdentifier,
EnvironmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/services",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags of a resource. The caller account must be the same as the resource’s
OwnerAccountId. Listing tags in other accounts is not supported.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Attaches a resource-based permission policy to the Amazon Web Services Migration Hub
Refactor Spaces environment. The policy must contain the same actions and condition
statements as the
arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in
Resource Access Manager. The policy must not contain new lines or blank lines.
# Arguments
- `policy`: A JSON-formatted string for an Amazon Web Services resource-based policy.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which the policy is
being attached.
"""
function put_resource_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"PUT",
"/resourcepolicy",
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
Policy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"PUT",
"/resourcepolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Removes the tags of a given resource. Tags are metadata which can be used to manage a
resource. To tag a resource, the caller account must be the same as the resource’s
OwnerAccountId. Tagging resources in other accounts is not supported. Amazon Web Services
Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an
environment’s transit gateway.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The new or modified tags for the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return migration_hub_refactor_spaces(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to
manage a resource. To untag a resource, the caller account must be the same as the
resource’s OwnerAccountId. Untagging resources across accounts is not supported.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The list of keys of the tags to be removed from the resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return migration_hub_refactor_spaces(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_route(activation_state, application_identifier, environment_identifier, route_identifier)
update_route(activation_state, application_identifier, environment_identifier, route_identifier, params::Dict{String,<:Any})
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
# Arguments
- `activation_state`: If set to ACTIVE, traffic is forwarded to this route’s service
after the route is updated.
- `application_identifier`: The ID of the application within which the route is being
updated.
- `environment_identifier`: The ID of the environment in which the route is being updated.
- `route_identifier`: The unique identifier of the route to update.
"""
function update_route(
ActivationState,
ApplicationIdentifier,
EnvironmentIdentifier,
RouteIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"PATCH",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes/$(RouteIdentifier)",
Dict{String,Any}("ActivationState" => ActivationState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_route(
ActivationState,
ApplicationIdentifier,
EnvironmentIdentifier,
RouteIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migration_hub_refactor_spaces(
"PATCH",
"/environments/$(EnvironmentIdentifier)/applications/$(ApplicationIdentifier)/routes/$(RouteIdentifier)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ActivationState" => ActivationState), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 5163 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: migrationhub_config
using AWS.Compat
using AWS.UUIDs
"""
create_home_region_control(home_region, target)
create_home_region_control(home_region, target, params::Dict{String,<:Any})
This API sets up the home region for the calling account only.
# Arguments
- `home_region`: The name of the home region of the calling account.
- `target`: The account for which this command sets up a home region control. The Target is
always of type ACCOUNT.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Optional Boolean flag to indicate whether any effect should take place. It
tests whether the caller has permission to make the call.
"""
function create_home_region_control(
HomeRegion, Target; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhub_config(
"CreateHomeRegionControl",
Dict{String,Any}("HomeRegion" => HomeRegion, "Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_home_region_control(
HomeRegion,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhub_config(
"CreateHomeRegionControl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HomeRegion" => HomeRegion, "Target" => Target),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_home_region_control(control_id)
delete_home_region_control(control_id, params::Dict{String,<:Any})
This operation deletes the home region configuration for the calling account. The operation
does not delete discovery or migration tracking data in the home region.
# Arguments
- `control_id`: A unique identifier that's generated for each home region control. It's
always a string that begins with \"hrc-\" followed by 12 lowercase letters and numbers.
"""
function delete_home_region_control(
ControlId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhub_config(
"DeleteHomeRegionControl",
Dict{String,Any}("ControlId" => ControlId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_home_region_control(
ControlId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhub_config(
"DeleteHomeRegionControl",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ControlId" => ControlId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_home_region_controls()
describe_home_region_controls(params::Dict{String,<:Any})
This API permits filtering on the ControlId and HomeRegion fields.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ControlId"`: The ControlID is a unique identifier string of your HomeRegionControl
object.
- `"HomeRegion"`: The name of the home region you'd like to view.
- `"MaxResults"`: The maximum number of filtering results to display per page.
- `"NextToken"`: If a NextToken was returned by a previous call, more results are
available. To retrieve the next page of results, make the call again using the returned
token in NextToken.
- `"Target"`: The target parameter specifies the identifier to which the home region is
applied, which is always of type ACCOUNT. It applies the home region to the current ACCOUNT.
"""
function describe_home_region_controls(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhub_config(
"DescribeHomeRegionControls"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_home_region_controls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhub_config(
"DescribeHomeRegionControls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_home_region()
get_home_region(params::Dict{String,<:Any})
Returns the calling account’s home region, if configured. This API is used by other AWS
services to determine the regional endpoint for calling AWS Application Discovery Service
and Migration Hub. You must call GetHomeRegion at least once before you call any other AWS
Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration
Hub home region.
"""
function get_home_region(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhub_config(
"GetHomeRegion"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_home_region(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhub_config(
"GetHomeRegion", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 36290 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: migrationhuborchestrator
using AWS.Compat
using AWS.UUIDs
"""
create_template(template_name, template_source)
create_template(template_name, template_source, params::Dict{String,<:Any})
Creates a migration workflow template.
# Arguments
- `template_name`: The name of the migration workflow template.
- `template_source`: The source of the migration workflow template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Idempotency in the Smithy
documentation.
- `"tags"`: The tags to add to the migration workflow template.
- `"templateDescription"`: A description of the migration workflow template.
"""
function create_template(
templateName, templateSource; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/template",
Dict{String,Any}(
"templateName" => templateName,
"templateSource" => templateSource,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template(
templateName,
templateSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/template",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"templateName" => templateName,
"templateSource" => templateSource,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow(input_parameters, name, template_id)
create_workflow(input_parameters, name, template_id, params::Dict{String,<:Any})
Create a workflow to orchestrate your migrations.
# Arguments
- `input_parameters`: The input parameters required to create a migration workflow.
- `name`: The name of the migration workflow.
- `template_id`: The ID of the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationConfigurationId"`: The configuration ID of the application configured in
Application Discovery Service.
- `"description"`: The description of the migration workflow.
- `"stepTargets"`: The servers on which a step will be run.
- `"tags"`: The tags to add on a migration workflow.
"""
function create_workflow(
inputParameters, name, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/migrationworkflow/",
Dict{String,Any}(
"inputParameters" => inputParameters, "name" => name, "templateId" => templateId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow(
inputParameters,
name,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/migrationworkflow/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputParameters" => inputParameters,
"name" => name,
"templateId" => templateId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow_step(name, step_action_type, step_group_id, workflow_id)
create_workflow_step(name, step_action_type, step_group_id, workflow_id, params::Dict{String,<:Any})
Create a step in the migration workflow.
# Arguments
- `name`: The name of the step.
- `step_action_type`: The action type of the step. You must run and update the status of a
manual step for the workflow to continue after the completion of the step.
- `step_group_id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the step.
- `"next"`: The next step.
- `"outputs"`: The key value pairs added for the expected output.
- `"previous"`: The previous step.
- `"stepTarget"`: The servers on which a step will be run.
- `"workflowStepAutomationConfiguration"`: The custom script to run tests on source or
target environments.
"""
function create_workflow_step(
name,
stepActionType,
stepGroupId,
workflowId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/workflowstep",
Dict{String,Any}(
"name" => name,
"stepActionType" => stepActionType,
"stepGroupId" => stepGroupId,
"workflowId" => workflowId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow_step(
name,
stepActionType,
stepGroupId,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/workflowstep",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"stepActionType" => stepActionType,
"stepGroupId" => stepGroupId,
"workflowId" => workflowId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow_step_group(name, workflow_id)
create_workflow_step_group(name, workflow_id, params::Dict{String,<:Any})
Create a step group in a migration workflow.
# Arguments
- `name`: The name of the step group.
- `workflow_id`: The ID of the migration workflow that will contain the step group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the step group.
- `"next"`: The next step group.
- `"previous"`: The previous step group.
"""
function create_workflow_step_group(
name, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/workflowstepgroups",
Dict{String,Any}("name" => name, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow_step_group(
name,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/workflowstepgroups",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "workflowId" => workflowId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template(id)
delete_template(id, params::Dict{String,<:Any})
Deletes a migration workflow template.
# Arguments
- `id`: The ID of the request to delete a migration workflow template.
"""
function delete_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"DELETE", "/template/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"DELETE",
"/template/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(id)
delete_workflow(id, params::Dict{String,<:Any})
Delete a migration workflow. You must pause a running workflow in Migration Hub
Orchestrator console to delete it.
# Arguments
- `id`: The ID of the migration workflow you want to delete.
"""
function delete_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"DELETE",
"/migrationworkflow/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"DELETE",
"/migrationworkflow/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow_step(id, step_group_id, workflow_id)
delete_workflow_step(id, step_group_id, workflow_id, params::Dict{String,<:Any})
Delete a step in a migration workflow. Pause the workflow to delete a running step.
# Arguments
- `id`: The ID of the step you want to delete.
- `step_group_id`: The ID of the step group that contains the step you want to delete.
- `workflow_id`: The ID of the migration workflow.
"""
function delete_workflow_step(
id, stepGroupId, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"DELETE",
"/workflowstep/$(id)",
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow_step(
id,
stepGroupId,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"DELETE",
"/workflowstep/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow_step_group(id, workflow_id)
delete_workflow_step_group(id, workflow_id, params::Dict{String,<:Any})
Delete a step group in a migration workflow.
# Arguments
- `id`: The ID of the step group you want to delete.
- `workflow_id`: The ID of the migration workflow.
"""
function delete_workflow_step_group(
id, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"DELETE",
"/workflowstepgroup/$(id)",
Dict{String,Any}("workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow_step_group(
id,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"DELETE",
"/workflowstepgroup/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workflowId" => workflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template(id)
get_template(id, params::Dict{String,<:Any})
Get the template you want to use for creating a migration workflow.
# Arguments
- `id`: The ID of the template.
"""
function get_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"GET",
"/migrationworkflowtemplate/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/migrationworkflowtemplate/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template_step(id, step_group_id, template_id)
get_template_step(id, step_group_id, template_id, params::Dict{String,<:Any})
Get a specific step in a template.
# Arguments
- `id`: The ID of the step.
- `step_group_id`: The ID of the step group.
- `template_id`: The ID of the template.
"""
function get_template_step(
id, stepGroupId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/templatestep/$(id)",
Dict{String,Any}("stepGroupId" => stepGroupId, "templateId" => templateId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template_step(
id,
stepGroupId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/templatestep/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stepGroupId" => stepGroupId, "templateId" => templateId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template_step_group(id, template_id)
get_template_step_group(id, template_id, params::Dict{String,<:Any})
Get a step group in a template.
# Arguments
- `id`: The ID of the step group.
- `template_id`: The ID of the template.
"""
function get_template_step_group(
id, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/templates/$(templateId)/stepgroups/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template_step_group(
id,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/templates/$(templateId)/stepgroups/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow(id)
get_workflow(id, params::Dict{String,<:Any})
Get migration workflow.
# Arguments
- `id`: The ID of the migration workflow.
"""
function get_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"GET",
"/migrationworkflow/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/migrationworkflow/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_step(id, step_group_id, workflow_id)
get_workflow_step(id, step_group_id, workflow_id, params::Dict{String,<:Any})
Get a step in the migration workflow.
# Arguments
- `id`: The ID of the step.
- `step_group_id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
"""
function get_workflow_step(
id, stepGroupId, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/workflowstep/$(id)",
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_step(
id,
stepGroupId,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/workflowstep/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_step_group(id, workflow_id)
get_workflow_step_group(id, workflow_id, params::Dict{String,<:Any})
Get the step group of a migration workflow.
# Arguments
- `id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
"""
function get_workflow_step_group(
id, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/workflowstepgroup/$(id)",
Dict{String,Any}("workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_step_group(
id,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/workflowstepgroup/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workflowId" => workflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_plugins()
list_plugins(params::Dict{String,<:Any})
List AWS Migration Hub Orchestrator plugins.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of plugins that can be returned.
- `"nextToken"`: The pagination token.
"""
function list_plugins(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"GET", "/plugins"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_plugins(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET", "/plugins", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
List the tags added to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_step_groups(template_id)
list_template_step_groups(template_id, params::Dict{String,<:Any})
List the step groups in a template.
# Arguments
- `template_id`: The ID of the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that can be returned.
- `"nextToken"`: The pagination token.
"""
function list_template_step_groups(
templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/templatestepgroups/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_step_groups(
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/templatestepgroups/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_steps(step_group_id, template_id)
list_template_steps(step_group_id, template_id, params::Dict{String,<:Any})
List the steps in a template.
# Arguments
- `step_group_id`: The ID of the step group.
- `template_id`: The ID of the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that can be returned.
- `"nextToken"`: The pagination token.
"""
function list_template_steps(
stepGroupId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/templatesteps",
Dict{String,Any}("stepGroupId" => stepGroupId, "templateId" => templateId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_steps(
stepGroupId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/templatesteps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stepGroupId" => stepGroupId, "templateId" => templateId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates()
list_templates(params::Dict{String,<:Any})
List the templates available in Migration Hub Orchestrator to create a migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that can be returned.
- `"name"`: The name of the template.
- `"nextToken"`: The pagination token.
"""
function list_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"GET",
"/migrationworkflowtemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/migrationworkflowtemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflow_step_groups(workflow_id)
list_workflow_step_groups(workflow_id, params::Dict{String,<:Any})
List the step groups in a migration workflow.
# Arguments
- `workflow_id`: The ID of the migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that can be returned.
- `"nextToken"`: The pagination token.
"""
function list_workflow_step_groups(
workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/workflowstepgroups",
Dict{String,Any}("workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflow_step_groups(
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/workflowstepgroups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workflowId" => workflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflow_steps(step_group_id, workflow_id)
list_workflow_steps(step_group_id, workflow_id, params::Dict{String,<:Any})
List the steps in a workflow.
# Arguments
- `step_group_id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that can be returned.
- `"nextToken"`: The pagination token.
"""
function list_workflow_steps(
stepGroupId, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/workflow/$(workflowId)/workflowstepgroups/$(stepGroupId)/workflowsteps";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflow_steps(
stepGroupId,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"GET",
"/workflow/$(workflowId)/workflowstepgroups/$(stepGroupId)/workflowsteps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflows()
list_workflows(params::Dict{String,<:Any})
List the migration workflows.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adsApplicationConfigurationName"`: The name of the application configured in
Application Discovery Service.
- `"maxResults"`: The maximum number of results that can be returned.
- `"name"`: The name of the migration workflow.
- `"nextToken"`: The pagination token.
- `"status"`: The status of the migration workflow.
- `"templateId"`: The ID of the template.
"""
function list_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"GET", "/migrationworkflows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"GET",
"/migrationworkflows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retry_workflow_step(id, step_group_id, workflow_id)
retry_workflow_step(id, step_group_id, workflow_id, params::Dict{String,<:Any})
Retry a failed step in a migration workflow.
# Arguments
- `id`: The ID of the step.
- `step_group_id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
"""
function retry_workflow_step(
id, stepGroupId, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/retryworkflowstep/$(id)",
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retry_workflow_step(
id,
stepGroupId,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/retryworkflowstep/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_workflow(id)
start_workflow(id, params::Dict{String,<:Any})
Start a migration workflow.
# Arguments
- `id`: The ID of the migration workflow.
"""
function start_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"POST",
"/migrationworkflow/$(id)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/migrationworkflow/$(id)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_workflow(id)
stop_workflow(id, params::Dict{String,<:Any})
Stop an ongoing migration workflow.
# Arguments
- `id`: The ID of the migration workflow.
"""
function stop_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"POST",
"/migrationworkflow/$(id)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/migrationworkflow/$(id)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Tag a resource by specifying its Amazon Resource Name (ARN).
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which you want to add
tags.
- `tags`: A collection of labels, in the form of key:value pairs, that apply to this
resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Deletes the tags for a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource from which you want to
remove tags.
- `tag_keys`: One or more tag keys. Specify only the tag keys, not the tag values.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template(id)
update_template(id, params::Dict{String,<:Any})
Updates a migration workflow template.
# Arguments
- `id`: The ID of the request to update a migration workflow template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"templateDescription"`: The description of the migration workflow template to update.
- `"templateName"`: The name of the migration workflow template to update.
"""
function update_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"POST",
"/template/$(id)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/template/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workflow(id)
update_workflow(id, params::Dict{String,<:Any})
Update a migration workflow.
# Arguments
- `id`: The ID of the migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the migration workflow.
- `"inputParameters"`: The input parameters required to update a migration workflow.
- `"name"`: The name of the migration workflow.
- `"stepTargets"`: The servers on which a step will be run.
"""
function update_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhuborchestrator(
"POST",
"/migrationworkflow/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/migrationworkflow/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workflow_step(id, step_group_id, workflow_id)
update_workflow_step(id, step_group_id, workflow_id, params::Dict{String,<:Any})
Update a step in a migration workflow.
# Arguments
- `id`: The ID of the step.
- `step_group_id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the step.
- `"name"`: The name of the step.
- `"next"`: The next step.
- `"outputs"`: The outputs of a step.
- `"previous"`: The previous step.
- `"status"`: The status of the step.
- `"stepActionType"`: The action type of the step. You must run and update the status of a
manual step for the workflow to continue after the completion of the step.
- `"stepTarget"`: The servers on which a step will be run.
- `"workflowStepAutomationConfiguration"`: The custom script to run tests on the source and
target environments.
"""
function update_workflow_step(
id, stepGroupId, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/workflowstep/$(id)",
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workflow_step(
id,
stepGroupId,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/workflowstep/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stepGroupId" => stepGroupId, "workflowId" => workflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workflow_step_group(id, workflow_id)
update_workflow_step_group(id, workflow_id, params::Dict{String,<:Any})
Update the step group in a migration workflow.
# Arguments
- `id`: The ID of the step group.
- `workflow_id`: The ID of the migration workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the step group.
- `"name"`: The name of the step group.
- `"next"`: The next step group.
- `"previous"`: The previous step group.
"""
function update_workflow_step_group(
id, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhuborchestrator(
"POST",
"/workflowstepgroup/$(id)",
Dict{String,Any}("workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workflow_step_group(
id,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhuborchestrator(
"POST",
"/workflowstepgroup/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workflowId" => workflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 26022 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: migrationhubstrategy
using AWS.Compat
using AWS.UUIDs
"""
get_application_component_details(application_component_id)
get_application_component_details(application_component_id, params::Dict{String,<:Any})
Retrieves details about an application component.
# Arguments
- `application_component_id`: The ID of the application component. The ID is unique within
an AWS account.
"""
function get_application_component_details(
applicationComponentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-applicationcomponent-details/$(applicationComponentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_component_details(
applicationComponentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"GET",
"/get-applicationcomponent-details/$(applicationComponentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_component_strategies(application_component_id)
get_application_component_strategies(application_component_id, params::Dict{String,<:Any})
Retrieves a list of all the recommended strategies and tools for an application component
running on a server.
# Arguments
- `application_component_id`: The ID of the application component. The ID is unique within
an AWS account.
"""
function get_application_component_strategies(
applicationComponentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-applicationcomponent-strategies/$(applicationComponentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_component_strategies(
applicationComponentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"GET",
"/get-applicationcomponent-strategies/$(applicationComponentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assessment(id)
get_assessment(id, params::Dict{String,<:Any})
Retrieves the status of an on-going assessment.
# Arguments
- `id`: The assessmentid returned by StartAssessment.
"""
function get_assessment(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-assessment/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assessment(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-assessment/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import_file_task(id)
get_import_file_task(id, params::Dict{String,<:Any})
Retrieves the details about a specific import task.
# Arguments
- `id`: The ID of the import file task. This ID is returned in the response of
StartImportFileTask.
"""
function get_import_file_task(id; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-import-file-task/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import_file_task(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-import-file-task/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_latest_assessment_id()
get_latest_assessment_id(params::Dict{String,<:Any})
Retrieve the latest ID of a specific assessment task.
"""
function get_latest_assessment_id(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-latest-assessment-id";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_latest_assessment_id(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-latest-assessment-id",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_portfolio_preferences()
get_portfolio_preferences(params::Dict{String,<:Any})
Retrieves your migration and modernization preferences.
"""
function get_portfolio_preferences(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-portfolio-preferences";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_portfolio_preferences(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-portfolio-preferences",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_portfolio_summary()
get_portfolio_summary(params::Dict{String,<:Any})
Retrieves overall summary including the number of servers to rehost and the overall number
of anti-patterns.
"""
function get_portfolio_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-portfolio-summary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_portfolio_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-portfolio-summary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendation_report_details(id)
get_recommendation_report_details(id, params::Dict{String,<:Any})
Retrieves detailed information about the specified recommendation report.
# Arguments
- `id`: The recommendation report generation task id returned by
StartRecommendationReportGeneration.
"""
function get_recommendation_report_details(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-recommendation-report-details/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendation_report_details(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/get-recommendation-report-details/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_server_details(server_id)
get_server_details(server_id, params::Dict{String,<:Any})
Retrieves detailed information about a specified server.
# Arguments
- `server_id`: The ID of the server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in the response. The maximum
value is 100.
- `"nextToken"`: The token from a previous call that you use to retrieve the next set of
results. For example, if a previous call to this action returned 100 items, but you set
maxResults to 10. You'll receive a set of 10 results along with a token. You then use the
returned token to retrieve the next set of 10.
"""
function get_server_details(serverId; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-server-details/$(serverId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_server_details(
serverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"GET",
"/get-server-details/$(serverId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_server_strategies(server_id)
get_server_strategies(server_id, params::Dict{String,<:Any})
Retrieves recommended strategies and tools for the specified server.
# Arguments
- `server_id`: The ID of the server.
"""
function get_server_strategies(serverId; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/get-server-strategies/$(serverId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_server_strategies(
serverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"GET",
"/get-server-strategies/$(serverId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_analyzable_servers()
list_analyzable_servers(params::Dict{String,<:Any})
Retrieves a list of all the servers fetched from customer vCenter using Strategy
Recommendation Collector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in the response. The maximum value
is 100.
- `"nextToken"`: The token from a previous call that you use to retrieve the next set of
results. For example, if a previous call to this action returned 100 items, but you set
maxResults to 10. You'll receive a set of 10 results along with a token. You then use the
returned token to retrieve the next set of 10.
- `"sort"`: Specifies whether to sort by ascending (ASC) or descending (DESC) order.
"""
function list_analyzable_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST",
"/list-analyzable-servers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_analyzable_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/list-analyzable-servers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_components()
list_application_components(params::Dict{String,<:Any})
Retrieves a list of all the application components (processes).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationComponentCriteria"`: Criteria for filtering the list of application
components.
- `"filterValue"`: Specify the value based on the application component criteria type. For
example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to
server1, then ListApplicationComponents returns all the application components running on
server1.
- `"groupIdFilter"`: The group ID specified in to filter on.
- `"maxResults"`: The maximum number of items to include in the response. The maximum
value is 100.
- `"nextToken"`: The token from a previous call that you use to retrieve the next set of
results. For example, if a previous call to this action returned 100 items, but you set
maxResults to 10. You'll receive a set of 10 results along with a token. You then use the
returned token to retrieve the next set of 10.
- `"sort"`: Specifies whether to sort by ascending (ASC) or descending (DESC) order.
"""
function list_application_components(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST",
"/list-applicationcomponents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/list-applicationcomponents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_collectors()
list_collectors(params::Dict{String,<:Any})
Retrieves a list of all the installed collectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to include in the response. The maximum
value is 100.
- `"nextToken"`: The token from a previous call that you use to retrieve the next set of
results. For example, if a previous call to this action returned 100 items, but you set
maxResults to 10. You'll receive a set of 10 results along with a token. You then use the
returned token to retrieve the next set of 10.
"""
function list_collectors(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET", "/list-collectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_collectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/list-collectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_import_file_task()
list_import_file_task(params::Dict{String,<:Any})
Retrieves a list of all the imports performed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The total number of items to return. The maximum value is 100.
- `"nextToken"`: The token from a previous call that you use to retrieve the next set of
results. For example, if a previous call to this action returned 100 items, but you set
maxResults to 10. You'll receive a set of 10 results along with a token. You then use the
returned token to retrieve the next set of 10.
"""
function list_import_file_task(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"GET",
"/list-import-file-task";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_import_file_task(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"GET",
"/list-import-file-task",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_servers()
list_servers(params::Dict{String,<:Any})
Returns a list of all the servers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterValue"`: Specifies the filter value, which is based on the type of server
criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to
WindowsServer, then ListServers returns all of the servers matching the OS name
WindowsServer.
- `"groupIdFilter"`: Specifies the group ID to filter on.
- `"maxResults"`: The maximum number of items to include in the response. The maximum
value is 100.
- `"nextToken"`: The token from a previous call that you use to retrieve the next set of
results. For example, if a previous call to this action returned 100 items, but you set
maxResults to 10. You'll receive a set of 10 results along with a token. You then use the
returned token to retrieve the next set of 10.
- `"serverCriteria"`: Criteria for filtering servers.
- `"sort"`: Specifies whether to sort by ascending (ASC) or descending (DESC) order.
"""
function list_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST", "/list-servers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/list-servers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_portfolio_preferences()
put_portfolio_preferences(params::Dict{String,<:Any})
Saves the specified migration and modernization preferences.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationMode"`: The classification for application component types.
- `"applicationPreferences"`: The transformation preferences for non-database
applications.
- `"databasePreferences"`: The transformation preferences for database applications.
- `"prioritizeBusinessGoals"`: The rank of the business goals based on priority.
"""
function put_portfolio_preferences(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST",
"/put-portfolio-preferences";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_portfolio_preferences(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/put-portfolio-preferences",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_assessment()
start_assessment(params::Dict{String,<:Any})
Starts the assessment of an on-premises environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentDataSourceType"`: The data source type of an assessment to be started.
- `"assessmentTargets"`: List of criteria for assessment.
- `"s3bucketForAnalysisData"`: The S3 bucket used by the collectors to send analysis data
to the service. The bucket name must begin with migrationhub-strategy-.
- `"s3bucketForReportData"`: The S3 bucket where all the reports generated by the service
are stored. The bucket name must begin with migrationhub-strategy-.
"""
function start_assessment(; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST", "/start-assessment"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function start_assessment(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/start-assessment",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import_file_task(s3_bucket, name, s3key)
start_import_file_task(s3_bucket, name, s3key, params::Dict{String,<:Any})
Starts a file import.
# Arguments
- `s3_bucket`: The S3 bucket where the import file is located. The bucket name is required
to begin with migrationhub-strategy-.
- `name`: A descriptive name for the request.
- `s3key`: The Amazon S3 key name of the import file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceType"`: Specifies the source that the servers are coming from. By default,
Strategy Recommendations assumes that the servers specified in the import file are
available in AWS Application Discovery Service.
- `"groupId"`: Groups the resources in the import file together with a unique name. This ID
can be as filter in ListApplicationComponents and ListServers.
- `"s3bucketForReportData"`: The S3 bucket where Strategy Recommendations uploads import
results. The bucket name is required to begin with migrationhub-strategy-.
"""
function start_import_file_task(
S3Bucket, name, s3key; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/start-import-file-task",
Dict{String,Any}("S3Bucket" => S3Bucket, "name" => name, "s3key" => s3key);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import_file_task(
S3Bucket,
name,
s3key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"POST",
"/start-import-file-task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("S3Bucket" => S3Bucket, "name" => name, "s3key" => s3key),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_recommendation_report_generation()
start_recommendation_report_generation(params::Dict{String,<:Any})
Starts generating a recommendation report.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groupIdFilter"`: Groups the resources in the recommendation report with a unique name.
- `"outputFormat"`: The output format for the recommendation report file. The default
format is Microsoft Excel.
"""
function start_recommendation_report_generation(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/start-recommendation-report-generation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_recommendation_report_generation(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/start-recommendation-report-generation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_assessment(assessment_id)
stop_assessment(assessment_id, params::Dict{String,<:Any})
Stops the assessment of an on-premises environment.
# Arguments
- `assessment_id`: The assessmentId returned by StartAssessment.
"""
function stop_assessment(assessmentId; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST",
"/stop-assessment",
Dict{String,Any}("assessmentId" => assessmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_assessment(
assessmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"POST",
"/stop-assessment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentId" => assessmentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application_component_config(application_component_id)
update_application_component_config(application_component_id, params::Dict{String,<:Any})
Updates the configuration of an application component.
# Arguments
- `application_component_id`: The ID of the application component. The ID is unique within
an AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appType"`: The type of known component.
- `"configureOnly"`: Update the configuration request of an application component. If it is
set to true, the source code and/or database credentials are updated. If it is set to
false, the source code and/or database credentials are updated and an analysis is initiated.
- `"inclusionStatus"`: Indicates whether the application component has been included for
server recommendation or not.
- `"secretsManagerKey"`: Database credentials.
- `"sourceCodeList"`: The list of source code configurations to update for the application
component.
- `"strategyOption"`: The preferred strategy options for the application component. Use
values from the GetApplicationComponentStrategies response.
"""
function update_application_component_config(
applicationComponentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return migrationhubstrategy(
"POST",
"/update-applicationcomponent-config/",
Dict{String,Any}("applicationComponentId" => applicationComponentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_component_config(
applicationComponentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"POST",
"/update-applicationcomponent-config/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("applicationComponentId" => applicationComponentId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_server_config(server_id)
update_server_config(server_id, params::Dict{String,<:Any})
Updates the configuration of the specified server.
# Arguments
- `server_id`: The ID of the server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"strategyOption"`: The preferred strategy options for the application component. See
the response from GetServerStrategies.
"""
function update_server_config(serverId; aws_config::AbstractAWSConfig=global_aws_config())
return migrationhubstrategy(
"POST",
"/update-server-config/",
Dict{String,Any}("serverId" => serverId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_server_config(
serverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return migrationhubstrategy(
"POST",
"/update-server-config/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serverId" => serverId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 8848 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mobile
using AWS.Compat
using AWS.UUIDs
"""
create_project()
create_project(params::Dict{String,<:Any})
Creates an AWS Mobile Hub project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contents"`: ZIP or YAML file which contains configuration settings to be used when
creating the project. This may be the contents of the file downloaded from the URL provided
in an export project operation.
- `"name"`: Name of the project.
- `"region"`: Default region where project resources should be created.
- `"snapshotId"`: Unique identifier for an exported snapshot of project configuration.
This snapshot identifier is included in the share URL when a project is exported.
"""
function create_project(; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"POST", "/projects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_project(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mobile(
"POST", "/projects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_project(project_id)
delete_project(project_id, params::Dict{String,<:Any})
Delets a project in AWS Mobile Hub.
# Arguments
- `project_id`: Unique project identifier.
"""
function delete_project(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"DELETE",
"/projects/$(projectId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile(
"DELETE",
"/projects/$(projectId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bundle(bundle_id)
describe_bundle(bundle_id, params::Dict{String,<:Any})
Get the bundle details for the requested bundle id.
# Arguments
- `bundle_id`: Unique bundle identifier.
"""
function describe_bundle(bundleId; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"GET",
"/bundles/$(bundleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bundle(
bundleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile(
"GET",
"/bundles/$(bundleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(project_id)
describe_project(project_id, params::Dict{String,<:Any})
Gets details about a project in AWS Mobile Hub.
# Arguments
- `project_id`: Unique project identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"syncFromResources"`: If set to true, causes AWS Mobile Hub to synchronize information
from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub
project.
"""
function describe_project(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"GET",
"/project",
Dict{String,Any}("projectId" => projectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_project(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile(
"GET",
"/project",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectId" => projectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_bundle(bundle_id)
export_bundle(bundle_id, params::Dict{String,<:Any})
Generates customized software development kit (SDK) and or tool packages used to integrate
mobile web or mobile app clients with backend AWS resources.
# Arguments
- `bundle_id`: Unique bundle identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"platform"`: Developer desktop or target application platform.
- `"projectId"`: Unique project identifier.
"""
function export_bundle(bundleId; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"POST",
"/bundles/$(bundleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_bundle(
bundleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile(
"POST",
"/bundles/$(bundleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_project(project_id)
export_project(project_id, params::Dict{String,<:Any})
Exports project configuration to a snapshot which can be downloaded and shared. Note that
mobile app push credentials are encrypted in exported projects, so they can only be shared
successfully within the same AWS account.
# Arguments
- `project_id`: Unique project identifier.
"""
function export_project(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"POST",
"/exports/$(projectId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_project(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile(
"POST",
"/exports/$(projectId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bundles()
list_bundles(params::Dict{String,<:Any})
List all available bundles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of records to list in a single response.
- `"nextToken"`: Pagination token. Set to null to start listing bundles from start. If
non-null pagination token is returned in a result, then pass its value in here in another
request to list more bundles.
"""
function list_bundles(; aws_config::AbstractAWSConfig=global_aws_config())
return mobile("GET", "/bundles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_bundles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mobile(
"GET", "/bundles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Lists projects in AWS Mobile Hub.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of records to list in a single response.
- `"nextToken"`: Pagination token. Set to null to start listing projects from start. If
non-null pagination token is returned in a result, then pass its value in here in another
request to list more projects.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"GET", "/projects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mobile(
"GET", "/projects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_project(project_id)
update_project(project_id, params::Dict{String,<:Any})
Update an existing project.
# Arguments
- `project_id`: Unique project identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contents"`: ZIP or YAML file which contains project configuration to be updated. This
should be the contents of the file downloaded from the URL provided in an export project
operation.
"""
function update_project(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return mobile(
"POST",
"/update",
Dict{String,Any}("projectId" => projectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile(
"POST",
"/update",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectId" => projectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 1913 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mobile_analytics
using AWS.Compat
using AWS.UUIDs
"""
put_events(events, x-amz-_client-_context)
put_events(events, x-amz-_client-_context, params::Dict{String,<:Any})
The PutEvents operation records one or more events. You can have up to 1,500 unique custom
events per app, any combination of up to 40 attributes and metrics per custom event, and
any number of attribute or metric values.
# Arguments
- `events`: An array of Event JSON objects
- `x-amz-_client-_context`: The client context including the client ID, app title, app
version and package name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-Client-Context-Encoding"`: The encoding used for the client context.
"""
function put_events(
events, x_amz_Client_Context; aws_config::AbstractAWSConfig=global_aws_config()
)
return mobile_analytics(
"POST",
"/2014-06-05/events",
Dict{String,Any}(
"events" => events,
"headers" => Dict{String,Any}("x-amz-Client-Context" => x_amz_Client_Context),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_events(
events,
x_amz_Client_Context,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mobile_analytics(
"POST",
"/2014-06-05/events",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"events" => events,
"headers" =>
Dict{String,Any}("x-amz-Client-Context" => x_amz_Client_Context),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 33777 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mq
using AWS.Compat
using AWS.UUIDs
"""
create_broker(auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users)
create_broker(auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users, params::Dict{String,<:Any})
Creates a broker. Note: This API is asynchronous. To create a broker, you must either use
the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM
policy. ec2:CreateNetworkInterface This permission is required to allow Amazon MQ to create
an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission This permission is required to attach the ENI to the
broker instance. ec2:DeleteNetworkInterface ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface ec2:DescribeInternetGateways ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions ec2:DescribeRouteTables ec2:DescribeSecurityGroups
ec2:DescribeSubnets ec2:DescribeVpcs For more information, see Create an IAM User and Get
Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic
Network Interface in the Amazon MQ Developer Guide.
# Arguments
- `auto_minor_version_upgrade`: Enables automatic upgrades to new minor versions for
brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur
during the scheduled maintenance window of the broker or after a manual broker reboot. Set
to true by default, if no value is specified.
- `broker_name`: Required. The broker's name. This value must be unique in your Amazon Web
Services account, 1-50 characters long, must contain only letters, numbers, dashes, and
underscores, and must not contain white spaces, brackets, wildcard characters, or special
characters. Do not add personally identifiable information (PII) or other confidential or
sensitive information in broker names. Broker names are accessible to other Amazon Web
Services services, including CloudWatch Logs. Broker names are not intended to be used for
private or sensitive data.
- `deployment_mode`: Required. The broker's deployment mode.
- `engine_type`: Required. The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQ and RABBITMQ.
- `engine_version`: Required. The broker engine's version. For a list of supported engine
versions, see Supported engines.
- `host_instance_type`: Required. The broker's instance type.
- `publicly_accessible`: Enables connections from applications outside of the VPC that
hosts the broker's subnets. Set to false by default, if no value is provided.
- `users`: The list of broker users (persons or applications) who can access queues and
topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is
accepted and created when a broker is first provisioned. All subsequent broker users are
created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authenticationStrategy"`: Optional. The authentication strategy used to secure the
broker. The default is SIMPLE.
- `"configuration"`: A list of information about the configuration.
- `"creatorRequestId"`: The unique ID that the requester receives for the created broker.
Amazon MQ passes your ID with the API action. We recommend using a Universally Unique
Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your
application doesn't require idempotency.
- `"dataReplicationMode"`: Defines whether this broker is a part of a data replication pair.
- `"dataReplicationPrimaryBrokerArn"`: The Amazon Resource Name (ARN) of the primary broker
that is used to replicate data from in a data replication pair, and is applied to the
replica broker. Must be set when dataReplicationMode is set to CRDR.
- `"encryptionOptions"`: Encryption options for the broker.
- `"ldapServerMetadata"`: Optional. The metadata of the LDAP server used to authenticate
and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- `"logs"`: Enables Amazon CloudWatch logging for brokers.
- `"maintenanceWindowStartTime"`: The parameters that determine the WeeklyStartTime.
- `"securityGroups"`: The list of rules (1 minimum, 125 maximum) that authorize connections
to brokers.
- `"storageType"`: The broker's storage type.
- `"subnetIds"`: The list of groups that define which subnets and IP ranges the broker can
use from different Availability Zones. If you specify more than one subnet, the subnets
must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints
for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE
deployment requires one subnet (for example, the default subnet). An
ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A
CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed
with public accessibility. Deployment without public accessibility requires at least one
subnet. If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to
which the specified subnets belong must be owned by your Amazon Web Services account.
Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your
Amazon Web Services account.
- `"tags"`: Create tags when creating the broker.
"""
function create_broker(
autoMinorVersionUpgrade,
brokerName,
deploymentMode,
engineType,
engineVersion,
hostInstanceType,
publiclyAccessible,
users;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/brokers",
Dict{String,Any}(
"autoMinorVersionUpgrade" => autoMinorVersionUpgrade,
"brokerName" => brokerName,
"deploymentMode" => deploymentMode,
"engineType" => engineType,
"engineVersion" => engineVersion,
"hostInstanceType" => hostInstanceType,
"publiclyAccessible" => publiclyAccessible,
"users" => users,
"creatorRequestId" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_broker(
autoMinorVersionUpgrade,
brokerName,
deploymentMode,
engineType,
engineVersion,
hostInstanceType,
publiclyAccessible,
users,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/brokers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"autoMinorVersionUpgrade" => autoMinorVersionUpgrade,
"brokerName" => brokerName,
"deploymentMode" => deploymentMode,
"engineType" => engineType,
"engineVersion" => engineVersion,
"hostInstanceType" => hostInstanceType,
"publiclyAccessible" => publiclyAccessible,
"users" => users,
"creatorRequestId" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration(engine_type, engine_version, name)
create_configuration(engine_type, engine_version, name, params::Dict{String,<:Any})
Creates a new configuration for the specified configuration name. Amazon MQ uses the
default configuration (the engine type and version).
# Arguments
- `engine_type`: Required. The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQ and RABBITMQ.
- `engine_version`: Required. The broker engine's version. For a list of supported engine
versions, see Supported engines.
- `name`: Required. The name of the configuration. This value can contain only alphanumeric
characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150
characters long.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authenticationStrategy"`: Optional. The authentication strategy associated with the
configuration. The default is SIMPLE.
- `"tags"`: Create tags when creating the configuration.
"""
function create_configuration(
engineType, engineVersion, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"POST",
"/v1/configurations",
Dict{String,Any}(
"engineType" => engineType, "engineVersion" => engineVersion, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration(
engineType,
engineVersion,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/configurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"engineType" => engineType,
"engineVersion" => engineVersion,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tags(resource-arn)
create_tags(resource-arn, params::Dict{String,<:Any})
Add a tag to a resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) of the resource tag.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The key-value pair for the resource tag.
"""
function create_tags(resource_arn; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"POST",
"/v1/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tags(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(broker-id, password, username)
create_user(broker-id, password, username, params::Dict{String,<:Any})
Creates an ActiveMQ user. Do not add personally identifiable information (PII) or other
confidential or sensitive information in broker usernames. Broker usernames are accessible
to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not
intended to be used for private or sensitive data.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
- `password`: Required. The password of the user. This value must be at least 12 characters
long, must contain at least 4 unique characters, and must not contain commas, colons, or
equal signs (,:=).
- `username`: The username of the ActiveMQ user. This value can contain only alphanumeric
characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100
characters long.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"consoleAccess"`: Enables access to the ActiveMQ Web Console for the ActiveMQ user.
- `"groups"`: The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (-
. _ ~). This value must be 2-100 characters long.
- `"replicationUser"`: Defines if this user is intended for CRDR replication purposes.
"""
function create_user(
broker_id, password, username; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"POST",
"/v1/brokers/$(broker-id)/users/$(username)",
Dict{String,Any}("password" => password);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
broker_id,
password,
username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/brokers/$(broker-id)/users/$(username)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("password" => password), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_broker(broker-id)
delete_broker(broker-id, params::Dict{String,<:Any})
Deletes a broker. Note: This API is asynchronous.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
"""
function delete_broker(broker_id; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"DELETE",
"/v1/brokers/$(broker-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_broker(
broker_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"DELETE",
"/v1/brokers/$(broker-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(resource-arn, tag_keys)
delete_tags(resource-arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from a resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) of the resource tag.
- `tag_keys`: An array of tag keys to delete
"""
function delete_tags(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"DELETE",
"/v1/tags/$(resource-arn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
resource_arn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"DELETE",
"/v1/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(broker-id, username)
delete_user(broker-id, username, params::Dict{String,<:Any})
Deletes an ActiveMQ user.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
- `username`: The username of the ActiveMQ user. This value can contain only alphanumeric
characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100
characters long.
"""
function delete_user(broker_id, username; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"DELETE",
"/v1/brokers/$(broker-id)/users/$(username)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
broker_id,
username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"DELETE",
"/v1/brokers/$(broker-id)/users/$(username)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_broker(broker-id)
describe_broker(broker-id, params::Dict{String,<:Any})
Returns information about the specified broker.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
"""
function describe_broker(broker_id; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"GET",
"/v1/brokers/$(broker-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_broker(
broker_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/brokers/$(broker-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_broker_engine_types()
describe_broker_engine_types(params::Dict{String,<:Any})
Describe available engine types and versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: Filter response by engine type.
- `"maxResults"`: The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
- `"nextToken"`: The token that specifies the next page of results Amazon MQ should return.
To request the first page, leave nextToken empty.
"""
function describe_broker_engine_types(; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"GET",
"/v1/broker-engine-types";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_broker_engine_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/broker-engine-types",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_broker_instance_options()
describe_broker_instance_options(params::Dict{String,<:Any})
Describe available broker instance options.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: Filter response by engine type.
- `"hostInstanceType"`: Filter response by host instance type.
- `"maxResults"`: The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
- `"nextToken"`: The token that specifies the next page of results Amazon MQ should return.
To request the first page, leave nextToken empty.
- `"storageType"`: Filter response by storage type.
"""
function describe_broker_instance_options(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/broker-instance-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_broker_instance_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/broker-instance-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration(configuration-id)
describe_configuration(configuration-id, params::Dict{String,<:Any})
Returns information about the specified configuration.
# Arguments
- `configuration-id`: The unique ID that Amazon MQ generates for the configuration.
"""
function describe_configuration(
configuration_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/configurations/$(configuration-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration(
configuration_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/configurations/$(configuration-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_revision(configuration-id, configuration-revision)
describe_configuration_revision(configuration-id, configuration-revision, params::Dict{String,<:Any})
Returns the specified configuration revision for the specified configuration.
# Arguments
- `configuration-id`: The unique ID that Amazon MQ generates for the configuration.
- `configuration-revision`: The revision of the configuration.
"""
function describe_configuration_revision(
configuration_id,
configuration_revision;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/configurations/$(configuration-id)/revisions/$(configuration-revision)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_revision(
configuration_id,
configuration_revision,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/configurations/$(configuration-id)/revisions/$(configuration-revision)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user(broker-id, username)
describe_user(broker-id, username, params::Dict{String,<:Any})
Returns information about an ActiveMQ user.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
- `username`: The username of the ActiveMQ user. This value can contain only alphanumeric
characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100
characters long.
"""
function describe_user(
broker_id, username; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/brokers/$(broker-id)/users/$(username)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user(
broker_id,
username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/brokers/$(broker-id)/users/$(username)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_brokers()
list_brokers(params::Dict{String,<:Any})
Returns a list of all brokers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
- `"nextToken"`: The token that specifies the next page of results Amazon MQ should return.
To request the first page, leave nextToken empty.
"""
function list_brokers(; aws_config::AbstractAWSConfig=global_aws_config())
return mq("GET", "/v1/brokers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_brokers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET", "/v1/brokers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_configuration_revisions(configuration-id)
list_configuration_revisions(configuration-id, params::Dict{String,<:Any})
Returns a list of all revisions for the specified configuration.
# Arguments
- `configuration-id`: The unique ID that Amazon MQ generates for the configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
- `"nextToken"`: The token that specifies the next page of results Amazon MQ should return.
To request the first page, leave nextToken empty.
"""
function list_configuration_revisions(
configuration_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/configurations/$(configuration-id)/revisions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_revisions(
configuration_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/configurations/$(configuration-id)/revisions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configurations()
list_configurations(params::Dict{String,<:Any})
Returns a list of all configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
- `"nextToken"`: The token that specifies the next page of results Amazon MQ should return.
To request the first page, leave nextToken empty.
"""
function list_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"GET", "/v1/configurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"GET",
"/v1/configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(resource-arn)
list_tags(resource-arn, params::Dict{String,<:Any})
Lists tags for a resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) of the resource tag.
"""
function list_tags(resource_arn; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"GET",
"/v1/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(broker-id)
list_users(broker-id, params::Dict{String,<:Any})
Returns a list of all ActiveMQ users.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
- `"nextToken"`: The token that specifies the next page of results Amazon MQ should return.
To request the first page, leave nextToken empty.
"""
function list_users(broker_id; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"GET",
"/v1/brokers/$(broker-id)/users";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
broker_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"GET",
"/v1/brokers/$(broker-id)/users",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
promote(broker-id, mode)
promote(broker-id, mode, params::Dict{String,<:Any})
Promotes a data replication replica broker to the primary broker role.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
- `mode`: The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER,
FAILOVER.
"""
function promote(broker_id, mode; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"POST",
"/v1/brokers/$(broker-id)/promote",
Dict{String,Any}("mode" => mode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function promote(
broker_id,
mode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/brokers/$(broker-id)/promote",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("mode" => mode), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_broker(broker-id)
reboot_broker(broker-id, params::Dict{String,<:Any})
Reboots a broker. Note: This API is asynchronous.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
"""
function reboot_broker(broker_id; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"POST",
"/v1/brokers/$(broker-id)/reboot";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_broker(
broker_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"POST",
"/v1/brokers/$(broker-id)/reboot",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_broker(broker-id)
update_broker(broker-id, params::Dict{String,<:Any})
Adds a pending configuration change to a broker.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authenticationStrategy"`: Optional. The authentication strategy used to secure the
broker. The default is SIMPLE.
- `"autoMinorVersionUpgrade"`: Enables automatic upgrades to new minor versions for
brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur
during the scheduled maintenance window of the broker or after a manual broker reboot.
- `"configuration"`: A list of information about the configuration.
- `"dataReplicationMode"`: Defines whether this broker is a part of a data replication pair.
- `"engineVersion"`: The broker engine version. For a list of supported engine versions,
see Supported engines.
- `"hostInstanceType"`: The broker's host instance type to upgrade to. For a list of
supported instance types, see Broker instance types.
- `"ldapServerMetadata"`: Optional. The metadata of the LDAP server used to authenticate
and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- `"logs"`: Enables Amazon CloudWatch logging for brokers.
- `"maintenanceWindowStartTime"`: The parameters that determine the WeeklyStartTime.
- `"securityGroups"`: The list of security groups (1 minimum, 5 maximum) that authorizes
connections to brokers.
"""
function update_broker(broker_id; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"PUT",
"/v1/brokers/$(broker-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_broker(
broker_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"PUT",
"/v1/brokers/$(broker-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration(configuration-id, data)
update_configuration(configuration-id, data, params::Dict{String,<:Any})
Updates the specified configuration.
# Arguments
- `configuration-id`: The unique ID that Amazon MQ generates for the configuration.
- `data`: Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for
RabbitMQ: the base64-encoded Cuttlefish configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the configuration.
"""
function update_configuration(
configuration_id, data; aws_config::AbstractAWSConfig=global_aws_config()
)
return mq(
"PUT",
"/v1/configurations/$(configuration-id)",
Dict{String,Any}("data" => data);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration(
configuration_id,
data,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"PUT",
"/v1/configurations/$(configuration-id)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("data" => data), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(broker-id, username)
update_user(broker-id, username, params::Dict{String,<:Any})
Updates the information for an ActiveMQ user.
# Arguments
- `broker-id`: The unique ID that Amazon MQ generates for the broker.
- `username`: The username of the ActiveMQ user. This value can contain only alphanumeric
characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100
characters long.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"consoleAccess"`: Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
- `"groups"`: The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (-
. _ ~). This value must be 2-100 characters long.
- `"password"`: The password of the user. This value must be at least 12 characters long,
must contain at least 4 unique characters, and must not contain commas, colons, or equal
signs (,:=).
- `"replicationUser"`: Defines whether the user is intended for data replication.
"""
function update_user(broker_id, username; aws_config::AbstractAWSConfig=global_aws_config())
return mq(
"PUT",
"/v1/brokers/$(broker-id)/users/$(username)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
broker_id,
username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mq(
"PUT",
"/v1/brokers/$(broker-id)/users/$(username)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 80135 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mturk
using AWS.Compat
using AWS.UUIDs
"""
accept_qualification_request(qualification_request_id)
accept_qualification_request(qualification_request_id, params::Dict{String,<:Any})
The AcceptQualificationRequest operation approves a Worker's request for a Qualification.
Only the owner of the Qualification type can grant a Qualification request for that type.
A successful request for the AcceptQualificationRequest operation returns with no errors
and an empty body.
# Arguments
- `qualification_request_id`: The ID of the Qualification request, as returned by the
GetQualificationRequests operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IntegerValue"`: The value of the Qualification. You can omit this value if you are
using the presence or absence of the Qualification as the basis for a HIT requirement.
"""
function accept_qualification_request(
QualificationRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"AcceptQualificationRequest",
Dict{String,Any}("QualificationRequestId" => QualificationRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_qualification_request(
QualificationRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"AcceptQualificationRequest",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationRequestId" => QualificationRequestId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
approve_assignment(assignment_id)
approve_assignment(assignment_id, params::Dict{String,<:Any})
The ApproveAssignment operation approves the results of a completed assignment.
Approving an assignment initiates two payments from the Requester's Amazon.com account
The Worker who submitted the results is paid the reward specified in the HIT. Amazon
Mechanical Turk fees are debited. If the Requester's account does not have adequate
funds for these payments, the call to ApproveAssignment returns an exception, and the
approval is not processed. You can include an optional feedback message with the approval,
which the Worker can see in the Status section of the web site. You can also call this
operation for assignments that were previous rejected and approve them by explicitly
overriding the previous rejection. This only works on rejected assignments that were
submitted within the previous 30 days and only if the assignment's related HIT has not been
deleted.
# Arguments
- `assignment_id`: The ID of the assignment. The assignment must correspond to a HIT
created by the Requester.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OverrideRejection"`: A flag indicating that an assignment should be approved even if
it was previously rejected. Defaults to False.
- `"RequesterFeedback"`: A message for the Worker, which the Worker can see in the Status
section of the web site.
"""
function approve_assignment(AssignmentId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"ApproveAssignment",
Dict{String,Any}("AssignmentId" => AssignmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function approve_assignment(
AssignmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"ApproveAssignment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssignmentId" => AssignmentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_qualification_with_worker(qualification_type_id, worker_id)
associate_qualification_with_worker(qualification_type_id, worker_id, params::Dict{String,<:Any})
The AssociateQualificationWithWorker operation gives a Worker a Qualification.
AssociateQualificationWithWorker does not require that the Worker submit a Qualification
request. It gives the Qualification directly to the Worker. You can only assign a
Qualification of a Qualification type that you created (using the CreateQualificationType
operation). Note: AssociateQualificationWithWorker does not affect any pending
Qualification requests for the Qualification by the Worker. If you assign a Qualification
to a Worker, then later grant a Qualification request made by the Worker, the granting of
the request may modify the Qualification score. To resolve a pending Qualification request
without affecting the Qualification the Worker already has, reject the request with the
RejectQualificationRequest operation.
# Arguments
- `qualification_type_id`: The ID of the Qualification type to use for the assigned
Qualification.
- `worker_id`: The ID of the Worker to whom the Qualification is being assigned. Worker
IDs are included with submitted HIT assignments and Qualification requests.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IntegerValue"`: The value of the Qualification to assign.
- `"SendNotification"`: Specifies whether to send a notification email message to the
Worker saying that the qualification was assigned to the Worker. Note: this is true by
default.
"""
function associate_qualification_with_worker(
QualificationTypeId, WorkerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"AssociateQualificationWithWorker",
Dict{String,Any}(
"QualificationTypeId" => QualificationTypeId, "WorkerId" => WorkerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_qualification_with_worker(
QualificationTypeId,
WorkerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"AssociateQualificationWithWorker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QualificationTypeId" => QualificationTypeId, "WorkerId" => WorkerId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_additional_assignments_for_hit(hitid, number_of_additional_assignments)
create_additional_assignments_for_hit(hitid, number_of_additional_assignments, params::Dict{String,<:Any})
The CreateAdditionalAssignmentsForHIT operation increases the maximum number of
assignments of an existing HIT. To extend the maximum number of assignments, specify the
number of additional assignments. HITs created with fewer than 10 assignments cannot be
extended to have 10 or more assignments. Attempting to add assignments in a way that brings
the total number of assignments for a HIT from fewer than 10 assignments to 10 or more
assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease
exception. HITs that were created before July 22, 2015 cannot be extended. Attempting to
extend HITs that were created before July 22, 2015 will result in an
AWS.MechanicalTurk.HITTooOldForExtension exception.
# Arguments
- `hitid`: The ID of the HIT to extend.
- `number_of_additional_assignments`: The number of additional assignments to request for
this HIT.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UniqueRequestToken"`: A unique identifier for this request, which allows you to retry
the call on error without extending the HIT multiple times. This is useful in cases such as
network timeouts where it is unclear whether or not the call succeeded on the server. If
the extend HIT already exists in the system from a previous call using the same
UniqueRequestToken, subsequent calls will return an error with a message containing the
request ID.
"""
function create_additional_assignments_for_hit(
HITId, NumberOfAdditionalAssignments; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"CreateAdditionalAssignmentsForHIT",
Dict{String,Any}(
"HITId" => HITId,
"NumberOfAdditionalAssignments" => NumberOfAdditionalAssignments,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_additional_assignments_for_hit(
HITId,
NumberOfAdditionalAssignments,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateAdditionalAssignmentsForHIT",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HITId" => HITId,
"NumberOfAdditionalAssignments" => NumberOfAdditionalAssignments,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hit(assignment_duration_in_seconds, description, lifetime_in_seconds, reward, title)
create_hit(assignment_duration_in_seconds, description, lifetime_in_seconds, reward, title, params::Dict{String,<:Any})
The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made
available for Workers to find and accept on the Amazon Mechanical Turk website. This
operation allows you to specify a new HIT by passing in values for the properties of the
HIT, such as its title, reward amount and number of assignments. When you pass these values
to CreateHIT, a new HIT is created for you, with a new HITTypeID. The HITTypeID can be used
to create additional HITs in the future without needing to specify common parameters such
as the title, description and reward amount each time. An alternative way to create HITs
is to first generate a HITTypeID using the CreateHITType operation and then call the
CreateHITWithHITType operation. This is the recommended best practice for Requesters who
are creating large numbers of HITs. CreateHIT also supports several ways to provide
question data: by providing a value for the Question parameter that fully specifies the
contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For
more information, see Amazon Mechanical Turk Pricing.
# Arguments
- `assignment_duration_in_seconds`: The amount of time, in seconds, that a Worker has to
complete the HIT after accepting it. If a Worker does not complete the assignment within
the specified duration, the assignment is considered abandoned. If the HIT is still active
(that is, its lifetime has not elapsed), the assignment becomes available for other users
to find and accept.
- `description`: A general description of the HIT. A description includes detailed
information about the kind of task the HIT contains. On the Amazon Mechanical Turk web
site, the HIT description appears in the expanded view of search results, and in the HIT
and assignment screens. A good description gives the user enough information to evaluate
the HIT before accepting it.
- `lifetime_in_seconds`: An amount of time, in seconds, after which the HIT is no longer
available for users to accept. After the lifetime of the HIT elapses, the HIT no longer
appears in HIT searches, even if not all of the assignments for the HIT have been accepted.
- `reward`: The amount of money the Requester will pay a Worker for successfully
completing the HIT.
- `title`: The title of the HIT. A title should be short and descriptive about the kind of
task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in
search results, and everywhere the HIT is mentioned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignmentReviewPolicy"`: The Assignment-level Review Policy applies to the
assignments under the HIT. You can specify for Mechanical Turk to take various actions
based on the policy.
- `"AutoApprovalDelayInSeconds"`: The number of seconds after an assignment for the HIT
has been submitted, after which the assignment is considered Approved automatically unless
the Requester explicitly rejects it.
- `"HITLayoutId"`: The HITLayoutId allows you to use a pre-existing HIT design with
placeholder values and create an additional HIT by providing those values as
HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter
must be provided.
- `"HITLayoutParameters"`: If the HITLayoutId is provided, any placeholder values must be
filled in with values using the HITLayoutParameter structure. For more information, see
HITLayout.
- `"HITReviewPolicy"`: The HIT-level Review Policy applies to the HIT. You can specify for
Mechanical Turk to take various actions based on the policy.
- `"Keywords"`: One or more words or phrases that describe the HIT, separated by commas.
These words are used in searches to find HITs.
- `"MaxAssignments"`: The number of times the HIT can be accepted and completed before the
HIT becomes unavailable.
- `"QualificationRequirements"`: Conditions that a Worker's Qualifications must meet in
order to accept the HIT. A HIT can have between zero and ten Qualification requirements.
All requirements must be met in order for a Worker to accept the HIT. Additionally, other
actions can be restricted using the ActionsGuarded field on each QualificationRequirement
structure.
- `"Question"`: The data the person completing the HIT uses to produce the results.
Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or
an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes
(65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId
parameter must be provided.
- `"RequesterAnnotation"`: An arbitrary data field. The RequesterAnnotation parameter lets
your application attach arbitrary data to the HIT for tracking purposes. For example, this
parameter could be an identifier internal to the Requester's application that corresponds
with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the
Requester who created the HIT. It is not shown to the Worker, or any other Requester. The
RequesterAnnotation parameter may be different for each HIT you submit. It does not affect
how your HITs are grouped.
- `"UniqueRequestToken"`: A unique identifier for this request which allows you to retry
the call on error without creating duplicate HITs. This is useful in cases such as network
timeouts where it is unclear whether or not the call succeeded on the server. If the HIT
already exists in the system from a previous call using the same UniqueRequestToken,
subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message
containing the HITId. Note: It is your responsibility to ensure uniqueness of the token.
The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken
made after the 24 hour limit could create duplicate HITs.
"""
function create_hit(
AssignmentDurationInSeconds,
Description,
LifetimeInSeconds,
Reward,
Title;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateHIT",
Dict{String,Any}(
"AssignmentDurationInSeconds" => AssignmentDurationInSeconds,
"Description" => Description,
"LifetimeInSeconds" => LifetimeInSeconds,
"Reward" => Reward,
"Title" => Title,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hit(
AssignmentDurationInSeconds,
Description,
LifetimeInSeconds,
Reward,
Title,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateHIT",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssignmentDurationInSeconds" => AssignmentDurationInSeconds,
"Description" => Description,
"LifetimeInSeconds" => LifetimeInSeconds,
"Reward" => Reward,
"Title" => Title,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hittype(assignment_duration_in_seconds, description, reward, title)
create_hittype(assignment_duration_in_seconds, description, reward, title, params::Dict{String,<:Any})
The CreateHITType operation creates a new HIT type. This operation allows you to define a
standard set of HIT properties to use when creating HITs. If you register a HIT type with
values that match an existing HIT type, the HIT type ID of the existing type will be
returned.
# Arguments
- `assignment_duration_in_seconds`: The amount of time, in seconds, that a Worker has to
complete the HIT after accepting it. If a Worker does not complete the assignment within
the specified duration, the assignment is considered abandoned. If the HIT is still active
(that is, its lifetime has not elapsed), the assignment becomes available for other users
to find and accept.
- `description`: A general description of the HIT. A description includes detailed
information about the kind of task the HIT contains. On the Amazon Mechanical Turk web
site, the HIT description appears in the expanded view of search results, and in the HIT
and assignment screens. A good description gives the user enough information to evaluate
the HIT before accepting it.
- `reward`: The amount of money the Requester will pay a Worker for successfully
completing the HIT.
- `title`: The title of the HIT. A title should be short and descriptive about the kind of
task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in
search results, and everywhere the HIT is mentioned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoApprovalDelayInSeconds"`: The number of seconds after an assignment for the HIT
has been submitted, after which the assignment is considered Approved automatically unless
the Requester explicitly rejects it.
- `"Keywords"`: One or more words or phrases that describe the HIT, separated by commas.
These words are used in searches to find HITs.
- `"QualificationRequirements"`: Conditions that a Worker's Qualifications must meet in
order to accept the HIT. A HIT can have between zero and ten Qualification requirements.
All requirements must be met in order for a Worker to accept the HIT. Additionally, other
actions can be restricted using the ActionsGuarded field on each QualificationRequirement
structure.
"""
function create_hittype(
AssignmentDurationInSeconds,
Description,
Reward,
Title;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateHITType",
Dict{String,Any}(
"AssignmentDurationInSeconds" => AssignmentDurationInSeconds,
"Description" => Description,
"Reward" => Reward,
"Title" => Title,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hittype(
AssignmentDurationInSeconds,
Description,
Reward,
Title,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateHITType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssignmentDurationInSeconds" => AssignmentDurationInSeconds,
"Description" => Description,
"Reward" => Reward,
"Title" => Title,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hitwith_hittype(hittype_id, lifetime_in_seconds)
create_hitwith_hittype(hittype_id, lifetime_in_seconds, params::Dict{String,<:Any})
The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an
existing HITTypeID generated by the CreateHITType operation. This is an alternative way
to create HITs from the CreateHIT operation. This is the recommended best practice for
Requesters who are creating large numbers of HITs. CreateHITWithHITType also supports
several ways to provide question data: by providing a value for the Question parameter that
fully specifies the contents of the HIT, or by providing a HitLayoutId and associated
HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is
an additional fee. For more information, see Amazon Mechanical Turk Pricing.
# Arguments
- `hittype_id`: The HIT type ID you want to create this HIT with.
- `lifetime_in_seconds`: An amount of time, in seconds, after which the HIT is no longer
available for users to accept. After the lifetime of the HIT elapses, the HIT no longer
appears in HIT searches, even if not all of the assignments for the HIT have been accepted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignmentReviewPolicy"`: The Assignment-level Review Policy applies to the
assignments under the HIT. You can specify for Mechanical Turk to take various actions
based on the policy.
- `"HITLayoutId"`: The HITLayoutId allows you to use a pre-existing HIT design with
placeholder values and create an additional HIT by providing those values as
HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter
must be provided.
- `"HITLayoutParameters"`: If the HITLayoutId is provided, any placeholder values must be
filled in with values using the HITLayoutParameter structure. For more information, see
HITLayout.
- `"HITReviewPolicy"`: The HIT-level Review Policy applies to the HIT. You can specify for
Mechanical Turk to take various actions based on the policy.
- `"MaxAssignments"`: The number of times the HIT can be accepted and completed before the
HIT becomes unavailable.
- `"Question"`: The data the person completing the HIT uses to produce the results.
Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or
an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes
(65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId
parameter must be provided.
- `"RequesterAnnotation"`: An arbitrary data field. The RequesterAnnotation parameter lets
your application attach arbitrary data to the HIT for tracking purposes. For example, this
parameter could be an identifier internal to the Requester's application that corresponds
with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the
Requester who created the HIT. It is not shown to the Worker, or any other Requester. The
RequesterAnnotation parameter may be different for each HIT you submit. It does not affect
how your HITs are grouped.
- `"UniqueRequestToken"`: A unique identifier for this request which allows you to retry
the call on error without creating duplicate HITs. This is useful in cases such as network
timeouts where it is unclear whether or not the call succeeded on the server. If the HIT
already exists in the system from a previous call using the same UniqueRequestToken,
subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message
containing the HITId. Note: It is your responsibility to ensure uniqueness of the token.
The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken
made after the 24 hour limit could create duplicate HITs.
"""
function create_hitwith_hittype(
HITTypeId, LifetimeInSeconds; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"CreateHITWithHITType",
Dict{String,Any}(
"HITTypeId" => HITTypeId, "LifetimeInSeconds" => LifetimeInSeconds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hitwith_hittype(
HITTypeId,
LifetimeInSeconds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateHITWithHITType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HITTypeId" => HITTypeId, "LifetimeInSeconds" => LifetimeInSeconds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_qualification_type(description, name, qualification_type_status)
create_qualification_type(description, name, qualification_type_status, params::Dict{String,<:Any})
The CreateQualificationType operation creates a new Qualification type, which is
represented by a QualificationType data structure.
# Arguments
- `description`: A long description for the Qualification type. On the Amazon Mechanical
Turk website, the long description is displayed when a Worker examines a Qualification type.
- `name`: The name you give to the Qualification type. The type name is used to represent
the Qualification to Workers, and to find the type using a Qualification type search. It
must be unique across all of your Qualification types.
- `qualification_type_status`: The initial status of the Qualification type. Constraints:
Valid values are: Active | Inactive
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnswerKey"`: The answers to the Qualification test specified in the Test parameter, in
the form of an AnswerKey data structure. Constraints: Must not be longer than 65535 bytes.
Constraints: None. If not specified, you must process Qualification requests manually.
- `"AutoGranted"`: Specifies whether requests for the Qualification type are granted
immediately, without prompting the Worker with a Qualification test. Constraints: If the
Test parameter is specified, this parameter cannot be true.
- `"AutoGrantedValue"`: The Qualification value to use for automatically granted
Qualifications. This parameter is used only if the AutoGranted parameter is true.
- `"Keywords"`: One or more words or phrases that describe the Qualification type,
separated by commas. The keywords of a type make the type easier to find during a search.
- `"RetryDelayInSeconds"`: The number of seconds that a Worker must wait after requesting a
Qualification of the Qualification type before the worker can retry the Qualification
request. Constraints: None. If not specified, retries are disabled and Workers can request
a Qualification of this type only once, even if the Worker has not been granted the
Qualification. It is not possible to disable retries for a Qualification type after it has
been created with retries enabled. If you want to disable retries, you must delete existing
retry-enabled Qualification type and then create a new Qualification type with retries
disabled.
- `"Test"`: The questions for the Qualification test a Worker must answer correctly to
obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds
must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a
QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.
Constraints: None. If not specified, the Worker may request the Qualification without
answering any questions.
- `"TestDurationInSeconds"`: The number of seconds the Worker has to complete the
Qualification test, starting from the time the Worker requests the Qualification.
"""
function create_qualification_type(
Description,
Name,
QualificationTypeStatus;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateQualificationType",
Dict{String,Any}(
"Description" => Description,
"Name" => Name,
"QualificationTypeStatus" => QualificationTypeStatus,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_qualification_type(
Description,
Name,
QualificationTypeStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateQualificationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description,
"Name" => Name,
"QualificationTypeStatus" => QualificationTypeStatus,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_worker_block(reason, worker_id)
create_worker_block(reason, worker_id, params::Dict{String,<:Any})
The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs.
For example, you can block a Worker who is producing poor quality work. You can block up to
100,000 Workers.
# Arguments
- `reason`: A message explaining the reason for blocking the Worker. This parameter enables
you to keep track of your Workers. The Worker does not see this message.
- `worker_id`: The ID of the Worker to block.
"""
function create_worker_block(
Reason, WorkerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"CreateWorkerBlock",
Dict{String,Any}("Reason" => Reason, "WorkerId" => WorkerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_worker_block(
Reason,
WorkerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"CreateWorkerBlock",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Reason" => Reason, "WorkerId" => WorkerId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hit(hitid)
delete_hit(hitid, params::Dict{String,<:Any})
The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester
who created the HIT can delete it. You can only dispose of HITs that are in the
Reviewable state, with all of their submitted assignments already either approved or
rejected. If you call the DeleteHIT operation on a HIT that is not in the Reviewable state
(for example, that has not expired, or still has active assignments), or on a HIT that is
Reviewable but without all of its submitted assignments already approved or rejected, the
service will return an error. HITs are automatically disposed of after 120 days.
After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
Disposed HITs are not returned in results for the ListHITs operation. Disposing HITs
can improve the performance of operations such as ListReviewableHITs and ListHITs.
# Arguments
- `hitid`: The ID of the HIT to be deleted.
"""
function delete_hit(HITId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"DeleteHIT",
Dict{String,Any}("HITId" => HITId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hit(
HITId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"DeleteHIT",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HITId" => HITId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_qualification_type(qualification_type_id)
delete_qualification_type(qualification_type_id, params::Dict{String,<:Any})
The DeleteQualificationType deletes a Qualification type and deletes any HIT types that
are associated with the Qualification type. This operation does not revoke Qualifications
already assigned to Workers because the Qualifications might be needed for active HITs. If
there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects
those requests. After you delete a Qualification type, you can no longer use it to create
HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted
Qualification type to be deleted before completing. It may take up to 48 hours before
DeleteQualificationType completes and the unique name of the Qualification type is
available for reuse with CreateQualificationType.
# Arguments
- `qualification_type_id`: The ID of the QualificationType to dispose.
"""
function delete_qualification_type(
QualificationTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"DeleteQualificationType",
Dict{String,Any}("QualificationTypeId" => QualificationTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_qualification_type(
QualificationTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"DeleteQualificationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationTypeId" => QualificationTypeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_worker_block(worker_id)
delete_worker_block(worker_id, params::Dict{String,<:Any})
The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your
HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the
Worker ID to use this operation. If the Worker ID is missing or invalid, this operation
fails and returns the message “WorkerId is invalid.” If the specified Worker is not
blocked, this operation returns successfully.
# Arguments
- `worker_id`: The ID of the Worker to unblock.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Reason"`: A message that explains the reason for unblocking the Worker. The Worker does
not see this message.
"""
function delete_worker_block(WorkerId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"DeleteWorkerBlock",
Dict{String,Any}("WorkerId" => WorkerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_worker_block(
WorkerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"DeleteWorkerBlock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkerId" => WorkerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_qualification_from_worker(qualification_type_id, worker_id)
disassociate_qualification_from_worker(qualification_type_id, worker_id, params::Dict{String,<:Any})
The DisassociateQualificationFromWorker revokes a previously granted Qualification from a
user. You can provide a text message explaining why the Qualification was revoked. The
user who had the Qualification can see this message.
# Arguments
- `qualification_type_id`: The ID of the Qualification type of the Qualification to be
revoked.
- `worker_id`: The ID of the Worker who possesses the Qualification to be revoked.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Reason"`: A text message that explains why the Qualification was revoked. The user who
had the Qualification sees this message.
"""
function disassociate_qualification_from_worker(
QualificationTypeId, WorkerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"DisassociateQualificationFromWorker",
Dict{String,Any}(
"QualificationTypeId" => QualificationTypeId, "WorkerId" => WorkerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_qualification_from_worker(
QualificationTypeId,
WorkerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"DisassociateQualificationFromWorker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QualificationTypeId" => QualificationTypeId, "WorkerId" => WorkerId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_balance()
get_account_balance(params::Dict{String,<:Any})
The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon
Mechanical Turk account if you are a Prepaid Requester. Alternatively, this operation will
retrieve the remaining available AWS Billing usage if you have enabled AWS Billing. Note:
If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this
balance can be viewed on the My Account page in the Requester console.
"""
function get_account_balance(; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"GetAccountBalance"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account_balance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"GetAccountBalance", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_assignment(assignment_id)
get_assignment(assignment_id, params::Dict{String,<:Any})
The GetAssignment operation retrieves the details of the specified Assignment.
# Arguments
- `assignment_id`: The ID of the Assignment to be retrieved.
"""
function get_assignment(AssignmentId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"GetAssignment",
Dict{String,Any}("AssignmentId" => AssignmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assignment(
AssignmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"GetAssignment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssignmentId" => AssignmentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_file_upload_url(assignment_id, question_identifier)
get_file_upload_url(assignment_id, question_identifier, params::Dict{String,<:Any})
The GetFileUploadURL operation generates and returns a temporary URL. You use the
temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer
question for a HIT. The temporary URL is generated the instant the GetFileUploadURL
operation is called, and is valid for 60 seconds. You can get a temporary file upload URL
any time until the HIT is disposed. After the HIT is disposed, any uploaded files are
deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer
Specification structure will no longer support the FileUploadAnswer element to be used for
the QuestionForm data structure. Instead, we recommend that Requesters who want to create
HITs asking Workers to upload files to use Amazon S3.
# Arguments
- `assignment_id`: The ID of the assignment that contains the question with a
FileUploadAnswer.
- `question_identifier`: The identifier of the question with a FileUploadAnswer, as
specified in the QuestionForm of the HIT.
"""
function get_file_upload_url(
AssignmentId, QuestionIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"GetFileUploadURL",
Dict{String,Any}(
"AssignmentId" => AssignmentId, "QuestionIdentifier" => QuestionIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_file_upload_url(
AssignmentId,
QuestionIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"GetFileUploadURL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssignmentId" => AssignmentId,
"QuestionIdentifier" => QuestionIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_hit(hitid)
get_hit(hitid, params::Dict{String,<:Any})
The GetHIT operation retrieves the details of the specified HIT.
# Arguments
- `hitid`: The ID of the HIT to be retrieved.
"""
function get_hit(HITId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"GetHIT",
Dict{String,Any}("HITId" => HITId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_hit(
HITId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"GetHIT",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HITId" => HITId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_qualification_score(qualification_type_id, worker_id)
get_qualification_score(qualification_type_id, worker_id, params::Dict{String,<:Any})
The GetQualificationScore operation returns the value of a Worker's Qualification for a
given Qualification type. To get a Worker's Qualification, you must know the Worker's ID.
The Worker's ID is included in the assignment data returned by the ListAssignmentsForHIT
operation. Only the owner of a Qualification type can query the value of a Worker's
Qualification of that type.
# Arguments
- `qualification_type_id`: The ID of the QualificationType.
- `worker_id`: The ID of the Worker whose Qualification is being updated.
"""
function get_qualification_score(
QualificationTypeId, WorkerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"GetQualificationScore",
Dict{String,Any}(
"QualificationTypeId" => QualificationTypeId, "WorkerId" => WorkerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_qualification_score(
QualificationTypeId,
WorkerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"GetQualificationScore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QualificationTypeId" => QualificationTypeId, "WorkerId" => WorkerId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_qualification_type(qualification_type_id)
get_qualification_type(qualification_type_id, params::Dict{String,<:Any})
The GetQualificationTypeoperation retrieves information about a Qualification type using
its ID.
# Arguments
- `qualification_type_id`: The ID of the QualificationType.
"""
function get_qualification_type(
QualificationTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"GetQualificationType",
Dict{String,Any}("QualificationTypeId" => QualificationTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_qualification_type(
QualificationTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"GetQualificationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationTypeId" => QualificationTypeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assignments_for_hit(hitid)
list_assignments_for_hit(hitid, params::Dict{String,<:Any})
The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use
this operation to retrieve the results for a HIT. You can get assignments for a HIT at
any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments,
and has received some results but has not yet become Reviewable, you can still retrieve the
partial results with this operation. Use the AssignmentStatus parameter to control which
set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return
submitted assignments awaiting approval, or it can return assignments that have already
been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get
assignments that have already been approved and rejected together in one result set. Only
the Requester who created the HIT can retrieve the assignments for that HIT. Results are
sorted and divided into numbered pages and the operation returns a single page of results.
You can use the parameters of the operation to control sorting and pagination.
# Arguments
- `hitid`: The ID of the HIT.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignmentStatuses"`: The status of the assignments to return: Submitted | Approved |
Rejected
- `"MaxResults"`:
- `"NextToken"`: Pagination token
"""
function list_assignments_for_hit(HITId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"ListAssignmentsForHIT",
Dict{String,Any}("HITId" => HITId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_assignments_for_hit(
HITId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListAssignmentsForHIT",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HITId" => HITId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bonus_payments()
list_bonus_payments(params::Dict{String,<:Any})
The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers
for a given HIT or assignment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignmentId"`: The ID of the assignment associated with the bonus payments to
retrieve. If specified, only bonus payments for the given assignment are returned. Either
the HITId parameter or the AssignmentId parameter must be specified
- `"HITId"`: The ID of the HIT associated with the bonus payments to retrieve. If not
specified, all bonus payments for all assignments for the given HIT are returned. Either
the HITId parameter or the AssignmentId parameter must be specified
- `"MaxResults"`:
- `"NextToken"`: Pagination token
"""
function list_bonus_payments(; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"ListBonusPayments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_bonus_payments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListBonusPayments", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_hits()
list_hits(params::Dict{String,<:Any})
The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of
any status, except for HITs that have been deleted of with the DeleteHIT operation or that
have been auto-deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`: Pagination token
"""
function list_hits(; aws_config::AbstractAWSConfig=global_aws_config())
return mturk("ListHITs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_hits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk("ListHITs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_hits_for_qualification_type(qualification_type_id)
list_hits_for_qualification_type(qualification_type_id, params::Dict{String,<:Any})
The ListHITsForQualificationType operation returns the HITs that use the given
Qualification type for a Qualification requirement. The operation returns HITs of any
status, except for HITs that have been deleted with the DeleteHIT operation or that have
been auto-deleted.
# Arguments
- `qualification_type_id`: The ID of the Qualification type to use when querying HITs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Limit the number of results returned.
- `"NextToken"`: Pagination Token
"""
function list_hits_for_qualification_type(
QualificationTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListHITsForQualificationType",
Dict{String,Any}("QualificationTypeId" => QualificationTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hits_for_qualification_type(
QualificationTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"ListHITsForQualificationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationTypeId" => QualificationTypeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_qualification_requests()
list_qualification_requests(params::Dict{String,<:Any})
The ListQualificationRequests operation retrieves requests for Qualifications of a
particular Qualification type. The owner of the Qualification type calls this operation to
poll for pending requests, and accepts them using the AcceptQualification operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return in a single call.
- `"NextToken"`:
- `"QualificationTypeId"`: The ID of the QualificationType.
"""
function list_qualification_requests(; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"ListQualificationRequests"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_qualification_requests(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListQualificationRequests",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_qualification_types(must_be_requestable)
list_qualification_types(must_be_requestable, params::Dict{String,<:Any})
The ListQualificationTypes operation returns a list of Qualification types, filtered by an
optional search term.
# Arguments
- `must_be_requestable`: Specifies that only Qualification types that a user can request
through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are
returned as results of the search. Some Qualification types, such as those assigned
automatically by the system, cannot be requested directly by users. If false, all
Qualification types, including those managed by the system, are considered. Valid values
are True | False.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return in a single call.
- `"MustBeOwnedByCaller"`: Specifies that only Qualification types that the Requester
created are returned. If false, the operation returns all Qualification types.
- `"NextToken"`:
- `"Query"`: A text query against all of the searchable attributes of Qualification types.
"""
function list_qualification_types(
MustBeRequestable; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListQualificationTypes",
Dict{String,Any}("MustBeRequestable" => MustBeRequestable);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_qualification_types(
MustBeRequestable,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"ListQualificationTypes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MustBeRequestable" => MustBeRequestable), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_review_policy_results_for_hit(hitid)
list_review_policy_results_for_hit(hitid, params::Dict{String,<:Any})
The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions
taken in the course of executing your Review Policies for a given HIT. For information
about how to specify Review Policies when you call CreateHIT, see Review Policies. The
ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and
HIT-level review results.
# Arguments
- `hitid`: The unique identifier of the HIT to retrieve review results for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Limit the number of results returned.
- `"NextToken"`: Pagination token
- `"PolicyLevels"`: The Policy Level(s) to retrieve review results for - HIT or
Assignment. If omitted, the default behavior is to retrieve all data for both policy
levels. For a list of all the described policies, see Review Policies.
- `"RetrieveActions"`: Specify if the operation should retrieve a list of the actions
taken executing the Review Policies and their outcomes.
- `"RetrieveResults"`: Specify if the operation should retrieve a list of the results
computed by the Review Policies.
"""
function list_review_policy_results_for_hit(
HITId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListReviewPolicyResultsForHIT",
Dict{String,Any}("HITId" => HITId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_review_policy_results_for_hit(
HITId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListReviewPolicyResultsForHIT",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HITId" => HITId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_reviewable_hits()
list_reviewable_hits(params::Dict{String,<:Any})
The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or
Status equal to Reviewing that belong to the Requester calling the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HITTypeId"`: The ID of the HIT type of the HITs to consider for the query. If not
specified, all HITs for the Reviewer are considered
- `"MaxResults"`: Limit the number of results returned.
- `"NextToken"`: Pagination Token
- `"Status"`: Can be either Reviewable or Reviewing. Reviewable is the default value.
"""
function list_reviewable_hits(; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"ListReviewableHITs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_reviewable_hits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListReviewableHITs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_worker_blocks()
list_worker_blocks(params::Dict{String,<:Any})
The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on
your HITs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`: Pagination token
"""
function list_worker_blocks(; aws_config::AbstractAWSConfig=global_aws_config())
return mturk("ListWorkerBlocks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_worker_blocks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListWorkerBlocks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_workers_with_qualification_type(qualification_type_id)
list_workers_with_qualification_type(qualification_type_id, params::Dict{String,<:Any})
The ListWorkersWithQualificationType operation returns all of the Workers that have been
associated with a given Qualification type.
# Arguments
- `qualification_type_id`: The ID of the Qualification type of the Qualifications to return.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Limit the number of results returned.
- `"NextToken"`: Pagination Token
- `"Status"`: The status of the Qualifications to return. Can be Granted | Revoked.
"""
function list_workers_with_qualification_type(
QualificationTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"ListWorkersWithQualificationType",
Dict{String,Any}("QualificationTypeId" => QualificationTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workers_with_qualification_type(
QualificationTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"ListWorkersWithQualificationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationTypeId" => QualificationTypeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_workers(message_text, subject, worker_ids)
notify_workers(message_text, subject, worker_ids, params::Dict{String,<:Any})
The NotifyWorkers operation sends an email to one or more Workers that you specify with
the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single
call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification
email to a Worker only if you have previously approved or rejected work from the Worker.
# Arguments
- `message_text`: The text of the email message to send. Can include up to 4,096 characters
- `subject`: The subject line of the email message to send. Can include up to 200
characters.
- `worker_ids`: A list of Worker IDs you wish to notify. You can notify upto 100 Workers at
a time.
"""
function notify_workers(
MessageText, Subject, WorkerIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"NotifyWorkers",
Dict{String,Any}(
"MessageText" => MessageText, "Subject" => Subject, "WorkerIds" => WorkerIds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_workers(
MessageText,
Subject,
WorkerIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"NotifyWorkers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MessageText" => MessageText,
"Subject" => Subject,
"WorkerIds" => WorkerIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_assignment(assignment_id, requester_feedback)
reject_assignment(assignment_id, requester_feedback, params::Dict{String,<:Any})
The RejectAssignment operation rejects the results of a completed assignment. You can
include an optional feedback message with the rejection, which the Worker can see in the
Status section of the web site. When you include a feedback message with the rejection, it
helps the Worker understand why the assignment was rejected, and can improve the quality of
the results the Worker submits in the future. Only the Requester who created the HIT can
reject an assignment for the HIT.
# Arguments
- `assignment_id`: The ID of the assignment. The assignment must correspond to a HIT
created by the Requester.
- `requester_feedback`: A message for the Worker, which the Worker can see in the Status
section of the web site.
"""
function reject_assignment(
AssignmentId, RequesterFeedback; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"RejectAssignment",
Dict{String,Any}(
"AssignmentId" => AssignmentId, "RequesterFeedback" => RequesterFeedback
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_assignment(
AssignmentId,
RequesterFeedback,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"RejectAssignment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssignmentId" => AssignmentId, "RequesterFeedback" => RequesterFeedback
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_qualification_request(qualification_request_id)
reject_qualification_request(qualification_request_id, params::Dict{String,<:Any})
The RejectQualificationRequest operation rejects a user's request for a Qualification.
You can provide a text message explaining why the request was rejected. The Worker who made
the request can see this message.
# Arguments
- `qualification_request_id`: The ID of the Qualification request, as returned by the
ListQualificationRequests operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Reason"`: A text message explaining why the request was rejected, to be shown to the
Worker who made the request.
"""
function reject_qualification_request(
QualificationRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"RejectQualificationRequest",
Dict{String,Any}("QualificationRequestId" => QualificationRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_qualification_request(
QualificationRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"RejectQualificationRequest",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationRequestId" => QualificationRequestId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_bonus(assignment_id, bonus_amount, reason, worker_id)
send_bonus(assignment_id, bonus_amount, reason, worker_id, params::Dict{String,<:Any})
The SendBonus operation issues a payment of money from your account to a Worker. This
payment happens separately from the reward you pay to the Worker when you approve the
Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID
as parameters to initiate payment of the bonus. You must include a message that explains
the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon
Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This
operation fails if your account does not have enough funds to pay for both the bonus and
the fees.
# Arguments
- `assignment_id`: The ID of the assignment for which this bonus is paid.
- `bonus_amount`: The Bonus amount is a US Dollar amount specified using a string (for
example, \"5\" represents 5.00 USD and \"101.42\" represents 101.42 USD). Do not include
currency symbols or currency codes.
- `reason`: A message that explains the reason for the bonus payment. The Worker receiving
the bonus can see this message.
- `worker_id`: The ID of the Worker being paid the bonus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UniqueRequestToken"`: A unique identifier for this request, which allows you to retry
the call on error without granting multiple bonuses. This is useful in cases such as
network timeouts where it is unclear whether or not the call succeeded on the server. If
the bonus already exists in the system from a previous call using the same
UniqueRequestToken, subsequent calls will return an error with a message containing the
request ID.
"""
function send_bonus(
AssignmentId,
BonusAmount,
Reason,
WorkerId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"SendBonus",
Dict{String,Any}(
"AssignmentId" => AssignmentId,
"BonusAmount" => BonusAmount,
"Reason" => Reason,
"WorkerId" => WorkerId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_bonus(
AssignmentId,
BonusAmount,
Reason,
WorkerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"SendBonus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssignmentId" => AssignmentId,
"BonusAmount" => BonusAmount,
"Reason" => Reason,
"WorkerId" => WorkerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_test_event_notification(notification, test_event_type)
send_test_event_notification(notification, test_event_type, params::Dict{String,<:Any})
The SendTestEventNotification operation causes Amazon Mechanical Turk to send a
notification message as if a HIT event occurred, according to the provided notification
specification. This allows you to test notifications without setting up notifications for a
real HIT type and trying to trigger them using the website. When you call this operation,
the service attempts to send the test notification immediately.
# Arguments
- `notification`: The notification specification to test. This value is identical to the
value you would provide to the UpdateNotificationSettings operation when you establish the
notification specification for a HIT type.
- `test_event_type`: The event to simulate to test the notification specification. This
event is included in the test message even if the notification specification does not
include the event type. The notification specification does not filter out the test event.
"""
function send_test_event_notification(
Notification, TestEventType; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"SendTestEventNotification",
Dict{String,Any}("Notification" => Notification, "TestEventType" => TestEventType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_test_event_notification(
Notification,
TestEventType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"SendTestEventNotification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Notification" => Notification, "TestEventType" => TestEventType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_expiration_for_hit(expire_at, hitid)
update_expiration_for_hit(expire_at, hitid, params::Dict{String,<:Any})
The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If
you update it to a time in the past, the HIT will be immediately expired.
# Arguments
- `expire_at`: The date and time at which you want the HIT to expire
- `hitid`: The HIT to update.
"""
function update_expiration_for_hit(
ExpireAt, HITId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"UpdateExpirationForHIT",
Dict{String,Any}("ExpireAt" => ExpireAt, "HITId" => HITId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_expiration_for_hit(
ExpireAt,
HITId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"UpdateExpirationForHIT",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ExpireAt" => ExpireAt, "HITId" => HITId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_hitreview_status(hitid)
update_hitreview_status(hitid, params::Dict{String,<:Any})
The UpdateHITReviewStatus operation updates the status of a HIT. If the status is
Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing
HIT back to the Reviewable status.
# Arguments
- `hitid`: The ID of the HIT to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Revert"`: Specifies how to update the HIT status. Default is False. Setting this
to false will only transition a HIT from Reviewable to Reviewing Setting this to true
will only transition a HIT from Reviewing to Reviewable
"""
function update_hitreview_status(HITId; aws_config::AbstractAWSConfig=global_aws_config())
return mturk(
"UpdateHITReviewStatus",
Dict{String,Any}("HITId" => HITId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_hitreview_status(
HITId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"UpdateHITReviewStatus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HITId" => HITId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_hittype_of_hit(hitid, hittype_id)
update_hittype_of_hit(hitid, hittype_id, params::Dict{String,<:Any})
The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT.
This operation disassociates the HIT from its old HITType properties and associates it with
the new HITType properties. The HIT takes on the properties of the new HITType in place of
the old ones.
# Arguments
- `hitid`: The HIT to update.
- `hittype_id`: The ID of the new HIT type.
"""
function update_hittype_of_hit(
HITId, HITTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"UpdateHITTypeOfHIT",
Dict{String,Any}("HITId" => HITId, "HITTypeId" => HITTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_hittype_of_hit(
HITId,
HITTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"UpdateHITTypeOfHIT",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HITId" => HITId, "HITTypeId" => HITTypeId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_notification_settings(hittype_id)
update_notification_settings(hittype_id, params::Dict{String,<:Any})
The UpdateNotificationSettings operation creates, updates, disables or re-enables
notifications for a HIT type. If you call the UpdateNotificationSettings operation for a
HIT type that already has a notification specification, the operation replaces the old
specification with a new one. You can call the UpdateNotificationSettings operation to
enable or disable notifications for the HIT type, without having to modify the notification
specification itself by providing updates to the Active status without specifying a new
notification specification. To change the Active status of a HIT type's notifications, the
HIT type must already have a notification specification, or one must be provided in the
same call to UpdateNotificationSettings.
# Arguments
- `hittype_id`: The ID of the HIT type whose notification specification is being updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Active"`: Specifies whether notifications are sent for HITs of this HIT type,
according to the notification specification. You must specify either the Notification
parameter or the Active parameter for the call to UpdateNotificationSettings to succeed.
- `"Notification"`: The notification specification for the HIT type.
"""
function update_notification_settings(
HITTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"UpdateNotificationSettings",
Dict{String,Any}("HITTypeId" => HITTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_notification_settings(
HITTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"UpdateNotificationSettings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HITTypeId" => HITTypeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_qualification_type(qualification_type_id)
update_qualification_type(qualification_type_id, params::Dict{String,<:Any})
The UpdateQualificationType operation modifies the attributes of an existing Qualification
type, which is represented by a QualificationType data structure. Only the owner of a
Qualification type can modify its attributes. Most attributes of a Qualification type can
be changed after the type has been created. However, the Name and Keywords fields cannot be
modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or
to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use
this operation to update the test for a Qualification type. The test is updated based on
the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All
three parameters specify the updated test. If you are updating the test for a type, you
must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is
optional; omitting it specifies that the updated test does not have an answer key. If you
omit the Test parameter, the test for the Qualification type is unchanged. There is no way
to remove a test from a Qualification type that has one. If the type already has a test,
you cannot update it to be AutoGranted. If the Qualification type does not have a test and
one is provided by an update, the type will henceforth have a test. If you want to update
the test duration or answer key for an existing test without changing the questions, you
must specify a Test parameter with the original questions, along with the updated values.
If you provide an updated Test but no AnswerKey, the new test will not have an answer key.
Requests for such Qualifications must be granted manually. You can also update the
AutoGranted and AutoGrantedValue attributes of the Qualification type.
# Arguments
- `qualification_type_id`: The ID of the Qualification type to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnswerKey"`: The answers to the Qualification test specified in the Test parameter, in
the form of an AnswerKey data structure.
- `"AutoGranted"`: Specifies whether requests for the Qualification type are granted
immediately, without prompting the Worker with a Qualification test. Constraints: If the
Test parameter is specified, this parameter cannot be true.
- `"AutoGrantedValue"`: The Qualification value to use for automatically granted
Qualifications. This parameter is used only if the AutoGranted parameter is true.
- `"Description"`: The new description of the Qualification type.
- `"QualificationTypeStatus"`: The new status of the Qualification type - Active | Inactive
- `"RetryDelayInSeconds"`: The amount of time, in seconds, that Workers must wait after
requesting a Qualification of the specified Qualification type before they can retry the
Qualification request. It is not possible to disable retries for a Qualification type after
it has been created with retries enabled. If you want to disable retries, you must dispose
of the existing retry-enabled Qualification type using DisposeQualificationType and then
create a new Qualification type with retries disabled using CreateQualificationType.
- `"Test"`: The questions for the Qualification test a Worker must answer correctly to
obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds
must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a
QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.
Constraints: None. If not specified, the Worker may request the Qualification without
answering any questions.
- `"TestDurationInSeconds"`: The number of seconds the Worker has to complete the
Qualification test, starting from the time the Worker requests the Qualification.
"""
function update_qualification_type(
QualificationTypeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return mturk(
"UpdateQualificationType",
Dict{String,Any}("QualificationTypeId" => QualificationTypeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_qualification_type(
QualificationTypeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mturk(
"UpdateQualificationType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QualificationTypeId" => QualificationTypeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 25623 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: mwaa
using AWS.Compat
using AWS.UUIDs
"""
create_cli_token(name)
create_cli_token(name, params::Dict{String,<:Any})
Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI
token.
# Arguments
- `name`: The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
"""
function create_cli_token(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"POST", "/clitoken/$(Name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_cli_token(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"POST",
"/clitoken/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(dag_s3_path, execution_role_arn, name, network_configuration, source_bucket_arn)
create_environment(dag_s3_path, execution_role_arn, name, network_configuration, source_bucket_arn, params::Dict{String,<:Any})
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
# Arguments
- `dag_s3_path`: The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. For more information, see Adding or updating DAGs.
- `execution_role_arn`: The Amazon Resource Name (ARN) of the execution role for your
environment. An execution role is an Amazon Web Services Identity and Access Management
(IAM) role that grants MWAA permission to access Amazon Web Services services and resources
used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For
more information, see Amazon MWAA Execution role.
- `name`: The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
- `network_configuration`: The VPC networking components used to secure and enable network
traffic between the Amazon Web Services resources for your environment. For more
information, see About networking on Amazon MWAA.
- `source_bucket_arn`: The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
DAG code and supporting files are stored. For example,
arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an Amazon S3
bucket for Amazon MWAA.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AirflowConfigurationOptions"`: A list of key-value pairs containing the Apache Airflow
configuration options you want to attach to your environment. For more information, see
Apache Airflow configuration options.
- `"AirflowVersion"`: The Apache Airflow version for your environment. If no value is
specified, it defaults to the latest version. For more information, see Apache Airflow
versions on Amazon Managed Workflows for Apache Airflow (MWAA). Valid values: 1.10.12,
2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2 2.8.1
- `"EndpointManagement"`: Defines whether the VPC endpoints configured for the environment
are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA
will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must
create, and manage, the VPC endpoints for your VPC. If you choose to create an environment
in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the
environment will remain in PENDING status until you create the VPC endpoints. If you do not
take action to create the endpoints within 72 hours, the status will change to
CREATE_FAILED. You can delete the failed environment and create a new one.
- `"EnvironmentClass"`: The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment
class.
- `"KmsKey"`: The Amazon Web Services Key Management Service (KMS) key to encrypt the data
in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed
CMK (advanced). For more information, see Create an Amazon MWAA environment.
- `"LoggingConfiguration"`: Defines the Apache Airflow logs to send to CloudWatch Logs.
- `"MaxWebservers"`: The maximum number of web servers that you want to run in your
environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number
you specify for MaxWebservers when you interact with your Apache Airflow environment using
Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your
workload requires network calls to the Apache Airflow REST API with a high
transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up
to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the
additional web servers, and scales down to the number set in MinxWebserers. Valid values:
Accepts between 2 and 5. Defaults to 2.
- `"MaxWorkers"`: The maximum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you specify in the
MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the
queue, MWAA disposes of the extra workers leaving the one worker that is included with your
environment, or the number you specify in MinWorkers.
- `"MinWebservers"`: The minimum number of web servers that you want to run in your
environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number
you specify for MaxWebservers when you interact with your Apache Airflow environment using
Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and
the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales
down to the number set in MinxWebserers. Valid values: Accepts between 2 and 5. Defaults
to 2.
- `"MinWorkers"`: The minimum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you specify in the
MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA
disposes of the extra workers leaving the worker count you specify in the MinWorkers field.
For example, 2.
- `"PluginsS3ObjectVersion"`: The version of the plugins.zip file on your Amazon S3 bucket.
You must specify a version each time a plugins.zip file is updated. For more information,
see How S3 Versioning works.
- `"PluginsS3Path"`: The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. If specified, then the plugins.zip version is required. For more
information, see Installing custom plugins.
- `"RequirementsS3ObjectVersion"`: The version of the requirements.txt file on your Amazon
S3 bucket. You must specify a version each time a requirements.txt file is updated. For
more information, see How S3 Versioning works.
- `"RequirementsS3Path"`: The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. If specified, then a version is required. For more
information, see Installing Python dependencies.
- `"Schedulers"`: The number of Apache Airflow schedulers to run in your environment. Valid
values: v2 - Accepts between 2 to 5. Defaults to 2. v1 - Accepts 1.
- `"StartupScriptS3ObjectVersion"`: The version of the startup shell script in your Amazon
S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time
you update the script. Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings
that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo For more information,
see Using a startup script.
- `"StartupScriptS3Path"`: The relative path to the startup shell script in your Amazon S3
bucket. For example, s3://mwaa-environment/startup.sh. Amazon MWAA runs the script as your
environment starts, and before running the Apache Airflow process. You can use this script
to install dependencies, modify Apache Airflow configuration options, and set environment
variables. For more information, see Using a startup script.
- `"Tags"`: The key-value tag pairs you want to associate to your environment. For example,
\"Environment\": \"Staging\". For more information, see Tagging Amazon Web Services
resources.
- `"WebserverAccessMode"`: Defines the access mode for the Apache Airflow web server. For
more information, see Apache Airflow access modes.
- `"WeeklyMaintenanceWindowStart"`: The day and time of the week in Coordinated Universal
Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in
the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30
minute increments only.
"""
function create_environment(
DagS3Path,
ExecutionRoleArn,
Name,
NetworkConfiguration,
SourceBucketArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mwaa(
"PUT",
"/environments/$(Name)",
Dict{String,Any}(
"DagS3Path" => DagS3Path,
"ExecutionRoleArn" => ExecutionRoleArn,
"NetworkConfiguration" => NetworkConfiguration,
"SourceBucketArn" => SourceBucketArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
DagS3Path,
ExecutionRoleArn,
Name,
NetworkConfiguration,
SourceBucketArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mwaa(
"PUT",
"/environments/$(Name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DagS3Path" => DagS3Path,
"ExecutionRoleArn" => ExecutionRoleArn,
"NetworkConfiguration" => NetworkConfiguration,
"SourceBucketArn" => SourceBucketArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_login_token(name)
create_web_login_token(name, params::Dict{String,<:Any})
Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache
Airflow web login token.
# Arguments
- `name`: The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
"""
function create_web_login_token(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"POST", "/webtoken/$(Name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_web_login_token(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"POST",
"/webtoken/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(name)
delete_environment(name, params::Dict{String,<:Any})
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
# Arguments
- `name`: The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
"""
function delete_environment(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"DELETE",
"/environments/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"DELETE",
"/environments/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(name)
get_environment(name, params::Dict{String,<:Any})
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
# Arguments
- `name`: The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
"""
function get_environment(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"GET",
"/environments/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"GET",
"/environments/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments()
list_environments(params::Dict{String,<:Any})
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to retrieve per page. For example, 5
environments per page.
- `"NextToken"`: Retrieves the next page of the results.
"""
function list_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"GET", "/environments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"GET",
"/environments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow
(MWAA) environment. For example, \"Environment\": \"Staging\".
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mwaa(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_metrics(environment_name, metric_data)
publish_metrics(environment_name, metric_data, params::Dict{String,<:Any})
Internal only. Publishes environment health metrics to Amazon CloudWatch.
# Arguments
- `environment_name`: Internal only. The name of the environment.
- `metric_data`: Internal only. Publishes metrics to Amazon CloudWatch. To learn more
about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in
Amazon CloudWatch.
"""
function publish_metrics(
EnvironmentName, MetricData; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"POST",
"/metrics/environments/$(EnvironmentName)",
Dict{String,Any}("MetricData" => MetricData);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_metrics(
EnvironmentName,
MetricData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mwaa(
"POST",
"/metrics/environments/$(EnvironmentName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MetricData" => MetricData), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA)
environment.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
- `tags`: The key-value tag pairs you want to associate to your environment. For example,
\"Environment\": \"Staging\". For more information, see Tagging Amazon Web Services
resources.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mwaa(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow
(MWAA) environment. For example, \"Environment\": \"Staging\".
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
- `tag_keys`: The key-value tag pair you want to remove. For example, \"Environment\":
\"Staging\".
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return mwaa(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment(name)
update_environment(name, params::Dict{String,<:Any})
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
# Arguments
- `name`: The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AirflowConfigurationOptions"`: A list of key-value pairs containing the Apache Airflow
configuration options you want to attach to your environment. For more information, see
Apache Airflow configuration options.
- `"AirflowVersion"`: The Apache Airflow version for your environment. To upgrade your
environment, specify a newer version of Apache Airflow supported by Amazon MWAA. Before you
upgrade an environment, make sure your requirements, DAGs, plugins, and other resources
used in your workflows are compatible with the new Apache Airflow version. For more
information about updating your resources, see Upgrading an Amazon MWAA environment. Valid
values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2, 2.8.1.
- `"DagS3Path"`: The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. For more information, see Adding or updating DAGs.
- `"EnvironmentClass"`: The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment
class.
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of the execution role in IAM that
allows MWAA to access Amazon Web Services resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA
Execution role.
- `"LoggingConfiguration"`: The Apache Airflow log types to send to CloudWatch Logs.
- `"MaxWebservers"`: The maximum number of web servers that you want to run in your
environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number
you specify for MaxWebservers when you interact with your Apache Airflow environment using
Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your
workload requires network calls to the Apache Airflow REST API with a high
transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up
to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the
additional web servers, and scales down to the number set in MinxWebserers. Valid values:
Accepts between 2 and 5. Defaults to 2.
- `"MaxWorkers"`: The maximum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you specify in the
MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the
queue, MWAA disposes of the extra workers leaving the one worker that is included with your
environment, or the number you specify in MinWorkers.
- `"MinWebservers"`: The minimum number of web servers that you want to run in your
environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number
you specify for MaxWebservers when you interact with your Apache Airflow environment using
Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and
the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales
down to the number set in MinxWebserers. Valid values: Accepts between 2 and 5. Defaults
to 2.
- `"MinWorkers"`: The minimum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you specify in the
MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA
disposes of the extra workers leaving the worker count you specify in the MinWorkers field.
For example, 2.
- `"NetworkConfiguration"`: The VPC networking components used to secure and enable network
traffic between the Amazon Web Services resources for your environment. For more
information, see About networking on Amazon MWAA.
- `"PluginsS3ObjectVersion"`: The version of the plugins.zip file on your Amazon S3 bucket.
You must specify a version each time a plugins.zip file is updated. For more information,
see How S3 Versioning works.
- `"PluginsS3Path"`: The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. If specified, then the plugins.zip version is required. For more
information, see Installing custom plugins.
- `"RequirementsS3ObjectVersion"`: The version of the requirements.txt file on your Amazon
S3 bucket. You must specify a version each time a requirements.txt file is updated. For
more information, see How S3 Versioning works.
- `"RequirementsS3Path"`: The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. If specified, then a file version is required. For
more information, see Installing Python dependencies.
- `"Schedulers"`: The number of Apache Airflow schedulers to run in your Amazon MWAA
environment.
- `"SourceBucketArn"`: The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
DAG code and supporting files are stored. For example,
arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an Amazon S3
bucket for Amazon MWAA.
- `"StartupScriptS3ObjectVersion"`: The version of the startup shell script in your Amazon
S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time
you update the script. Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings
that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo For more information,
see Using a startup script.
- `"StartupScriptS3Path"`: The relative path to the startup shell script in your Amazon S3
bucket. For example, s3://mwaa-environment/startup.sh. Amazon MWAA runs the script as your
environment starts, and before running the Apache Airflow process. You can use this script
to install dependencies, modify Apache Airflow configuration options, and set environment
variables. For more information, see Using a startup script.
- `"WebserverAccessMode"`: The Apache Airflow Web server access mode. For more information,
see Apache Airflow access modes.
- `"WeeklyMaintenanceWindowStart"`: The day and time of the week in Coordinated Universal
Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in
the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30
minute increments only.
"""
function update_environment(Name; aws_config::AbstractAWSConfig=global_aws_config())
return mwaa(
"PATCH",
"/environments/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return mwaa(
"PATCH",
"/environments/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 180840 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: neptune
using AWS.Compat
using AWS.UUIDs
"""
add_role_to_dbcluster(dbcluster_identifier, role_arn)
add_role_to_dbcluster(dbcluster_identifier, role_arn, params::Dict{String,<:Any})
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to associate the IAM role with.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune
DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureName"`: The name of the feature for the Neptune DB cluster that the IAM role is
to be associated with. For the list of supported feature names, see DBEngineVersion.
"""
function add_role_to_dbcluster(
DBClusterIdentifier, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"AddRoleToDBCluster",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_role_to_dbcluster(
DBClusterIdentifier,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"AddRoleToDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_source_identifier_to_subscription(source_identifier, subscription_name)
add_source_identifier_to_subscription(source_identifier, subscription_name, params::Dict{String,<:Any})
Adds a source identifier to an existing event notification subscription.
# Arguments
- `source_identifier`: The identifier of the event source to be added. Constraints: If
the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the
source type is a DB security group, a DBSecurityGroupName must be supplied. If the source
type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type
is a DB snapshot, a DBSnapshotIdentifier must be supplied.
- `subscription_name`: The name of the event notification subscription you want to add a
source identifier to.
"""
function add_source_identifier_to_subscription(
SourceIdentifier, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"AddSourceIdentifierToSubscription",
Dict{String,Any}(
"SourceIdentifier" => SourceIdentifier, "SubscriptionName" => SubscriptionName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_source_identifier_to_subscription(
SourceIdentifier,
SubscriptionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"AddSourceIdentifierToSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceIdentifier" => SourceIdentifier,
"SubscriptionName" => SubscriptionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags_to_resource(resource_name, tag)
add_tags_to_resource(resource_name, tag, params::Dict{String,<:Any})
Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost
allocation reporting to track cost associated with Amazon Neptune resources, or used in a
Condition statement in an IAM policy for Amazon Neptune.
# Arguments
- `resource_name`: The Amazon Neptune resource that the tags are added to. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an
Amazon Resource Name (ARN).
- `tag`: The tags to be assigned to the Amazon Neptune resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the Amazon Neptune resource.
"""
function add_tags_to_resource(
ResourceName, Tag; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"AddTagsToResource",
Dict{String,Any}("ResourceName" => ResourceName, "Tag" => Tag);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags_to_resource(
ResourceName,
Tag,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "Tag" => Tag),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
apply_pending_maintenance_action(apply_action, opt_in_type, resource_identifier)
apply_pending_maintenance_action(apply_action, opt_in_type, resource_identifier, params::Dict{String,<:Any})
Applies a pending maintenance action to a resource (for example, to a DB instance).
# Arguments
- `apply_action`: The pending maintenance action to apply to this resource. Valid values:
system-update, db-upgrade
- `opt_in_type`: A value that specifies the type of opt-in request, or undoes an opt-in
request. An opt-in request of type immediate can't be undone. Valid values: immediate -
Apply the maintenance action immediately. next-maintenance - Apply the maintenance
action during the next maintenance window for the resource. undo-opt-in - Cancel any
existing next-maintenance opt-in requests.
- `resource_identifier`: The Amazon Resource Name (ARN) of the resource that the pending
maintenance action applies to. For information about creating an ARN, see Constructing an
Amazon Resource Name (ARN).
"""
function apply_pending_maintenance_action(
ApplyAction,
OptInType,
ResourceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ApplyPendingMaintenanceAction",
Dict{String,Any}(
"ApplyAction" => ApplyAction,
"OptInType" => OptInType,
"ResourceIdentifier" => ResourceIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function apply_pending_maintenance_action(
ApplyAction,
OptInType,
ResourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ApplyPendingMaintenanceAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyAction" => ApplyAction,
"OptInType" => OptInType,
"ResourceIdentifier" => ResourceIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbcluster_parameter_group(source_dbcluster_parameter_group_identifier, target_dbcluster_parameter_group_description, target_dbcluster_parameter_group_identifier)
copy_dbcluster_parameter_group(source_dbcluster_parameter_group_identifier, target_dbcluster_parameter_group_description, target_dbcluster_parameter_group_identifier, params::Dict{String,<:Any})
Copies the specified DB cluster parameter group.
# Arguments
- `source_dbcluster_parameter_group_identifier`: The identifier or Amazon Resource Name
(ARN) for the source DB cluster parameter group. For information about creating an ARN, see
Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster
parameter group. If the source DB cluster parameter group is in the same Amazon Region as
the copy, specify a valid DB parameter group identifier, for example
my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a
different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for
example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
- `target_dbcluster_parameter_group_description`: A description for the copied DB cluster
parameter group.
- `target_dbcluster_parameter_group_identifier`: The identifier for the copied DB cluster
parameter group. Constraints: Cannot be null, empty, or blank Must contain from 1 to
255 letters, numbers, or hyphens First character must be a letter Cannot end with a
hyphen or contain two consecutive hyphens Example: my-cluster-param-group1
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the copied DB cluster parameter group.
"""
function copy_dbcluster_parameter_group(
SourceDBClusterParameterGroupIdentifier,
TargetDBClusterParameterGroupDescription,
TargetDBClusterParameterGroupIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CopyDBClusterParameterGroup",
Dict{String,Any}(
"SourceDBClusterParameterGroupIdentifier" =>
SourceDBClusterParameterGroupIdentifier,
"TargetDBClusterParameterGroupDescription" =>
TargetDBClusterParameterGroupDescription,
"TargetDBClusterParameterGroupIdentifier" =>
TargetDBClusterParameterGroupIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_dbcluster_parameter_group(
SourceDBClusterParameterGroupIdentifier,
TargetDBClusterParameterGroupDescription,
TargetDBClusterParameterGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CopyDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBClusterParameterGroupIdentifier" =>
SourceDBClusterParameterGroupIdentifier,
"TargetDBClusterParameterGroupDescription" =>
TargetDBClusterParameterGroupDescription,
"TargetDBClusterParameterGroupIdentifier" =>
TargetDBClusterParameterGroupIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbcluster_snapshot(source_dbcluster_snapshot_identifier, target_dbcluster_snapshot_identifier)
copy_dbcluster_snapshot(source_dbcluster_snapshot_identifier, target_dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB
cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN)
of the shared DB cluster snapshot.
# Arguments
- `source_dbcluster_snapshot_identifier`: The identifier of the DB cluster snapshot to
copy. This parameter is not case-sensitive. Constraints: Must specify a valid system
snapshot in the \"available\" state. Specify a valid DB snapshot identifier. Example:
my-cluster-snapshot1
- `target_dbcluster_snapshot_identifier`: The identifier of the new DB cluster snapshot to
create from the source DB cluster snapshot. This parameter is not case-sensitive.
Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character
must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example:
my-cluster-snapshot2
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CopyTags"`: True to copy all tags from the source DB cluster snapshot to the target DB
cluster snapshot, and otherwise false. The default is false.
- `"KmsKeyId"`: The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS
key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the
KMS encryption key. If you copy an encrypted DB cluster snapshot from your Amazon account,
you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If
you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is
encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted
DB cluster snapshot that is shared from another Amazon account, then you must specify a
value for KmsKeyId. KMS encryption keys are specific to the Amazon Region that they are
created in, and you can't use encryption keys from one Amazon Region in another Amazon
Region. You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try
to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter,
an error is returned.
- `"PreSignedUrl"`: Not currently supported.
- `"Tags"`: The tags to assign to the new DB cluster snapshot copy.
"""
function copy_dbcluster_snapshot(
SourceDBClusterSnapshotIdentifier,
TargetDBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CopyDBClusterSnapshot",
Dict{String,Any}(
"SourceDBClusterSnapshotIdentifier" => SourceDBClusterSnapshotIdentifier,
"TargetDBClusterSnapshotIdentifier" => TargetDBClusterSnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_dbcluster_snapshot(
SourceDBClusterSnapshotIdentifier,
TargetDBClusterSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CopyDBClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBClusterSnapshotIdentifier" =>
SourceDBClusterSnapshotIdentifier,
"TargetDBClusterSnapshotIdentifier" =>
TargetDBClusterSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbparameter_group(source_dbparameter_group_identifier, target_dbparameter_group_description, target_dbparameter_group_identifier)
copy_dbparameter_group(source_dbparameter_group_identifier, target_dbparameter_group_description, target_dbparameter_group_identifier, params::Dict{String,<:Any})
Copies the specified DB parameter group.
# Arguments
- `source_dbparameter_group_identifier`: The identifier or ARN for the source DB parameter
group. For information about creating an ARN, see Constructing an Amazon Resource Name
(ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB
parameter group identifier, for example my-db-param-group, or a valid ARN.
- `target_dbparameter_group_description`: A description for the copied DB parameter group.
- `target_dbparameter_group_identifier`: The identifier for the copied DB parameter group.
Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters,
numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or
contain two consecutive hyphens. Example: my-db-parameter-group
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the copied DB parameter group.
"""
function copy_dbparameter_group(
SourceDBParameterGroupIdentifier,
TargetDBParameterGroupDescription,
TargetDBParameterGroupIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CopyDBParameterGroup",
Dict{String,Any}(
"SourceDBParameterGroupIdentifier" => SourceDBParameterGroupIdentifier,
"TargetDBParameterGroupDescription" => TargetDBParameterGroupDescription,
"TargetDBParameterGroupIdentifier" => TargetDBParameterGroupIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_dbparameter_group(
SourceDBParameterGroupIdentifier,
TargetDBParameterGroupDescription,
TargetDBParameterGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CopyDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBParameterGroupIdentifier" => SourceDBParameterGroupIdentifier,
"TargetDBParameterGroupDescription" =>
TargetDBParameterGroupDescription,
"TargetDBParameterGroupIdentifier" => TargetDBParameterGroupIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster(dbcluster_identifier, engine)
create_dbcluster(dbcluster_identifier, engine, params::Dict{String,<:Any})
Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon
Neptune DB instance. Note that when you create a new cluster using CreateDBCluster
directly, deletion protection is disabled by default (when you create a new production
cluster in the console, deletion protection is enabled by default). You can only delete a
DB cluster if its DeletionProtection field is set to false.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier. This parameter is stored as a
lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter. Cannot end with a hyphen or contain two consecutive
hyphens. Example: my-cluster1
- `engine`: The name of the database engine to be used for this DB cluster. Valid Values:
neptune
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: A list of EC2 Availability Zones that instances in the DB cluster
can be created in.
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to
35
- `"CharacterSetName"`: (Not supported by Neptune)
- `"CopyTagsToSnapshot"`: If set to true, tags are copied to any snapshot of the DB
cluster that is created.
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with this DB cluster. If this argument is omitted, the default is used. Constraints: If
supplied, must match the name of an existing DBClusterParameterGroup.
- `"DBSubnetGroupName"`: A DB subnet group to associate with this DB cluster. Constraints:
Must match the name of an existing DBSubnetGroup. Must not be default. Example:
mySubnetgroup
- `"DatabaseName"`: The name for your database of up to 64 alpha-numeric characters. If you
do not provide a name, Amazon Neptune will not create a database in the DB cluster you are
creating.
- `"DeletionProtection"`: A value that indicates whether the DB cluster has deletion
protection enabled. The database can't be deleted when deletion protection is enabled. By
default, deletion protection is enabled.
- `"EnableCloudwatchLogsExports"`: A list of the log types that this DB cluster should
export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery
(to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.
- `"EnableIAMDatabaseAuthentication"`: If set to true, enables Amazon Identity and Access
Management (IAM) authentication for the entire DB cluster (this cannot be set at an
instance level). Default: false.
- `"EngineVersion"`: The version number of the database engine to use for the new DB
cluster. Example: 1.0.2.1
- `"GlobalClusterIdentifier"`: The ID of the Neptune global database to which this new DB
cluster should be added.
- `"KmsKeyId"`: The Amazon KMS key identifier for an encrypted DB cluster. The KMS key
identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are
creating a DB cluster with the same Amazon account that owns the KMS encryption key used to
encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the
KMS encryption key. If an encryption key is not specified in KmsKeyId: If
ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use
the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your
default encryption key. If the StorageEncrypted parameter is true and
ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default
encryption key. Amazon KMS creates the default encryption key for your Amazon account.
Your Amazon account has a different default encryption key for each Amazon Region. If you
create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set
KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used
to encrypt the Read Replica in that Amazon Region.
- `"MasterUserPassword"`: Not supported by Neptune.
- `"MasterUsername"`: Not supported by Neptune.
- `"OptionGroupName"`: (Not supported by Neptune)
- `"Port"`: The port number on which the instances in the DB cluster accept connections.
Default: 8182
- `"PreSignedUrl"`: This parameter is not currently supported.
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled using the BackupRetentionPeriod parameter. The
default is a 30-minute window selected at random from an 8-hour block of time for each
Amazon Region. To see the time blocks available, see Neptune Maintenance Window in the
Amazon Neptune User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be
in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
- `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is
a 30-minute window selected at random from an 8-hour block of time for each Amazon Region,
occurring on a random day of the week. To see the time blocks available, see Neptune
Maintenance Window in the Amazon Neptune User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri,
Sat, Sun. Constraints: Minimum 30-minute window.
- `"ReplicationSourceIdentifier"`: The Amazon Resource Name (ARN) of the source DB instance
or DB cluster if this DB cluster is created as a Read Replica.
- `"ServerlessV2ScalingConfiguration"`: Contains the scaling configuration of a Neptune
Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
- `"StorageEncrypted"`: Specifies whether the DB cluster is encrypted.
- `"StorageType"`: The storage type to associate with the DB cluster. Valid Values:
standard | iopt1 Default: standard When you create a Neptune cluster with the
storage type set to iopt1, the storage type is returned in the response. The storage type
isn't returned when you set it to standard.
- `"Tags"`: The tags to assign to the new DB cluster.
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB
cluster.
"""
function create_dbcluster(
DBClusterIdentifier, Engine; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"CreateDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier, "Engine" => Engine);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbcluster(
DBClusterIdentifier,
Engine,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "Engine" => Engine
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster_endpoint(dbcluster_endpoint_identifier, dbcluster_identifier, endpoint_type)
create_dbcluster_endpoint(dbcluster_endpoint_identifier, dbcluster_identifier, endpoint_type, params::Dict{String,<:Any})
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
# Arguments
- `dbcluster_endpoint_identifier`: The identifier to use for the new endpoint. This
parameter is stored as a lowercase string.
- `dbcluster_identifier`: The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
- `endpoint_type`: The type of the endpoint. One of: READER, WRITER, ANY.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludedMembers"`: List of DB instance identifiers that aren't part of the custom
endpoint group. All other eligible instances are reachable through the custom endpoint.
Only relevant if the list of static members is empty.
- `"StaticMembers"`: List of DB instance identifiers that are part of the custom endpoint
group.
- `"Tags"`: The tags to be assigned to the Amazon Neptune resource.
"""
function create_dbcluster_endpoint(
DBClusterEndpointIdentifier,
DBClusterIdentifier,
EndpointType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBClusterEndpoint",
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier,
"DBClusterIdentifier" => DBClusterIdentifier,
"EndpointType" => EndpointType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbcluster_endpoint(
DBClusterEndpointIdentifier,
DBClusterIdentifier,
EndpointType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBClusterEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier,
"DBClusterIdentifier" => DBClusterIdentifier,
"EndpointType" => EndpointType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster_parameter_group(dbcluster_parameter_group_name, dbparameter_group_family, description)
create_dbcluster_parameter_group(dbcluster_parameter_group_name, dbparameter_group_family, description, params::Dict{String,<:Any})
Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply
to all of the instances in a DB cluster. A DB cluster parameter group is initially created
with the default parameters for the database engine used by instances in the DB cluster. To
provide custom values for any of the parameters, you must modify the group after creating
it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group,
you need to associate it with your DB cluster using ModifyDBCluster. When you associate a
new DB cluster parameter group with a running DB cluster, you need to reboot the DB
instances in the DB cluster without failover for the new DB cluster parameter group and
associated settings to take effect. After you create a DB cluster parameter group, you
should wait at least 5 minutes before creating your first DB cluster that uses that DB
cluster parameter group as the default parameter group. This allows Amazon Neptune to fully
complete the create action before the DB cluster parameter group is used as the default for
a new DB cluster. This is especially important for parameters that are critical when
creating the default database for a DB cluster, such as the character set for the default
database defined by the character_set_database parameter. You can use the Parameter Groups
option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify
that your DB cluster parameter group has been created or modified.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group.
Constraints: Must match the name of an existing DBClusterParameterGroup. This value is
stored as a lowercase string.
- `dbparameter_group_family`: The DB cluster parameter group family name. A DB cluster
parameter group can be associated with one and only one DB cluster parameter group family,
and can be applied only to a DB cluster running a database engine and engine version
compatible with that DB cluster parameter group family.
- `description`: The description for the DB cluster parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the new DB cluster parameter group.
"""
function create_dbcluster_parameter_group(
DBClusterParameterGroupName,
DBParameterGroupFamily,
Description;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBClusterParameterGroup",
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName,
"DBParameterGroupFamily" => DBParameterGroupFamily,
"Description" => Description,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbcluster_parameter_group(
DBClusterParameterGroupName,
DBParameterGroupFamily,
Description,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName,
"DBParameterGroupFamily" => DBParameterGroupFamily,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster_snapshot(dbcluster_identifier, dbcluster_snapshot_identifier)
create_dbcluster_snapshot(dbcluster_identifier, dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Creates a snapshot of a DB cluster.
# Arguments
- `dbcluster_identifier`: The identifier of the DB cluster to create a snapshot for. This
parameter is not case-sensitive. Constraints: Must match the identifier of an existing
DBCluster. Example: my-cluster1
- `dbcluster_snapshot_identifier`: The identifier of the DB cluster snapshot. This
parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63
letters, numbers, or hyphens. First character must be a letter. Cannot end with a
hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the DB cluster snapshot.
"""
function create_dbcluster_snapshot(
DBClusterIdentifier,
DBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBClusterSnapshot",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbcluster_snapshot(
DBClusterIdentifier,
DBClusterSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbinstance(dbcluster_identifier, dbinstance_class, dbinstance_identifier, engine)
create_dbinstance(dbcluster_identifier, dbinstance_class, dbinstance_identifier, engine, params::Dict{String,<:Any})
Creates a new DB instance.
# Arguments
- `dbcluster_identifier`: The identifier of the DB cluster that the instance will belong
to. For information on creating a DB cluster, see CreateDBCluster. Type: String
- `dbinstance_class`: The compute and memory capacity of the DB instance, for example,
db.m4.large. Not all DB instance classes are available in all Amazon Regions.
- `dbinstance_identifier`: The DB instance identifier. This parameter is stored as a
lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter. Cannot end with a hyphen or contain two consecutive
hyphens. Example: mydbinstance
- `engine`: The name of the database engine to be used for this instance. Valid Values:
neptune
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: Not supported by Neptune.
- `"AutoMinorVersionUpgrade"`: Indicates that minor engine upgrades are applied
automatically to the DB instance during the maintenance window. Default: true
- `"AvailabilityZone"`: The EC2 Availability Zone that the DB instance is created in
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Region.
Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the
MultiAZ parameter is set to true. The specified Availability Zone must be in the same
Amazon Region as the current endpoint.
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
Not applicable. The retention period for automated backups is managed by the DB cluster.
For more information, see CreateDBCluster. Default: 1 Constraints: Must be a value from 0
to 35 Cannot be set to 0 if the DB instance is a source to Read Replicas
- `"CharacterSetName"`: (Not supported by Neptune)
- `"CopyTagsToSnapshot"`: True to copy all tags from the DB instance to snapshots of the DB
instance, and otherwise false. The default is false.
- `"DBName"`: Not supported.
- `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB
instance. If this argument is omitted, the default DBParameterGroup for the specified
engine is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First
character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
- `"DBSecurityGroups"`: A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
- `"DBSubnetGroupName"`: A DB subnet group to associate with this DB instance. If there is
no DB subnet group, then it is a non-VPC DB instance.
- `"DeletionProtection"`: A value that indicates whether the DB instance has deletion
protection enabled. The database can't be deleted when deletion protection is enabled. By
default, deletion protection is disabled. See Deleting a DB Instance. DB instances in a DB
cluster can be deleted even when deletion protection is enabled in their parent DB cluster.
- `"Domain"`: Specify the Active Directory Domain to create the instance in.
- `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls
to the Directory Service.
- `"EnableCloudwatchLogsExports"`: The list of log types that need to be enabled for
exporting to CloudWatch Logs.
- `"EnableIAMDatabaseAuthentication"`: Not supported by Neptune (ignored).
- `"EnablePerformanceInsights"`: (Not supported by Neptune)
- `"EngineVersion"`: The version number of the database engine to use. Currently, setting
this parameter has no effect.
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for the DB instance.
- `"KmsKeyId"`: The Amazon KMS key identifier for an encrypted DB instance. The KMS key
identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are
creating a DB instance with the same Amazon account that owns the KMS encryption key used
to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for
the KM encryption key. Not applicable. The KMS key identifier is managed by the DB cluster.
For more information, see CreateDBCluster. If the StorageEncrypted parameter is true, and
you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your
default encryption key. Amazon KMS creates the default encryption key for your Amazon
account. Your Amazon account has a different default encryption key for each Amazon Region.
- `"LicenseModel"`: License model information for this DB instance. Valid values:
license-included | bring-your-own-license | general-public-license
- `"MasterUserPassword"`: Not supported by Neptune.
- `"MasterUsername"`: Not supported by Neptune.
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting Enhanced Monitoring
metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also
set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
- `"MonitoringRoleArn"`: The ARN for the IAM role that permits Neptune to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value other than
0, then you must supply a MonitoringRoleArn value.
- `"MultiAZ"`: Specifies if the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone parameter if the MultiAZ parameter is set to true.
- `"OptionGroupName"`: (Not supported by Neptune)
- `"PerformanceInsightsKMSKeyId"`: (Not supported by Neptune)
- `"Port"`: The port number on which the database accepts connections. Not applicable. The
port is managed by the DB cluster. For more information, see CreateDBCluster. Default:
8182 Type: Integer
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created. Not applicable. The daily time range for creating automated backups is managed by
the DB cluster. For more information, see CreateDBCluster.
- `"PreferredMaintenanceWindow"`: The time range each week during which system maintenance
can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The
default is a 30-minute window selected at random from an 8-hour block of time for each
Amazon Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri,
Sat, Sun. Constraints: Minimum 30-minute window.
- `"PromotionTier"`: A value that specifies the order in which an Read Replica is promoted
to the primary instance after a failure of the existing primary instance. Default: 1 Valid
Values: 0 - 15
- `"PubliclyAccessible"`: This flag should no longer be used.
- `"StorageEncrypted"`: Specifies whether the DB instance is encrypted. Not applicable. The
encryption for DB instances is managed by the DB cluster. For more information, see
CreateDBCluster. Default: false
- `"StorageType"`: Specifies the storage type to be associated with the DB instance. Not
applicable. Storage is managed by the DB Cluster.
- `"Tags"`: The tags to assign to the new instance.
- `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for
TDE encryption.
- `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to
access the device.
- `"Timezone"`: The time zone of the DB instance.
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB
instance. Not applicable. The associated list of EC2 VPC security groups is managed by the
DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC
security group for the DB subnet group's VPC.
"""
function create_dbinstance(
DBClusterIdentifier,
DBInstanceClass,
DBInstanceIdentifier,
Engine;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBInstance",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"DBInstanceClass" => DBInstanceClass,
"DBInstanceIdentifier" => DBInstanceIdentifier,
"Engine" => Engine,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbinstance(
DBClusterIdentifier,
DBInstanceClass,
DBInstanceIdentifier,
Engine,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"DBInstanceClass" => DBInstanceClass,
"DBInstanceIdentifier" => DBInstanceIdentifier,
"Engine" => Engine,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbparameter_group(dbparameter_group_family, dbparameter_group_name, description)
create_dbparameter_group(dbparameter_group_family, dbparameter_group_name, description, params::Dict{String,<:Any})
Creates a new DB parameter group. A DB parameter group is initially created with the
default parameters for the database engine used by the DB instance. To provide custom
values for any of the parameters, you must modify the group after creating it using
ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it
with your DB instance using ModifyDBInstance. When you associate a new DB parameter group
with a running DB instance, you need to reboot the DB instance without failover for the new
DB parameter group and associated settings to take effect. After you create a DB parameter
group, you should wait at least 5 minutes before creating your first DB instance that uses
that DB parameter group as the default parameter group. This allows Amazon Neptune to fully
complete the create action before the parameter group is used as the default for a new DB
instance. This is especially important for parameters that are critical when creating the
default database for a DB instance, such as the character set for the default database
defined by the character_set_database parameter. You can use the Parameter Groups option of
the Amazon Neptune console or the DescribeDBParameters command to verify that your DB
parameter group has been created or modified.
# Arguments
- `dbparameter_group_family`: The DB parameter group family name. A DB parameter group can
be associated with one and only one DB parameter group family, and can be applied only to a
DB instance running a database engine and engine version compatible with that DB parameter
group family.
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must be 1 to
255 letters, numbers, or hyphens. First character must be a letter Cannot end with a
hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
- `description`: The description for the DB parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the new DB parameter group.
"""
function create_dbparameter_group(
DBParameterGroupFamily,
DBParameterGroupName,
Description;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBParameterGroup",
Dict{String,Any}(
"DBParameterGroupFamily" => DBParameterGroupFamily,
"DBParameterGroupName" => DBParameterGroupName,
"Description" => Description,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbparameter_group(
DBParameterGroupFamily,
DBParameterGroupName,
Description,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBParameterGroupFamily" => DBParameterGroupFamily,
"DBParameterGroupName" => DBParameterGroupName,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbsubnet_group(dbsubnet_group_description, dbsubnet_group_name, subnet_identifier)
create_dbsubnet_group(dbsubnet_group_description, dbsubnet_group_name, subnet_identifier, params::Dict{String,<:Any})
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at
least two AZs in the Amazon Region.
# Arguments
- `dbsubnet_group_description`: The description for the DB subnet group.
- `dbsubnet_group_name`: The name for the DB subnet group. This value is stored as a
lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods,
underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
- `subnet_identifier`: The EC2 Subnet IDs for the DB subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubnetIds"`: The EC2 Subnet IDs for the DB subnet group.
- `"Tags"`: The tags to be assigned to the new DB subnet group.
"""
function create_dbsubnet_group(
DBSubnetGroupDescription,
DBSubnetGroupName,
SubnetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBSubnetGroup",
Dict{String,Any}(
"DBSubnetGroupDescription" => DBSubnetGroupDescription,
"DBSubnetGroupName" => DBSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbsubnet_group(
DBSubnetGroupDescription,
DBSubnetGroupName,
SubnetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateDBSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBSubnetGroupDescription" => DBSubnetGroupDescription,
"DBSubnetGroupName" => DBSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_subscription(sns_topic_arn, subscription_name)
create_event_subscription(sns_topic_arn, subscription_name, params::Dict{String,<:Any})
Creates an event notification subscription. This action requires a topic ARN (Amazon
Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To
obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic.
The ARN is displayed in the SNS console. You can specify the type of source (SourceType)
you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the
events, and provide a list of event categories (EventCategories) for events you want to be
notified of. For example, you can specify SourceType = db-instance, SourceIds =
mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify
both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier =
myDBInstance1, you are notified of all the db-instance events for the specified source. If
you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the
events for that source type for all your Neptune sources. If you do not specify either the
SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune
sources belonging to your customer account.
# Arguments
- `sns_topic_arn`: The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
- `subscription_name`: The name of the subscription. Constraints: The name must be less
than 255 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: A Boolean value; set to true to activate the subscription, set to false to
create the subscription but not active it.
- `"EventCategories"`: A list of event categories for a SourceType that you want to
subscribe to. You can see a list of the categories for a given SourceType by using the
DescribeEventCategories action.
- `"SourceIds"`: The list of identifiers of the event sources for which events are
returned. If not specified, then all sources are included in the response. An identifier
must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't
end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are
supplied, SourceType must also be provided. If the source type is a DB instance, then a
DBInstanceIdentifier must be supplied. If the source type is a DB security group, a
DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a
DBParameterGroupName must be supplied. If the source type is a DB snapshot, a
DBSnapshotIdentifier must be supplied.
- `"SourceType"`: The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would set this parameter to
db-instance. if this value is not specified, all events are returned. Valid values:
db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot |
db-cluster-snapshot
- `"Tags"`: The tags to be applied to the new event subscription.
"""
function create_event_subscription(
SnsTopicArn, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"CreateEventSubscription",
Dict{String,Any}(
"SnsTopicArn" => SnsTopicArn, "SubscriptionName" => SubscriptionName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_subscription(
SnsTopicArn,
SubscriptionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateEventSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnsTopicArn" => SnsTopicArn, "SubscriptionName" => SubscriptionName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_global_cluster(global_cluster_identifier)
create_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})
Creates a Neptune global database spread across multiple Amazon Regions. The global
database contains a single primary cluster with read-write capability, and read-only
secondary clusters that receive data from the primary cluster through high-speed
replication performed by the Neptune storage subsystem. You can create a global database
that is initially empty, and then add a primary cluster and secondary clusters to it, or
you can specify an existing Neptune cluster during the create operation to become the
primary cluster of the global database.
# Arguments
- `global_cluster_identifier`: The cluster identifier of the new global database cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtection"`: The deletion protection setting for the new global database. The
global database can't be deleted when deletion protection is enabled.
- `"Engine"`: The name of the database engine to be used in the global database. Valid
values: neptune
- `"EngineVersion"`: The Neptune engine version to be used by the global database. Valid
values: 1.2.0.0 or above.
- `"SourceDBClusterIdentifier"`: (Optional) The Amazon Resource Name (ARN) of an existing
Neptune DB cluster to use as the primary cluster of the new global database.
- `"StorageEncrypted"`: The storage encryption setting for the new global database cluster.
"""
function create_global_cluster(
GlobalClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"CreateGlobalCluster",
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_global_cluster(
GlobalClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"CreateGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster(dbcluster_identifier)
delete_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a
DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
Manual DB cluster snapshots of the specified DB cluster are not deleted. Note that the DB
Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first
set its DeletionProtection field to False.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier for the DB cluster to be deleted. This
parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalDBSnapshotIdentifier"`: The DB cluster snapshot identifier of the new DB cluster
snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and
also setting the SkipFinalShapshot parameter to true results in an error. Constraints:
Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Cannot
end with a hyphen or contain two consecutive hyphens
- `"SkipFinalSnapshot"`: Determines whether a final DB cluster snapshot is created before
the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If
false is specified, a DB cluster snapshot is created before the DB cluster is deleted. You
must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false. Default:
false
"""
function delete_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_endpoint(dbcluster_endpoint_identifier)
delete_dbcluster_endpoint(dbcluster_endpoint_identifier, params::Dict{String,<:Any})
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
# Arguments
- `dbcluster_endpoint_identifier`: The identifier associated with the custom endpoint. This
parameter is stored as a lowercase string.
"""
function delete_dbcluster_endpoint(
DBClusterEndpointIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBClusterEndpoint",
Dict{String,Any}("DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbcluster_endpoint(
DBClusterEndpointIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBClusterEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_parameter_group(dbcluster_parameter_group_name)
delete_dbcluster_parameter_group(dbcluster_parameter_group_name, params::Dict{String,<:Any})
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be
deleted can't be associated with any DB clusters.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group.
Constraints: Must be the name of an existing DB cluster parameter group. You can't
delete a default DB cluster parameter group. Cannot be associated with any DB clusters.
"""
function delete_dbcluster_parameter_group(
DBClusterParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBClusterParameterGroup",
Dict{String,Any}("DBClusterParameterGroupName" => DBClusterParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbcluster_parameter_group(
DBClusterParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_snapshot(dbcluster_snapshot_identifier)
delete_dbcluster_snapshot(dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is
terminated. The DB cluster snapshot must be in the available state to be deleted.
# Arguments
- `dbcluster_snapshot_identifier`: The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
"""
function delete_dbcluster_snapshot(
DBClusterSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBClusterSnapshot",
Dict{String,Any}("DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbcluster_snapshot(
DBClusterSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbinstance(dbinstance_identifier)
delete_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a
DB instance, all automated backups for that instance are deleted and can't be recovered.
Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting
until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the
status of this operation. The action can't be canceled or reverted once submitted. Note
that when a DB instance is in a failure state and has a status of failed,
incompatible-restore, or incompatible-network, you can only delete it when the
SkipFinalSnapshot parameter is set to true. You can't delete a DB instance if it is the
only instance in the DB cluster, or if it has deletion protection enabled.
# Arguments
- `dbinstance_identifier`: The DB instance identifier for the DB instance to be deleted.
This parameter isn't case-sensitive. Constraints: Must match the name of an existing DB
instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalDBSnapshotIdentifier"`: The DBSnapshotIdentifier of the new DBSnapshot created
when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the
SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255
letters or numbers. First character must be a letter Cannot end with a hyphen or
contain two consecutive hyphens Cannot be specified when deleting a Read Replica.
- `"SkipFinalSnapshot"`: Determines whether a final DB snapshot is created before the DB
instance is deleted. If true is specified, no DBSnapshot is created. If false is specified,
a DB snapshot is created before the DB instance is deleted. Note that when a DB instance is
in a failure state and has a status of 'failed', 'incompatible-restore', or
'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set
to \"true\". Specify true when deleting a Read Replica. The FinalDBSnapshotIdentifier
parameter must be specified if SkipFinalSnapshot is false. Default: false
"""
function delete_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBInstance",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbinstance(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbparameter_group(dbparameter_group_name)
delete_dbparameter_group(dbparameter_group_name, params::Dict{String,<:Any})
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be
associated with any DB instances.
# Arguments
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must be the
name of an existing DB parameter group You can't delete a default DB parameter group
Cannot be associated with any DB instances
"""
function delete_dbparameter_group(
DBParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBParameterGroup",
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbparameter_group(
DBParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbsubnet_group(dbsubnet_group_name)
delete_dbsubnet_group(dbsubnet_group_name, params::Dict{String,<:Any})
Deletes a DB subnet group. The specified database subnet group must not be associated with
any DB instances.
# Arguments
- `dbsubnet_group_name`: The name of the database subnet group to delete. You can't delete
the default subnet group. Constraints: Constraints: Must match the name of an existing
DBSubnetGroup. Must not be default. Example: mySubnetgroup
"""
function delete_dbsubnet_group(
DBSubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteDBSubnetGroup",
Dict{String,Any}("DBSubnetGroupName" => DBSubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbsubnet_group(
DBSubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteDBSubnetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DBSubnetGroupName" => DBSubnetGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_subscription(subscription_name)
delete_event_subscription(subscription_name, params::Dict{String,<:Any})
Deletes an event notification subscription.
# Arguments
- `subscription_name`: The name of the event notification subscription you want to delete.
"""
function delete_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteEventSubscription",
Dict{String,Any}("SubscriptionName" => SubscriptionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_subscription(
SubscriptionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_global_cluster(global_cluster_identifier)
delete_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})
Deletes a global database. The primary and all secondary clusters must already be detached
or deleted first.
# Arguments
- `global_cluster_identifier`: The cluster identifier of the global database cluster being
deleted.
"""
function delete_global_cluster(
GlobalClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DeleteGlobalCluster",
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_global_cluster(
GlobalClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DeleteGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_endpoints()
describe_dbcluster_endpoints(params::Dict{String,<:Any})
Returns information about endpoints for an Amazon Neptune DB cluster. This operation can
also return information for Amazon RDS clusters and Amazon DocDB clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterEndpointIdentifier"`: The identifier of the endpoint to describe. This
parameter is stored as a lowercase string.
- `"DBClusterIdentifier"`: The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
- `"Filters"`: A set of name-value pairs that define which endpoints to include in the
output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of:
db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or
more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can
be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one
or more of: available, creating, deleting, inactive, modifying.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterEndpoints request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbcluster_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBClusterEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbcluster_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusterEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_parameter_groups()
describe_dbcluster_parameter_groups(params::Dict{String,<:Any})
Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB
cluster parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterParameterGroupName"`: The name of a specific DB cluster parameter group to
return details for. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterParameterGroups request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
"""
function describe_dbcluster_parameter_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusterParameterGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbcluster_parameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusterParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_parameters(dbcluster_parameter_group_name)
describe_dbcluster_parameters(dbcluster_parameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular DB cluster parameter group.
# Arguments
- `dbcluster_parameter_group_name`: The name of a specific DB cluster parameter group to
return parameter details for. Constraints: If supplied, must match the name of an
existing DBClusterParameterGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterParameters request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
- `"Source"`: A value that indicates to return only parameters for a specific source.
Parameter sources can be engine, service, or customer.
"""
function describe_dbcluster_parameters(
DBClusterParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusterParameters",
Dict{String,Any}("DBClusterParameterGroupName" => DBClusterParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbcluster_parameters(
DBClusterParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DescribeDBClusterParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_snapshot_attributes(dbcluster_snapshot_identifier)
describe_dbcluster_snapshot_attributes(dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster
snapshot. When sharing snapshots with other Amazon accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the
Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If
all is included in the list of values for the restore attribute, then the manual DB cluster
snapshot is public and can be copied or restored by all Amazon accounts. To add or remove
access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make
the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute
API action.
# Arguments
- `dbcluster_snapshot_identifier`: The identifier for the DB cluster snapshot to describe
the attributes for.
"""
function describe_dbcluster_snapshot_attributes(
DBClusterSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusterSnapshotAttributes",
Dict{String,Any}("DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbcluster_snapshot_attributes(
DBClusterSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DescribeDBClusterSnapshotAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_snapshots()
describe_dbcluster_snapshots(params::Dict{String,<:Any})
Returns information about DB cluster snapshots. This API action supports pagination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: The ID of the DB cluster to retrieve the list of DB cluster
snapshots for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. Constraints:
If supplied, must match the identifier of an existing DBCluster.
- `"DBClusterSnapshotIdentifier"`: A specific DB cluster snapshot identifier to describe.
This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This
value is stored as a lowercase string. Constraints: If supplied, must match the
identifier of an existing DBClusterSnapshot. If this identifier is for an automated
snapshot, the SnapshotType parameter must also be specified.
- `"Filters"`: This parameter is not currently supported.
- `"IncludePublic"`: True to include manual DB cluster snapshots that are public and can be
copied or restored by any Amazon account, and otherwise false. The default is false. The
default is false. You can share a manual DB cluster snapshot as public by using the
ModifyDBClusterSnapshotAttribute API action.
- `"IncludeShared"`: True to include shared manual DB cluster snapshots from other Amazon
accounts that this Amazon account has been given permission to copy or restore, and
otherwise false. The default is false. You can give an Amazon account permission to restore
a manual DB cluster snapshot from another Amazon account by the
ModifyDBClusterSnapshotAttribute API action.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"SnapshotType"`: The type of DB cluster snapshots to be returned. You can specify one of
the following values: automated - Return all DB cluster snapshots that have been
automatically taken by Amazon Neptune for my Amazon account. manual - Return all DB
cluster snapshots that have been taken by my Amazon account. shared - Return all manual
DB cluster snapshots that have been shared to my Amazon account. public - Return all DB
cluster snapshots that have been marked as public. If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include
shared DB cluster snapshots with these results by setting the IncludeShared parameter to
true. You can include public DB cluster snapshots with these results by setting the
IncludePublic parameter to true. The IncludeShared and IncludePublic parameters don't apply
for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply
when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when
SnapshotType is set to public.
"""
function describe_dbcluster_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBClusterSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbcluster_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusterSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbclusters()
describe_dbclusters(params::Dict{String,<:Any})
Returns information about provisioned DB clusters, and supports pagination. This operation
can also return information for Amazon RDS clusters and Amazon DocDB clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: The user-supplied DB cluster identifier. If this parameter is
specified, information from only the specific DB cluster is returned. This parameter isn't
case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier.
- `"Filters"`: A filter that specifies one or more DB clusters to describe. Supported
filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource
Names (ARNs). The results list will only include information about the DB clusters
identified by these ARNs. engine - Accepts an engine name (such as neptune), and
restricts the results list to DB clusters created by that engine. For example, to invoke
this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you
could use the following command:
- `"Marker"`: An optional pagination token provided by a previous DescribeDBClusters
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbclusters(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbclusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_dbengine_versions()
describe_dbengine_versions(params::Dict{String,<:Any})
Returns a list of the available DB engines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBParameterGroupFamily"`: The name of a specific DB parameter group family to return
details for. Constraints: If supplied, must match an existing DBParameterGroupFamily.
- `"DefaultOnly"`: Indicates that only the default version of the specified engine or
engine and major version combination is returned.
- `"Engine"`: The database engine to return.
- `"EngineVersion"`: The database engine version to return. Example: 5.1.49
- `"Filters"`: Not currently supported.
- `"ListSupportedCharacterSets"`: If this parameter is specified and the requested engine
supports the CharacterSetName parameter for CreateDBInstance, the response includes a list
of supported character sets for each engine version.
- `"ListSupportedTimezones"`: If this parameter is specified and the requested engine
supports the TimeZone parameter for CreateDBInstance, the response includes a list of
supported time zones for each engine version.
- `"Marker"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the marker, up to the
value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more than
the MaxRecords value is available, a pagination token called a marker is included in the
response so that the following results can be retrieved. Default: 100 Constraints: Minimum
20, maximum 100.
"""
function describe_dbengine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBEngineVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbengine_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbinstances()
describe_dbinstances(params::Dict{String,<:Any})
Returns information about provisioned instances, and supports pagination. This operation
can also return information for Amazon RDS instances and Amazon DocDB instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceIdentifier"`: The user-supplied instance identifier. If this parameter is
specified, information from only the specific DB instance is returned. This parameter isn't
case-sensitive. Constraints: If supplied, must match the identifier of an existing
DBInstance.
- `"Filters"`: A filter that specifies one or more DB instances to describe. Supported
filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource
Names (ARNs). The results list will only include information about the DB instances
associated with the DB clusters identified by these ARNs. engine - Accepts an engine
name (such as neptune), and restricts the results list to DB instances created by that
engine. For example, to invoke this API from the Amazon CLI and filter so that only
Neptune DB instances are returned, you could use the following command:
- `"Marker"`: An optional pagination token provided by a previous DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
"""
function describe_dbinstances(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbinstances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbparameter_groups()
describe_dbparameter_groups(params::Dict{String,<:Any})
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,
the list will contain only the description of the specified DB parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBParameterGroupName"`: The name of a specific DB parameter group to return details
for. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBParameterGroups
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbparameter_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBParameterGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbparameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbparameters(dbparameter_group_name)
describe_dbparameters(dbparameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular DB parameter group.
# Arguments
- `dbparameter_group_name`: The name of a specific DB parameter group to return details
for. Constraints: If supplied, must match the name of an existing DBParameterGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBParameters
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"Source"`: The parameter types to return. Default: All parameter types returned Valid
Values: user | system | engine-default
"""
function describe_dbparameters(
DBParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBParameters",
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbparameters(
DBParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DescribeDBParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbsubnet_groups()
describe_dbsubnet_groups(params::Dict{String,<:Any})
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list
will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR
ranges, go to the Wikipedia Tutorial.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSubnetGroupName"`: The name of the DB subnet group to return details for.
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBSubnetGroups
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
"""
function describe_dbsubnet_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeDBSubnetGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbsubnet_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeDBSubnetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_engine_default_cluster_parameters(dbparameter_group_family)
describe_engine_default_cluster_parameters(dbparameter_group_family, params::Dict{String,<:Any})
Returns the default engine and system parameter information for the cluster database engine.
# Arguments
- `dbparameter_group_family`: The name of the DB cluster parameter group family to return
engine parameter information for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeEngineDefaultClusterParameters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
"""
function describe_engine_default_cluster_parameters(
DBParameterGroupFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeEngineDefaultClusterParameters",
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_engine_default_cluster_parameters(
DBParameterGroupFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DescribeEngineDefaultClusterParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_engine_default_parameters(dbparameter_group_family)
describe_engine_default_parameters(dbparameter_group_family, params::Dict{String,<:Any})
Returns the default engine and system parameter information for the specified database
engine.
# Arguments
- `dbparameter_group_family`: The name of the DB parameter group family.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Not currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeEngineDefaultParameters request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
"""
function describe_engine_default_parameters(
DBParameterGroupFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeEngineDefaultParameters",
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_engine_default_parameters(
DBParameterGroupFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DescribeEngineDefaultParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_categories()
describe_event_categories(params::Dict{String,<:Any})
Displays a list of categories for all event source types, or, if specified, for a specified
source type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter is not currently supported.
- `"SourceType"`: The type of source that is generating the events. Valid values:
db-instance | db-parameter-group | db-security-group | db-snapshot
"""
function describe_event_categories(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeEventCategories"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_event_categories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeEventCategories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_subscriptions()
describe_event_subscriptions(params::Dict{String,<:Any})
Lists all the subscription descriptions for a customer account. The description for a
subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID,
CreationTime, and Status. If you specify a SubscriptionName, lists the description for that
subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords .
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
- `"SubscriptionName"`: The name of the event notification subscription you want to
describe.
"""
function describe_event_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeEventSubscriptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_event_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeEventSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter
groups for the past 14 days. Events specific to a particular DB instance, DB security
group, database snapshot, or DB parameter group can be obtained by providing the name as a
parameter. By default, the past hour of events are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The number of minutes to retrieve events for. Default: 60
- `"EndTime"`: The end of the time interval for which to retrieve events, specified in ISO
8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
- `"EventCategories"`: A list of event categories that trigger notifications for a event
notification subscription.
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeEvents request.
If this parameter is specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
- `"SourceIdentifier"`: The identifier of the event source for which events are returned.
If not specified, then all sources are included in the response. Constraints: If
SourceIdentifier is supplied, SourceType must also be provided. If the source type is
DBInstance, then a DBInstanceIdentifier must be supplied. If the source type is
DBSecurityGroup, a DBSecurityGroupName must be supplied. If the source type is
DBParameterGroup, a DBParameterGroupName must be supplied. If the source type is
DBSnapshot, a DBSnapshotIdentifier must be supplied. Cannot end with a hyphen or contain
two consecutive hyphens.
- `"SourceType"`: The event source to retrieve events for. If no value is specified, all
events are returned.
- `"StartTime"`: The beginning of the time interval to retrieve events for, specified in
ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune("DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_global_clusters()
describe_global_clusters(params::Dict{String,<:Any})
Returns information about Neptune global database clusters. This API supports pagination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GlobalClusterIdentifier"`: The user-supplied DB cluster identifier. If this parameter
is specified, only information about the specified DB cluster is returned. This parameter
is not case-sensitive. Constraints: If supplied, must match an existing DB cluster
identifier.
- `"Marker"`: (Optional) A pagination token returned by a previous call to
DescribeGlobalClusters. If this parameter is specified, the response will only include
records beyond the marker, up to the number specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination marker token is included in the
response that you can use to retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_global_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"DescribeGlobalClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_global_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeGlobalClusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_orderable_dbinstance_options(engine)
describe_orderable_dbinstance_options(engine, params::Dict{String,<:Any})
Returns a list of orderable DB instance options for the specified engine.
# Arguments
- `engine`: The name of the engine to retrieve DB instance options for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceClass"`: The DB instance class filter value. Specify this parameter to show
only the available offerings matching the specified DB instance class.
- `"EngineVersion"`: The engine version filter value. Specify this parameter to show only
the available offerings matching the specified engine version.
- `"Filters"`: This parameter is not currently supported.
- `"LicenseModel"`: The license model filter value. Specify this parameter to show only the
available offerings matching the specified license model.
- `"Marker"`: An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords .
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
- `"Vpc"`: The VPC filter value. Specify this parameter to show only the available VPC or
non-VPC offerings.
"""
function describe_orderable_dbinstance_options(
Engine; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeOrderableDBInstanceOptions",
Dict{String,Any}("Engine" => Engine);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_orderable_dbinstance_options(
Engine, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeOrderableDBInstanceOptions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Engine" => Engine), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pending_maintenance_actions()
describe_pending_maintenance_actions(params::Dict{String,<:Any})
Returns a list of resources (for example, DB instances) that have at least one pending
maintenance action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A filter that specifies one or more resources to return pending maintenance
actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB
cluster Amazon Resource Names (ARNs). The results list will only include pending
maintenance actions for the DB clusters identified by these ARNs. db-instance-id -
Accepts DB instance identifiers and DB instance ARNs. The results list will only include
pending maintenance actions for the DB instances identified by these ARNs.
- `"Marker"`: An optional pagination token provided by a previous
DescribePendingMaintenanceActions request. If this parameter is specified, the response
includes only records beyond the marker, up to a number of records specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token called a marker is
included in the response so that the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
- `"ResourceIdentifier"`: The ARN of a resource to return pending maintenance actions for.
"""
function describe_pending_maintenance_actions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribePendingMaintenanceActions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pending_maintenance_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribePendingMaintenanceActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_valid_dbinstance_modifications(dbinstance_identifier)
describe_valid_dbinstance_modifications(dbinstance_identifier, params::Dict{String,<:Any})
You can call DescribeValidDBInstanceModifications to learn what modifications you can make
to your DB instance. You can use this information when you call ModifyDBInstance.
# Arguments
- `dbinstance_identifier`: The customer identifier or the ARN of your DB instance.
"""
function describe_valid_dbinstance_modifications(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"DescribeValidDBInstanceModifications",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_valid_dbinstance_modifications(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"DescribeValidDBInstanceModifications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
failover_dbcluster()
failover_dbcluster(params::Dict{String,<:Any})
Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read
Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster
writer). Amazon Neptune will automatically fail over to a Read Replica, if one exists, when
the primary instance fails. You can force a failover when you want to simulate a failure of
a primary instance for testing. Because each instance in a DB cluster has its own endpoint
address, you will need to clean up and re-establish any existing connections that use those
endpoint addresses when the failover is complete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: A DB cluster identifier to force a failover for. This parameter
is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
- `"TargetDBInstanceIdentifier"`: The name of the instance to promote to the primary
instance. You must specify the instance identifier for an Read Replica in the DB cluster.
For example, mydbcluster-replica1.
"""
function failover_dbcluster(; aws_config::AbstractAWSConfig=global_aws_config())
return neptune(
"FailoverDBCluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function failover_dbcluster(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"FailoverDBCluster", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
failover_global_cluster(global_cluster_identifier, target_db_cluster_identifier)
failover_global_cluster(global_cluster_identifier, target_db_cluster_identifier, params::Dict{String,<:Any})
Initiates the failover process for a Neptune global database. A failover for a Neptune
global database promotes one of secondary read-only DB clusters to be the primary DB
cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In
other words, the role of the current primary DB cluster and the selected target secondary
DB cluster are switched. The selected secondary DB cluster assumes full read/write
capabilities for the Neptune global database. This action applies only to Neptune global
databases. This action is only intended for use on healthy Neptune global databases with
healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios
or to reconfigure the global database topology.
# Arguments
- `global_cluster_identifier`: Identifier of the Neptune global database that should be
failed over. The identifier is the unique key assigned by the user when the Neptune global
database was created. In other words, it's the name of the global database that you want to
fail over. Constraints: Must match the identifier of an existing Neptune global database.
- `target_db_cluster_identifier`: The Amazon Resource Name (ARN) of the secondary Neptune
DB cluster that you want to promote to primary for the global database.
"""
function failover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"FailoverGlobalCluster",
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function failover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"FailoverGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_name)
list_tags_for_resource(resource_name, params::Dict{String,<:Any})
Lists all tags on an Amazon Neptune resource.
# Arguments
- `resource_name`: The Amazon Neptune resource with tags to be listed. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an
Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter is not currently supported.
"""
function list_tags_for_resource(
ResourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ListTagsForResource",
Dict{String,Any}("ResourceName" => ResourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceName" => ResourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster(dbcluster_identifier)
modify_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Modify a setting for a DB cluster. You can change one or more database configuration
parameters by specifying these parameters and the new values in the request.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier for the cluster being modified. This
parameter is not case-sensitive. Constraints: Must match the identifier of an existing
DBCluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowMajorVersionUpgrade"`: A value that indicates whether upgrades between different
major versions are allowed. Constraints: You must set the allow-major-version-upgrade flag
when providing an EngineVersion parameter that uses a different major version than the DB
cluster's current version.
- `"ApplyImmediately"`: A value that specifies whether the modifications in this request
and any pending modifications are asynchronously applied as soon as possible, regardless of
the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to
false, changes to the DB cluster are applied during the next maintenance window. The
ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the
ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values
are applied during the next maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately parameter. Default: false
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to
35
- `"CloudwatchLogsExportConfiguration"`: The configuration setting for the log types to be
enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to
publish Neptune audit logs to CloudWatch Logs.
- `"CopyTagsToSnapshot"`: If set to true, tags are copied to any snapshot of the DB
cluster that is created.
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to use for
the DB cluster.
- `"DBInstanceParameterGroupName"`: The name of the DB parameter group to apply to all
instances of the DB cluster. When you apply a parameter group using
DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance
window but instead are applied immediately. Default: The existing name setting
Constraints: The DB parameter group must be in the same DB parameter group family as the
target DB cluster version. The DBInstanceParameterGroupName parameter is only valid in
combination with the AllowMajorVersionUpgrade parameter.
- `"DeletionProtection"`: A value that indicates whether the DB cluster has deletion
protection enabled. The database can't be deleted when deletion protection is enabled. By
default, deletion protection is disabled.
- `"EnableIAMDatabaseAuthentication"`: True to enable mapping of Amazon Identity and Access
Management (IAM) accounts to database accounts, and otherwise false. Default: false
- `"EngineVersion"`: The version number of the database engine to which you want to
upgrade. Changing this parameter results in an outage. The change is applied during the
next maintenance window unless the ApplyImmediately parameter is set to true. For a list of
valid engine versions, see Engine Releases for Amazon Neptune, or call
DescribeDBEngineVersions.
- `"MasterUserPassword"`: Not supported by Neptune.
- `"NewDBClusterIdentifier"`: The new DB cluster identifier for the DB cluster when
renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must
contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster2
- `"OptionGroupName"`: Not supported by Neptune.
- `"Port"`: The port number on which the DB cluster accepts connections. Constraints: Value
must be 1150-65535 Default: The same port as the original DB cluster.
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled, using the BackupRetentionPeriod parameter. The
default is a 30-minute window selected at random from an 8-hour block of time for each
Amazon Region. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal
Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must
be at least 30 minutes.
- `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is
a 30-minute window selected at random from an 8-hour block of time for each Amazon Region,
occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
- `"ServerlessV2ScalingConfiguration"`: Contains the scaling configuration of a Neptune
Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
- `"StorageType"`: The storage type to associate with the DB cluster. Valid Values:
standard | iopt1 Default: standard
- `"VpcSecurityGroupIds"`: A list of VPC security groups that the DB cluster will belong to.
"""
function modify_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster_endpoint(dbcluster_endpoint_identifier)
modify_dbcluster_endpoint(dbcluster_endpoint_identifier, params::Dict{String,<:Any})
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
# Arguments
- `dbcluster_endpoint_identifier`: The identifier of the endpoint to modify. This parameter
is stored as a lowercase string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointType"`: The type of the endpoint. One of: READER, WRITER, ANY.
- `"ExcludedMembers"`: List of DB instance identifiers that aren't part of the custom
endpoint group. All other eligible instances are reachable through the custom endpoint.
Only relevant if the list of static members is empty.
- `"StaticMembers"`: List of DB instance identifiers that are part of the custom endpoint
group.
"""
function modify_dbcluster_endpoint(
DBClusterEndpointIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyDBClusterEndpoint",
Dict{String,Any}("DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbcluster_endpoint(
DBClusterEndpointIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBClusterEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster_parameter_group(dbcluster_parameter_group_name, parameter)
modify_dbcluster_parameter_group(dbcluster_parameter_group_name, parameter, params::Dict{String,<:Any})
Modifies the parameters of a DB cluster parameter group. To modify more than one
parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod.
A maximum of 20 parameters can be modified in a single request. Changes to dynamic
parameters are applied immediately. Changes to static parameters require a reboot without
failover to the DB cluster associated with the parameter group before the change can take
effect. After you create a DB cluster parameter group, you should wait at least 5 minutes
before creating your first DB cluster that uses that DB cluster parameter group as the
default parameter group. This allows Amazon Neptune to fully complete the create action
before the parameter group is used as the default for a new DB cluster. This is especially
important for parameters that are critical when creating the default database for a DB
cluster, such as the character set for the default database defined by the
character_set_database parameter. You can use the Parameter Groups option of the Amazon
Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster
parameter group has been created or modified.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group to modify.
- `parameter`: A list of parameters in the DB cluster parameter group to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: A list of parameters in the DB cluster parameter group to modify.
"""
function modify_dbcluster_parameter_group(
DBClusterParameterGroupName,
Parameter;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBClusterParameterGroup",
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName,
"Parameter" => Parameter,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbcluster_parameter_group(
DBClusterParameterGroupName,
Parameter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName,
"Parameter" => Parameter,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster_snapshot_attribute(attribute_name, dbcluster_snapshot_identifier)
modify_dbcluster_snapshot_attribute(attribute_name, dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Adds an attribute and values to, or removes an attribute and values from, a manual DB
cluster snapshot. To share a manual DB cluster snapshot with other Amazon accounts, specify
restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the
Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the
value all to make the manual DB cluster snapshot public, which means that it can be copied
or restored by all Amazon accounts. Do not add the all value for any manual DB cluster
snapshots that contain private information that you don't want available to all Amazon
accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by
specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't
use all as a value for that parameter in this case. To view which Amazon accounts have
access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster
snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
# Arguments
- `attribute_name`: The name of the DB cluster snapshot attribute to modify. To manage
authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot,
set this value to restore.
- `dbcluster_snapshot_identifier`: The identifier for the DB cluster snapshot to modify the
attributes for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ValuesToAdd"`: A list of DB cluster snapshot attributes to add to the attribute
specified by AttributeName. To authorize other Amazon accounts to copy or restore a manual
DB cluster snapshot, set this list to include one or more Amazon account IDs, or all to
make the manual DB cluster snapshot restorable by any Amazon account. Do not add the all
value for any manual DB cluster snapshots that contain private information that you don't
want available to all Amazon accounts.
- `"ValuesToRemove"`: A list of DB cluster snapshot attributes to remove from the attribute
specified by AttributeName. To remove authorization for other Amazon accounts to copy or
restore a manual DB cluster snapshot, set this list to include one or more Amazon account
identifiers, or all to remove authorization for any Amazon account to copy or restore the
DB cluster snapshot. If you specify all, an Amazon account whose account ID is explicitly
added to the restore attribute can still copy or restore a manual DB cluster snapshot.
"""
function modify_dbcluster_snapshot_attribute(
AttributeName,
DBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBClusterSnapshotAttribute",
Dict{String,Any}(
"AttributeName" => AttributeName,
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbcluster_snapshot_attribute(
AttributeName,
DBClusterSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBClusterSnapshotAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeName" => AttributeName,
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbinstance(dbinstance_identifier)
modify_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
Modifies settings for a DB instance. You can change one or more database configuration
parameters by specifying these parameters and the new values in the request. To learn what
modifications you can make to your DB instance, call DescribeValidDBInstanceModifications
before you call ModifyDBInstance.
# Arguments
- `dbinstance_identifier`: The DB instance identifier. This value is stored as a lowercase
string. Constraints: Must match the identifier of an existing DBInstance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: Not supported by Neptune.
- `"AllowMajorVersionUpgrade"`: Indicates that major version upgrades are allowed. Changing
this parameter doesn't result in an outage and the change is asynchronously applied as soon
as possible.
- `"ApplyImmediately"`: Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB instance. If this parameter is set to false,
changes to the DB instance are applied during the next maintenance window. Some parameter
changes can cause an outage and are applied on the next call to RebootDBInstance, or the
next failure reboot. Default: false
- `"AutoMinorVersionUpgrade"`: Indicates that minor version upgrades are applied
automatically to the DB instance during the maintenance window. Changing this parameter
doesn't result in an outage except in the following case and the change is asynchronously
applied as soon as possible. An outage will result if this parameter is set to true during
the maintenance window, and a newer minor version is available, and Neptune has enabled
auto patching for that engine version.
- `"BackupRetentionPeriod"`: Not applicable. The retention period for automated backups is
managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses
existing setting
- `"CACertificateIdentifier"`: Indicates the certificate that needs to be associated with
the instance.
- `"CloudwatchLogsExportConfiguration"`: The configuration setting for the log types to be
enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
- `"CopyTagsToSnapshot"`: True to copy all tags from the DB instance to snapshots of the DB
instance, and otherwise false. The default is false.
- `"DBInstanceClass"`: The new compute and memory capacity of the DB instance, for example,
db.m4.large. Not all DB instance classes are available in all Amazon Regions. If you modify
the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting
- `"DBParameterGroupName"`: The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is
changed immediately, but the actual parameter changes are not applied until you reboot the
instance without failover. The db instance will NOT be rebooted automatically and the
parameter changes will NOT be applied during the next maintenance window. Default: Uses
existing setting Constraints: The DB parameter group must be in the same DB parameter group
family as this DB instance.
- `"DBPortNumber"`: The port number on which the database accepts connections. The value of
the DBPortNumber parameter must not match any of the port values specified for options in
the option group for the DB instance. Your database will restart when you change the
DBPortNumber value regardless of the value of the ApplyImmediately parameter. Default:
8182
- `"DBSecurityGroups"`: A list of DB security groups to authorize on this DB instance.
Changing this setting doesn't result in an outage and the change is asynchronously applied
as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups.
- `"DBSubnetGroupName"`: The new DB subnet group for the DB instance. You can use this
parameter to move your DB instance to a different VPC. Changing the subnet group causes an
outage during the change. The change is applied during the next maintenance window, unless
you specify true for the ApplyImmediately parameter. Constraints: If supplied, must match
the name of an existing DBSubnetGroup. Example: mySubnetGroup
- `"DeletionProtection"`: A value that indicates whether the DB instance has deletion
protection enabled. The database can't be deleted when deletion protection is enabled. By
default, deletion protection is disabled. See Deleting a DB Instance.
- `"Domain"`: Not supported.
- `"DomainIAMRoleName"`: Not supported
- `"EnableIAMDatabaseAuthentication"`: True to enable mapping of Amazon Identity and Access
Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM
database authentication for the following database engines Not applicable. Mapping Amazon
IAM accounts to database accounts is managed by the DB cluster. For more information, see
ModifyDBCluster. Default: false
- `"EnablePerformanceInsights"`: (Not supported by Neptune)
- `"EngineVersion"`: The version number of the database engine to upgrade to. Currently,
setting this parameter has no effect. To upgrade your database engine to the most recent
release, use the ApplyPendingMaintenanceAction API.
- `"Iops"`: The new Provisioned IOPS (I/O operations per second) value for the instance.
Changing this setting doesn't result in an outage and the change is applied during the next
maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
- `"LicenseModel"`: Not supported by Neptune.
- `"MasterUserPassword"`: Not supported by Neptune.
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting Enhanced Monitoring
metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also
set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
- `"MonitoringRoleArn"`: The ARN for the IAM role that permits Neptune to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value other than
0, then you must supply a MonitoringRoleArn value.
- `"MultiAZ"`: Specifies if the DB instance is a Multi-AZ deployment. Changing this
parameter doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately parameter is set to true for this request.
- `"NewDBInstanceIdentifier"`: The new DB instance identifier for the DB instance when
renaming a DB instance. When you change the DB instance identifier, an instance reboot will
occur immediately if you set Apply Immediately to true, or will occur during the next
maintenance window if Apply Immediately to false. This value is stored as a lowercase
string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first
character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
- `"OptionGroupName"`: (Not supported by Neptune)
- `"PerformanceInsightsKMSKeyId"`: (Not supported by Neptune)
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled. Not applicable. The daily time range for creating
automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints: Must be in the format hh24:mi-hh24:mi Must be in Universal Time
Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at
least 30 minutes
- `"PreferredMaintenanceWindow"`: The weekly time range (in UTC) during which system
maintenance can occur, which might result in an outage. Changing this parameter doesn't
result in an outage, except in the following situation, and the change is asynchronously
applied as soon as possible. If there are pending actions that cause a reboot, and the
maintenance window is changed to include the current time, then changing this parameter
will cause a reboot of the DB instance. If moving this window to the current time, there
must be at least 30 minutes between the current time and end of the window to ensure
pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes
- `"PromotionTier"`: A value that specifies the order in which a Read Replica is promoted
to the primary instance after a failure of the existing primary instance. Default: 1 Valid
Values: 0 - 15
- `"PubliclyAccessible"`: This flag should no longer be used.
- `"StorageType"`: Not supported.
- `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for
TDE encryption.
- `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to
access the device.
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to authorize on this DB
instance. This change is asynchronously applied as soon as possible. Not applicable. The
associated list of EC2 VPC security groups is managed by the DB cluster. For more
information, see ModifyDBCluster. Constraints: If supplied, must match existing
VpcSecurityGroupIds.
"""
function modify_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyDBInstance",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbinstance(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbparameter_group(dbparameter_group_name, parameter)
modify_dbparameter_group(dbparameter_group_name, parameter, params::Dict{String,<:Any})
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit
a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request. Changes to dynamic parameters are applied
immediately. Changes to static parameters require a reboot without failover to the DB
instance associated with the parameter group before the change can take effect. After you
modify a DB parameter group, you should wait at least 5 minutes before creating your first
DB instance that uses that DB parameter group as the default parameter group. This allows
Amazon Neptune to fully complete the modify action before the parameter group is used as
the default for a new DB instance. This is especially important for parameters that are
critical when creating the default database for a DB instance, such as the character set
for the default database defined by the character_set_database parameter. You can use the
Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command
to verify that your DB parameter group has been created or modified.
# Arguments
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: If supplied,
must match the name of an existing DBParameterGroup.
- `parameter`: An array of parameter names, values, and the apply method for the parameter
update. At least one parameter name, value, and apply method must be supplied; subsequent
arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot You can use the
immediate value with dynamic parameters only. You can use the pending-reboot value for both
dynamic and static parameters, and changes are applied when you reboot the DB instance
without failover.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: An array of parameter names, values, and the apply method for the
parameter update. At least one parameter name, value, and apply method must be supplied;
subsequent arguments are optional. A maximum of 20 parameters can be modified in a single
request. Valid Values (for the application method): immediate | pending-reboot You can
use the immediate value with dynamic parameters only. You can use the pending-reboot value
for both dynamic and static parameters, and changes are applied when you reboot the DB
instance without failover.
"""
function modify_dbparameter_group(
DBParameterGroupName, Parameter; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyDBParameterGroup",
Dict{String,Any}(
"DBParameterGroupName" => DBParameterGroupName, "Parameter" => Parameter
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbparameter_group(
DBParameterGroupName,
Parameter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBParameterGroupName" => DBParameterGroupName, "Parameter" => Parameter
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbsubnet_group(dbsubnet_group_name, subnet_identifier)
modify_dbsubnet_group(dbsubnet_group_name, subnet_identifier, params::Dict{String,<:Any})
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in
at least two AZs in the Amazon Region.
# Arguments
- `dbsubnet_group_name`: The name for the DB subnet group. This value is stored as a
lowercase string. You can't modify the default subnet group. Constraints: Must match the
name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
- `subnet_identifier`: The EC2 subnet IDs for the DB subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSubnetGroupDescription"`: The description for the DB subnet group.
- `"SubnetIds"`: The EC2 subnet IDs for the DB subnet group.
"""
function modify_dbsubnet_group(
DBSubnetGroupName, SubnetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyDBSubnetGroup",
Dict{String,Any}(
"DBSubnetGroupName" => DBSubnetGroupName, "SubnetIdentifier" => SubnetIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbsubnet_group(
DBSubnetGroupName,
SubnetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyDBSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBSubnetGroupName" => DBSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_event_subscription(subscription_name)
modify_event_subscription(subscription_name, params::Dict{String,<:Any})
Modifies an existing event notification subscription. Note that you can't modify the source
identifiers using this call; to change source identifiers for a subscription, use the
AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can
see a list of the event categories for a given SourceType by using the
DescribeEventCategories action.
# Arguments
- `subscription_name`: The name of the event notification subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: A Boolean value; set to true to activate the subscription.
- `"EventCategories"`: A list of event categories for a SourceType that you want to
subscribe to. You can see a list of the categories for a given SourceType by using the
DescribeEventCategories action.
- `"SnsTopicArn"`: The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
- `"SourceType"`: The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would set this parameter to
db-instance. if this value is not specified, all events are returned. Valid values:
db-instance | db-parameter-group | db-security-group | db-snapshot
"""
function modify_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyEventSubscription",
Dict{String,Any}("SubscriptionName" => SubscriptionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_event_subscription(
SubscriptionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_global_cluster(global_cluster_identifier)
modify_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})
Modify a setting for an Amazon Neptune global cluster. You can change one or more database
configuration parameters by specifying these parameters and their new values in the request.
# Arguments
- `global_cluster_identifier`: The DB cluster identifier for the global cluster being
modified. This parameter is not case-sensitive. Constraints: Must match the identifier of
an existing global database cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowMajorVersionUpgrade"`: A value that indicates whether major version upgrades are
allowed. Constraints: You must allow major version upgrades if you specify a value for the
EngineVersion parameter that is a different major version than the DB cluster's current
version. If you upgrade the major version of a global database, the cluster and DB instance
parameter groups are set to the default parameter groups for the new version, so you will
need to apply any custom parameter groups after completing the upgrade.
- `"DeletionProtection"`: Indicates whether the global database has deletion protection
enabled. The global database cannot be deleted when deletion protection is enabled.
- `"EngineVersion"`: The version number of the database engine to which you want to
upgrade. Changing this parameter will result in an outage. The change is applied during the
next maintenance window unless ApplyImmediately is enabled. To list all of the available
Neptune engine versions, use the following command:
- `"NewGlobalClusterIdentifier"`: A new cluster identifier to assign to the global
database. This value is stored as a lowercase string. Constraints: Must contain from 1 to
63 letters, numbers, or hyphens. The first character must be a letter. Can't end with a
hyphen or contain two consecutive hyphens Example: my-cluster2
"""
function modify_global_cluster(
GlobalClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ModifyGlobalCluster",
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_global_cluster(
GlobalClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ModifyGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
promote_read_replica_dbcluster(dbcluster_identifier)
promote_read_replica_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Not supported.
# Arguments
- `dbcluster_identifier`: Not supported.
"""
function promote_read_replica_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"PromoteReadReplicaDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function promote_read_replica_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"PromoteReadReplicaDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_dbinstance(dbinstance_identifier)
reboot_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
You might need to reboot your DB instance, usually for maintenance reasons. For example, if
you make certain modifications, or if you change the DB parameter group associated with the
DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB
instance restarts the database engine service. Rebooting a DB instance results in a
momentary outage, during which the DB instance status is set to rebooting.
# Arguments
- `dbinstance_identifier`: The DB instance identifier. This parameter is stored as a
lowercase string. Constraints: Must match the identifier of an existing DBInstance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceFailover"`: When true, the reboot is conducted through a MultiAZ failover.
Constraint: You can't specify true if the instance is not configured for MultiAZ.
"""
function reboot_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"RebootDBInstance",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_dbinstance(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RebootDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_from_global_cluster(db_cluster_identifier, global_cluster_identifier)
remove_from_global_cluster(db_cluster_identifier, global_cluster_identifier, params::Dict{String,<:Any})
Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a
normal standalone cluster with read-write capability instead of being read-only, and no
longer receives data from a the primary cluster.
# Arguments
- `db_cluster_identifier`: The Amazon Resource Name (ARN) identifying the cluster to be
detached from the Neptune global database cluster.
- `global_cluster_identifier`: The identifier of the Neptune global database from which to
detach the specified Neptune DB cluster.
"""
function remove_from_global_cluster(
DbClusterIdentifier,
GlobalClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RemoveFromGlobalCluster",
Dict{String,Any}(
"DbClusterIdentifier" => DbClusterIdentifier,
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_from_global_cluster(
DbClusterIdentifier,
GlobalClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RemoveFromGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DbClusterIdentifier" => DbClusterIdentifier,
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_role_from_dbcluster(dbcluster_identifier, role_arn)
remove_role_from_dbcluster(dbcluster_identifier, role_arn, params::Dict{String,<:Any})
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to disassociate the IAM role from.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB
cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureName"`: The name of the feature for the DB cluster that the IAM role is to be
disassociated from. For the list of supported feature names, see DescribeDBEngineVersions.
"""
function remove_role_from_dbcluster(
DBClusterIdentifier, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"RemoveRoleFromDBCluster",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_role_from_dbcluster(
DBClusterIdentifier,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RemoveRoleFromDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_source_identifier_from_subscription(source_identifier, subscription_name)
remove_source_identifier_from_subscription(source_identifier, subscription_name, params::Dict{String,<:Any})
Removes a source identifier from an existing event notification subscription.
# Arguments
- `source_identifier`: The source identifier to be removed from the subscription, such as
the DB instance identifier for a DB instance or the name of a security group.
- `subscription_name`: The name of the event notification subscription you want to remove a
source identifier from.
"""
function remove_source_identifier_from_subscription(
SourceIdentifier, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"RemoveSourceIdentifierFromSubscription",
Dict{String,Any}(
"SourceIdentifier" => SourceIdentifier, "SubscriptionName" => SubscriptionName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_source_identifier_from_subscription(
SourceIdentifier,
SubscriptionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RemoveSourceIdentifierFromSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceIdentifier" => SourceIdentifier,
"SubscriptionName" => SubscriptionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags_from_resource(resource_name, tag_keys)
remove_tags_from_resource(resource_name, tag_keys, params::Dict{String,<:Any})
Removes metadata tags from an Amazon Neptune resource.
# Arguments
- `resource_name`: The Amazon Neptune resource that the tags are removed from. This value
is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing
an Amazon Resource Name (ARN).
- `tag_keys`: The tag key (name) of the tag to be removed.
"""
function remove_tags_from_resource(
ResourceName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"RemoveTagsFromResource",
Dict{String,Any}("ResourceName" => ResourceName, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags_from_resource(
ResourceName,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RemoveTagsFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_dbcluster_parameter_group(dbcluster_parameter_group_name)
reset_dbcluster_parameter_group(dbcluster_parameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a DB cluster parameter group to the default value. To reset
specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset
the entire DB cluster parameter group, specify the DBClusterParameterGroupName and
ResetAllParameters parameters. When resetting the entire group, dynamic parameters are
updated immediately and static parameters are set to pending-reboot to take effect on the
next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for
every DB instance in your DB cluster that you want the updated static parameter to apply to.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group to reset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: A list of parameter names in the DB cluster parameter group to reset to
the default values. You can't use this parameter if the ResetAllParameters parameter is set
to true.
- `"ResetAllParameters"`: A value that is set to true to reset all parameters in the DB
cluster parameter group to their default values, and false otherwise. You can't use this
parameter if there is a list of parameter names specified for the Parameters parameter.
"""
function reset_dbcluster_parameter_group(
DBClusterParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ResetDBClusterParameterGroup",
Dict{String,Any}("DBClusterParameterGroupName" => DBClusterParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_dbcluster_parameter_group(
DBClusterParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ResetDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_dbparameter_group(dbparameter_group_name)
reset_dbparameter_group(dbparameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a DB parameter group to the engine/system default value. To
reset specific parameters, provide a list of the following: ParameterName and ApplyMethod.
To reset the entire DB parameter group, specify the DBParameterGroup name and
ResetAllParameters parameters. When resetting the entire group, dynamic parameters are
updated immediately and static parameters are set to pending-reboot to take effect on the
next DB instance restart or RebootDBInstance request.
# Arguments
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must match
the name of an existing DBParameterGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: To reset the entire DB parameter group, specify the DBParameterGroup name
and ResetAllParameters parameters. To reset specific parameters, provide a list of the
following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a
single request. Valid Values (for Apply method): pending-reboot
- `"ResetAllParameters"`: Specifies whether (true) or not (false) to reset all parameters
in the DB parameter group to default values. Default: true
"""
function reset_dbparameter_group(
DBParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"ResetDBParameterGroup",
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_dbparameter_group(
DBParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"ResetDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbcluster_from_snapshot(dbcluster_identifier, engine, snapshot_identifier)
restore_dbcluster_from_snapshot(dbcluster_identifier, engine, snapshot_identifier, params::Dict{String,<:Any})
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is
specified, the target DB cluster is created from the source DB snapshot with a default
configuration and default security group. If a DB cluster snapshot is specified, the target
DB cluster is created from the source DB cluster restore point with the same configuration
as the original source DB cluster, except that the new DB cluster is created with the
default security group.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to create from the DB snapshot or DB
cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1
to 63 letters, numbers, or hyphens First character must be a letter Cannot end with a
hyphen or contain two consecutive hyphens Example: my-snapshot-id
- `engine`: The database engine to use for the new DB cluster. Default: The same as source
Constraint: Must be compatible with the engine of the source
- `snapshot_identifier`: The identifier for the DB snapshot or DB cluster snapshot to
restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB
cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints:
Must match the identifier of an existing Snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
- `"CopyTagsToSnapshot"`: If set to true, tags are copied to any snapshot of the restored
DB cluster that is created.
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with the new DB cluster. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"DBSubnetGroupName"`: The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:
mySubnetgroup
- `"DatabaseName"`: Not supported.
- `"DeletionProtection"`: A value that indicates whether the DB cluster has deletion
protection enabled. The database can't be deleted when deletion protection is enabled. By
default, deletion protection is disabled.
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB cluster is to
export to Amazon CloudWatch Logs.
- `"EnableIAMDatabaseAuthentication"`: True to enable mapping of Amazon Identity and Access
Management (IAM) accounts to database accounts, and otherwise false. Default: false
- `"EngineVersion"`: The version of the database engine to use for the new DB cluster.
- `"KmsKeyId"`: The Amazon KMS key identifier to use when restoring an encrypted DB cluster
from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource
Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same
Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then
you can use the KMS key alias instead of the ARN for the KMS encryption key. If you do not
specify a value for the KmsKeyId parameter, then the following will occur: If the DB
snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB
cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not
encrypted, then the restored DB cluster is not encrypted.
- `"OptionGroupName"`: (Not supported by Neptune)
- `"Port"`: The port number on which the new DB cluster accepts connections. Constraints:
Value must be 1150-65535 Default: The same port as the original DB cluster.
- `"ServerlessV2ScalingConfiguration"`: Contains the scaling configuration of a Neptune
Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. Valid
values: standard, iopt1 Default: standard
- `"Tags"`: The tags to be assigned to the restored DB cluster.
- `"VpcSecurityGroupIds"`: A list of VPC security groups that the new DB cluster will
belong to.
"""
function restore_dbcluster_from_snapshot(
DBClusterIdentifier,
Engine,
SnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RestoreDBClusterFromSnapshot",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"Engine" => Engine,
"SnapshotIdentifier" => SnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbcluster_from_snapshot(
DBClusterIdentifier,
Engine,
SnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RestoreDBClusterFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"Engine" => Engine,
"SnapshotIdentifier" => SnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbcluster_to_point_in_time(dbcluster_identifier, source_dbcluster_identifier)
restore_dbcluster_to_point_in_time(dbcluster_identifier, source_dbcluster_identifier, params::Dict{String,<:Any})
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time
before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is
created from the source DB cluster with the same configuration as the original DB cluster,
except that the new DB cluster is created with the default DB security group. This action
only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances
only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is
available.
# Arguments
- `dbcluster_identifier`: The name of the new DB cluster to be created. Constraints: Must
contain from 1 to 63 letters, numbers, or hyphens First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
- `source_dbcluster_identifier`: The identifier of the source DB cluster from which to
restore. Constraints: Must match the identifier of an existing DBCluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with the new DB cluster. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"DBSubnetGroupName"`: The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:
mySubnetgroup
- `"DeletionProtection"`: A value that indicates whether the DB cluster has deletion
protection enabled. The database can't be deleted when deletion protection is enabled. By
default, deletion protection is disabled.
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB cluster is to
export to CloudWatch Logs.
- `"EnableIAMDatabaseAuthentication"`: True to enable mapping of Amazon Identity and Access
Management (IAM) accounts to database accounts, and otherwise false. Default: false
- `"KmsKeyId"`: The Amazon KMS key identifier to use when restoring an encrypted DB cluster
from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for
the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that
owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS
key alias instead of the ARN for the KMS encryption key. You can restore to a new DB
cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key
used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key
identified by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId
parameter, then the following will occur: If the DB cluster is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB
cluster. If the DB cluster is not encrypted, then the restored DB cluster is not
encrypted. If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the
restore request is rejected.
- `"OptionGroupName"`: (Not supported by Neptune)
- `"Port"`: The port number on which the new DB cluster accepts connections. Constraints:
Value must be 1150-65535 Default: The same port as the original DB cluster.
- `"RestoreToTime"`: The date and time to restore the DB cluster to. Valid Values: Value
must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the
latest restorable time for the DB instance Must be specified if UseLatestRestorableTime
parameter is not provided Cannot be specified if UseLatestRestorableTime parameter is
true Cannot be specified if RestoreType parameter is copy-on-write Example:
2015-03-07T23:45:00Z
- `"RestoreType"`: The type of restore to be performed. You can specify one of the
following values: full-copy - The new DB cluster is restored as a full copy of the
source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the
source DB cluster. If you don't specify a RestoreType value, then the new DB cluster is
restored as a full copy of the source DB cluster.
- `"ServerlessV2ScalingConfiguration"`: Contains the scaling configuration of a Neptune
Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. Valid
values: standard, iopt1 Default: standard
- `"Tags"`: The tags to be applied to the restored DB cluster.
- `"UseLatestRestorableTime"`: A value that is set to true to restore the DB cluster to the
latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be
specified if RestoreToTime parameter is provided.
- `"VpcSecurityGroupIds"`: A list of VPC security groups that the new DB cluster belongs to.
"""
function restore_dbcluster_to_point_in_time(
DBClusterIdentifier,
SourceDBClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RestoreDBClusterToPointInTime",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"SourceDBClusterIdentifier" => SourceDBClusterIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbcluster_to_point_in_time(
DBClusterIdentifier,
SourceDBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"RestoreDBClusterToPointInTime",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"SourceDBClusterIdentifier" => SourceDBClusterIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dbcluster(dbcluster_identifier)
start_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon
CLI stop-db-cluster command, or the StopDBCluster API.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier of the Neptune DB cluster to be
started. This parameter is stored as a lowercase string.
"""
function start_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"StartDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"StartDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_dbcluster(dbcluster_identifier)
stop_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB
cluster's metadata, including its endpoints and DB parameter groups. Neptune also retains
the transaction logs so you can do a point-in-time restore if necessary.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier of the Neptune DB cluster to be
stopped. This parameter is stored as a lowercase string.
"""
function stop_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptune(
"StopDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptune(
"StopDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 84044 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: neptunedata
using AWS.Compat
using AWS.UUIDs
"""
cancel_gremlin_query(query_id)
cancel_gremlin_query(query_id, params::Dict{String,<:Any})
Cancels a Gremlin query. See Gremlin query cancellation for more information. When invoking
this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or
role making the request must have a policy attached that allows the neptune-db:CancelQuery
IAM action in that cluster.
# Arguments
- `query_id`: The unique identifier that identifies the query to be canceled.
"""
function cancel_gremlin_query(queryId; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/gremlin/status/$(queryId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_gremlin_query(
queryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/gremlin/status/$(queryId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_loader_job(load_id)
cancel_loader_job(load_id, params::Dict{String,<:Any})
Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status
API for more information. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:CancelLoaderJob IAM action in that cluster..
# Arguments
- `load_id`: The ID of the load job to be deleted.
"""
function cancel_loader_job(loadId; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/loader/$(loadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_loader_job(
loadId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/loader/$(loadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_mldata_processing_job(id)
cancel_mldata_processing_job(id, params::Dict{String,<:Any})
Cancels a Neptune ML data processing job. See The dataprocessing command. When invoking
this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or
role making the request must have a policy attached that allows the
neptune-db:CancelMLDataProcessingJob IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the data-processing job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clean"`: If set to TRUE, this flag specifies that all Neptune ML S3 artifacts should be
deleted when the job is stopped. The default is FALSE.
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function cancel_mldata_processing_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/ml/dataprocessing/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_mldata_processing_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/ml/dataprocessing/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_mlmodel_training_job(id)
cancel_mlmodel_training_job(id, params::Dict{String,<:Any})
Cancels a Neptune ML model training job. See Model training using the modeltraining
command. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:CancelMLModelTrainingJob IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the model-training job to be canceled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clean"`: If set to TRUE, this flag specifies that all Amazon S3 artifacts should be
deleted when the job is stopped. The default is FALSE.
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function cancel_mlmodel_training_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/ml/modeltraining/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_mlmodel_training_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/ml/modeltraining/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_mlmodel_transform_job(id)
cancel_mlmodel_transform_job(id, params::Dict{String,<:Any})
Cancels a specified model transform job. See Use a trained model to generate new model
artifacts. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:CancelMLModelTransformJob IAM action in that cluster.
# Arguments
- `id`: The unique ID of the model transform job to be canceled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clean"`: If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted
when the job is stopped. The default is FALSE.
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function cancel_mlmodel_transform_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/ml/modeltransform/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_mlmodel_transform_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/ml/modeltransform/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_open_cypher_query(query_id)
cancel_open_cypher_query(query_id, params::Dict{String,<:Any})
Cancels a specified openCypher query. See Neptune openCypher status endpoint for more
information. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:CancelQuery IAM action in that cluster.
# Arguments
- `query_id`: The unique ID of the openCypher query to cancel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"silent"`: If set to TRUE, causes the cancelation of the openCypher query to happen
silently.
"""
function cancel_open_cypher_query(
queryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/opencypher/status/$(queryId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_open_cypher_query(
queryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/opencypher/status/$(queryId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mlendpoint()
create_mlendpoint(params::Dict{String,<:Any})
Creates a new Neptune ML inference endpoint that lets you query one specific model that the
model-training process constructed. See Managing inference endpoints using the endpoints
command. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:CreateMLEndpoint IAM action in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"id"`: A unique identifier for the new inference endpoint. The default is an
autogenerated timestamped name.
- `"instanceCount"`: The minimum number of Amazon EC2 instances to deploy to an endpoint
for prediction. The default is 1
- `"instanceType"`: The type of Neptune ML instance to use for online servicing. The
default is ml.m5.xlarge. Choosing the ML instance for an inference endpoint depends on the
task type, the graph size, and your budget.
- `"mlModelTrainingJobId"`: The job Id of the completed model-training job that has created
the model that the inference endpoint will point to. You must supply either the
mlModelTrainingJobId or the mlModelTransformJobId.
- `"mlModelTransformJobId"`: The job Id of the completed model-transform job. You must
supply either the mlModelTrainingJobId or the mlModelTransformJobId.
- `"modelName"`: Model type for training. By default the Neptune ML model is automatically
based on the modelType used in data processing, but you can specify a different model type
here. The default is rgcn for heterogeneous graphs and kge for knowledge graphs. The only
valid value for heterogeneous graphs is rgcn. Valid values for knowledge graphs are: kge,
transe, distmult, and rotate.
- `"neptuneIamRoleArn"`: The ARN of an IAM role providing Neptune access to SageMaker and
Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will be thrown.
- `"update"`: If set to true, update indicates that this is an update request. The default
is false. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.
- `"volumeEncryptionKMSKey"`: The Amazon Key Management Service (Amazon KMS) key that
SageMaker uses to encrypt data on the storage volume attached to the ML compute instances
that run the training job. The default is None.
"""
function create_mlendpoint(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"POST", "/ml/endpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_mlendpoint(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/ml/endpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mlendpoint(id)
delete_mlendpoint(id, params::Dict{String,<:Any})
Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints
using the endpoints command. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:DeleteMLEndpoint IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the inference endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clean"`: If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted
when the job is stopped. The default is FALSE.
- `"neptuneIamRoleArn"`: The ARN of an IAM role providing Neptune access to SageMaker and
Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will be thrown.
"""
function delete_mlendpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/ml/endpoints/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mlendpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/ml/endpoints/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_propertygraph_statistics()
delete_propertygraph_statistics(params::Dict{String,<:Any})
Deletes statistics for Gremlin and openCypher (property graph) data. When invoking this
operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role
making the request must have a policy attached that allows the neptune-db:DeleteStatistics
IAM action in that cluster.
"""
function delete_propertygraph_statistics(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/propertygraph/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_propertygraph_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/propertygraph/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sparql_statistics()
delete_sparql_statistics(params::Dict{String,<:Any})
Deletes SPARQL statistics When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:DeleteStatistics IAM action in that cluster.
"""
function delete_sparql_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"DELETE",
"/sparql/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sparql_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"DELETE",
"/sparql/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_fast_reset(action)
execute_fast_reset(action, params::Dict{String,<:Any})
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of
its data. Neptune fast reset is a two-step process. First you call ExecuteFastReset with
action set to initiateDatabaseReset. This returns a UUID token which you then include when
calling ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon
Neptune DB cluster using the fast reset API. When invoking this operation in a Neptune
cluster that has IAM authentication enabled, the IAM user or role making the request must
have a policy attached that allows the neptune-db:ResetDatabase IAM action in that cluster.
# Arguments
- `action`: The fast reset action. One of the following values: initiateDatabaseReset
– This action generates a unique token needed to actually perform the fast reset.
performDatabaseReset – This action uses the token generated by the
initiateDatabaseReset action to actually perform the fast reset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"token"`: The fast-reset token to initiate the reset.
"""
function execute_fast_reset(action; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"POST",
"/system",
Dict{String,Any}("action" => action);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_fast_reset(
action, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/system",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("action" => action), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_gremlin_explain_query(gremlin)
execute_gremlin_explain_query(gremlin, params::Dict{String,<:Any})
Executes a Gremlin Explain query. Amazon Neptune has added a Gremlin feature named explain
that provides is a self-service tool for understanding the execution approach being taken
by the Neptune engine for the query. You invoke it by adding an explain parameter to an
HTTP call that submits a Gremlin query. The explain feature provides information about the
logical structure of query execution plans. You can use this information to identify
potential evaluation and execution bottlenecks and to tune your query, as explained in
Tuning Gremlin queries. You can also use query hints to improve query execution plans. When
invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM
user or role making the request must have a policy attached that allows one of the
following IAM actions in that cluster, depending on the query:
neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery
neptune-db:DeleteDataViaQuery Note that the neptune-db:QueryLanguage:Gremlin IAM
condition key can be used in the policy document to restrict the use of Gremlin queries
(see Condition keys available in Neptune IAM data-access policy statements).
# Arguments
- `gremlin`: The Gremlin explain query string.
"""
function execute_gremlin_explain_query(
gremlin; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/gremlin/explain",
Dict{String,Any}("gremlin" => gremlin);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_gremlin_explain_query(
gremlin, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/gremlin/explain",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("gremlin" => gremlin), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_gremlin_profile_query(gremlin)
execute_gremlin_profile_query(gremlin, params::Dict{String,<:Any})
Executes a Gremlin Profile query, which runs a specified traversal, collects various
metrics about the run, and produces a profile report as output. See Gremlin profile API in
Neptune for details. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:ReadDataViaQuery IAM action in that cluster. Note that the
neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to
restrict the use of Gremlin queries (see Condition keys available in Neptune IAM
data-access policy statements).
# Arguments
- `gremlin`: The Gremlin query string to profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"profile.chop"`: If non-zero, causes the results string to be truncated at that number
of characters. If set to zero, the string contains all the results.
- `"profile.indexOps"`: If this flag is set to TRUE, the results include a detailed report
of all index operations that took place during query execution and serialization.
- `"profile.results"`: If this flag is set to TRUE, the query results are gathered and
displayed as part of the profile report. If FALSE, only the result count is displayed.
- `"profile.serializer"`: If non-null, the gathered results are returned in a serialized
response message in the format specified by this parameter. See Gremlin profile API in
Neptune for more information.
"""
function execute_gremlin_profile_query(
gremlin; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/gremlin/profile",
Dict{String,Any}("gremlin" => gremlin);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_gremlin_profile_query(
gremlin, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/gremlin/profile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("gremlin" => gremlin), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_gremlin_query(gremlin)
execute_gremlin_query(gremlin, params::Dict{String,<:Any})
This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3
and Gremlin, so you can use the Gremlin traversal language to query the graph, as described
under The Graph in the Apache TinkerPop3 documentation. More details can also be found in
Accessing a Neptune graph with Gremlin. When invoking this operation in a Neptune cluster
that has IAM authentication enabled, the IAM user or role making the request must have a
policy attached that enables one of the following IAM actions in that cluster, depending on
the query: neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery
neptune-db:DeleteDataViaQuery Note that the neptune-db:QueryLanguage:Gremlin IAM
condition key can be used in the policy document to restrict the use of Gremlin queries
(see Condition keys available in Neptune IAM data-access policy statements).
# Arguments
- `gremlin`: Using this API, you can run Gremlin queries in string format much as you can
using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB
cluster is using (see the Tinkerpop client section to determine which Gremlin releases your
engine version supports).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accept"`: If non-null, the query results are returned in a serialized response message
in the format specified by this parameter. See the GraphSON section in the TinkerPop
documentation for a list of the formats that are currently supported.
"""
function execute_gremlin_query(gremlin; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"POST",
"/gremlin",
Dict{String,Any}("gremlin" => gremlin);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_gremlin_query(
gremlin, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/gremlin",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("gremlin" => gremlin), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_open_cypher_explain_query(explain, query)
execute_open_cypher_explain_query(explain, query, params::Dict{String,<:Any})
Executes an openCypher explain request. See The openCypher explain feature for more
information. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:ReadDataViaQuery IAM action in that cluster. Note that the
neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to
restrict the use of openCypher queries (see Condition keys available in Neptune IAM
data-access policy statements).
# Arguments
- `explain`: The openCypher explain mode. Can be one of: static, dynamic, or details.
- `query`: The openCypher query string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`: The openCypher query parameters.
"""
function execute_open_cypher_explain_query(
explain, query; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/opencypher/explain",
Dict{String,Any}("explain" => explain, "query" => query);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_open_cypher_explain_query(
explain,
query,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/opencypher/explain",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("explain" => explain, "query" => query), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_open_cypher_query(query)
execute_open_cypher_query(query, params::Dict{String,<:Any})
Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more
information. Neptune supports building graph applications using openCypher, which is
currently one of the most popular query languages among developers working with graph
databases. Developers, business analysts, and data scientists like openCypher's
declarative, SQL-inspired syntax because it provides a familiar structure in which to
querying property graphs. The openCypher language was originally developed by Neo4j, then
open-sourced in 2015 and contributed to the openCypher project under an Apache 2
open-source license. Note that when invoking this operation in a Neptune cluster that has
IAM authentication enabled, the IAM user or role making the request must have a policy
attached that allows one of the following IAM actions in that cluster, depending on the
query: neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery
neptune-db:DeleteDataViaQuery Note also that the neptune-db:QueryLanguage:OpenCypher IAM
condition key can be used in the policy document to restrict the use of openCypher queries
(see Condition keys available in Neptune IAM data-access policy statements).
# Arguments
- `query`: The openCypher query string to be executed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`: The openCypher query parameters for query execution. See Examples of
openCypher parameterized queries for more information.
"""
function execute_open_cypher_query(query; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"POST",
"/opencypher",
Dict{String,Any}("query" => query);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_open_cypher_query(
query, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/opencypher",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("query" => query), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_engine_status()
get_engine_status(params::Dict{String,<:Any})
Retrieves the status of the graph database on the host. When invoking this operation in a
Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action
in that cluster.
"""
function get_engine_status(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/status"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_engine_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET", "/status", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_gremlin_query_status(query_id)
get_gremlin_query_status(query_id, params::Dict{String,<:Any})
Gets the status of a specified Gremlin query. When invoking this operation in a Neptune
cluster that has IAM authentication enabled, the IAM user or role making the request must
have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that
cluster. Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in
the policy document to restrict the use of Gremlin queries (see Condition keys available in
Neptune IAM data-access policy statements).
# Arguments
- `query_id`: The unique identifier that identifies the Gremlin query.
"""
function get_gremlin_query_status(
queryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/gremlin/status/$(queryId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_gremlin_query_status(
queryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/gremlin/status/$(queryId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_loader_job_status(load_id)
get_loader_job_status(load_id, params::Dict{String,<:Any})
Gets status information about a specified load job. Neptune keeps track of the most recent
1,024 bulk load jobs, and stores the last 10,000 error details per job. See Neptune Loader
Get-Status API for more information. When invoking this operation in a Neptune cluster that
has IAM authentication enabled, the IAM user or role making the request must have a policy
attached that allows the neptune-db:GetLoaderJobStatus IAM action in that cluster..
# Arguments
- `load_id`: The load ID of the load job to get the status of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"details"`: Flag indicating whether or not to include details beyond the overall status
(TRUE or FALSE; the default is FALSE).
- `"errors"`: Flag indicating whether or not to include a list of errors encountered (TRUE
or FALSE; the default is FALSE). The list of errors is paged. The page and errorsPerPage
parameters allow you to page through all the errors.
- `"errorsPerPage"`: The number of errors returned in each page (a positive integer; the
default is 10). Only valid when the errors parameter set to TRUE.
- `"page"`: The error page number (a positive integer; the default is 1). Only valid when
the errors parameter is set to TRUE.
"""
function get_loader_job_status(loadId; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/loader/$(loadId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_loader_job_status(
loadId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/loader/$(loadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mldata_processing_job(id)
get_mldata_processing_job(id, params::Dict{String,<:Any})
Retrieves information about a specified data processing job. See The dataprocessing
command. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the data-processing job to be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function get_mldata_processing_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/ml/dataprocessing/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mldata_processing_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/dataprocessing/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mlendpoint(id)
get_mlendpoint(id, params::Dict{String,<:Any})
Retrieves details about an inference endpoint. See Managing inference endpoints using the
endpoints command. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:GetMLEndpointStatus IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the inference endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function get_mlendpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/ml/endpoints/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_mlendpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/endpoints/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mlmodel_training_job(id)
get_mlmodel_training_job(id, params::Dict{String,<:Any})
Retrieves information about a Neptune ML model training job. See Model training using the
modeltraining command. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:GetMLModelTrainingJobStatus IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the model-training job to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function get_mlmodel_training_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/ml/modeltraining/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mlmodel_training_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/modeltraining/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mlmodel_transform_job(id)
get_mlmodel_transform_job(id, params::Dict{String,<:Any})
Gets information about a specified model transform job. See Use a trained model to generate
new model artifacts. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:GetMLModelTransformJobStatus IAM action in that cluster.
# Arguments
- `id`: The unique identifier of the model-transform job to be reetrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function get_mlmodel_transform_job(id; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/ml/modeltransform/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mlmodel_transform_job(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/modeltransform/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_open_cypher_query_status(query_id)
get_open_cypher_query_status(query_id, params::Dict{String,<:Any})
Retrieves the status of a specified openCypher query. When invoking this operation in a
Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in
that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be
used in the policy document to restrict the use of openCypher queries (see Condition keys
available in Neptune IAM data-access policy statements).
# Arguments
- `query_id`: The unique ID of the openCypher query for which to retrieve the query status.
"""
function get_open_cypher_query_status(
queryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/opencypher/status/$(queryId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_open_cypher_query_status(
queryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/opencypher/status/$(queryId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_propertygraph_statistics()
get_propertygraph_statistics(params::Dict{String,<:Any})
Gets property graph statistics (Gremlin and openCypher). When invoking this operation in a
Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the neptune-db:GetStatisticsStatus IAM
action in that cluster.
"""
function get_propertygraph_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/propertygraph/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_propertygraph_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/propertygraph/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_propertygraph_stream()
get_propertygraph_stream(params::Dict{String,<:Any})
Gets a stream for a property graph. With the Neptune Streams feature, you can generate a
complete sequence of change-log entries that record every change made to your graph data as
it happens. GetPropertygraphStream lets you collect these change-log entries for a property
graph. The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable
streams, set the neptune_streams DB cluster parameter to 1. See Capturing graph changes in
real time using Neptune streams. When invoking this operation in a Neptune cluster that has
IAM authentication enabled, the IAM user or role making the request must have a policy
attached that allows the neptune-db:GetStreamRecords IAM action in that cluster. When
invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM
user or role making the request must have a policy attached that enables one of the
following IAM actions, depending on the query: Note that you can restrict property-graph
queries using the following IAM context keys: neptune-db:QueryLanguage:Gremlin
neptune-db:QueryLanguage:OpenCypher See Condition keys available in Neptune IAM
data-access policy statements).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept-Encoding"`: If set to TRUE, Neptune compresses the response using gzip encoding.
- `"commitNum"`: The commit number of the starting record to read from the change-log
stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or
AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.
- `"iteratorType"`: Can be one of: AT_SEQUENCE_NUMBER – Indicates that reading
should start from the event sequence number specified jointly by the commitNum and opNum
parameters. AFTER_SEQUENCE_NUMBER – Indicates that reading should start right
after the event sequence number specified jointly by the commitNum and opNum parameters.
TRIM_HORIZON – Indicates that reading should start at the last untrimmed record in
the system, which is the oldest unexpired (not yet deleted) record in the change-log
stream. LATEST – Indicates that reading should start at the most recent record
in the system, which is the latest unexpired (not yet deleted) record in the change-log
stream.
- `"limit"`: Specifies the maximum number of records to return. There is also a size limit
of 10 MB on the response that can't be modified and that takes precedence over the number
of records specified in the limit parameter. The response does include a
threshold-breaching record if the 10 MB limit was reached. The range for limit is 1 to
100,000, with a default of 10.
- `"opNum"`: The operation sequence number within the specified commit to start reading
from in the change-log stream data. The default is 1.
"""
function get_propertygraph_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/propertygraph/stream";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_propertygraph_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/propertygraph/stream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_propertygraph_summary()
get_propertygraph_summary(params::Dict{String,<:Any})
Gets a graph summary for a property graph. When invoking this operation in a Neptune
cluster that has IAM authentication enabled, the IAM user or role making the request must
have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that
cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"mode"`: Mode can take one of two values: BASIC (the default), and DETAILED.
"""
function get_propertygraph_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/propertygraph/statistics/summary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_propertygraph_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/propertygraph/statistics/summary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rdfgraph_summary()
get_rdfgraph_summary(params::Dict{String,<:Any})
Gets a graph summary for an RDF graph. When invoking this operation in a Neptune cluster
that has IAM authentication enabled, the IAM user or role making the request must have a
policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"mode"`: Mode can take one of two values: BASIC (the default), and DETAILED.
"""
function get_rdfgraph_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET",
"/rdf/statistics/summary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rdfgraph_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/rdf/statistics/summary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sparql_statistics()
get_sparql_statistics(params::Dict{String,<:Any})
Gets RDF statistics (SPARQL).
"""
function get_sparql_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/sparql/statistics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_sparql_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/sparql/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sparql_stream()
get_sparql_stream(params::Dict{String,<:Any})
Gets a stream for an RDF graph. With the Neptune Streams feature, you can generate a
complete sequence of change-log entries that record every change made to your graph data as
it happens. GetSparqlStream lets you collect these change-log entries for an RDF graph. The
Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams,
set the neptune_streams DB cluster parameter to 1. See Capturing graph changes in real time
using Neptune streams. When invoking this operation in a Neptune cluster that has IAM
authentication enabled, the IAM user or role making the request must have a policy attached
that allows the neptune-db:GetStreamRecords IAM action in that cluster. Note that the
neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to
restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access
policy statements).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept-Encoding"`: If set to TRUE, Neptune compresses the response using gzip encoding.
- `"commitNum"`: The commit number of the starting record to read from the change-log
stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or
AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.
- `"iteratorType"`: Can be one of: AT_SEQUENCE_NUMBER – Indicates that reading
should start from the event sequence number specified jointly by the commitNum and opNum
parameters. AFTER_SEQUENCE_NUMBER – Indicates that reading should start right
after the event sequence number specified jointly by the commitNum and opNum parameters.
TRIM_HORIZON – Indicates that reading should start at the last untrimmed record in
the system, which is the oldest unexpired (not yet deleted) record in the change-log
stream. LATEST – Indicates that reading should start at the most recent record
in the system, which is the latest unexpired (not yet deleted) record in the change-log
stream.
- `"limit"`: Specifies the maximum number of records to return. There is also a size limit
of 10 MB on the response that can't be modified and that takes precedence over the number
of records specified in the limit parameter. The response does include a
threshold-breaching record if the 10 MB limit was reached. The range for limit is 1 to
100,000, with a default of 10.
- `"opNum"`: The operation sequence number within the specified commit to start reading
from in the change-log stream data. The default is 1.
"""
function get_sparql_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/sparql/stream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_sparql_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/sparql/stream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_gremlin_queries()
list_gremlin_queries(params::Dict{String,<:Any})
Lists active Gremlin queries. See Gremlin query status API for details about the output.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the
IAM user or role making the request must have a policy attached that allows the
neptune-db:GetQueryStatus IAM action in that cluster. Note that the
neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to
restrict the use of Gremlin queries (see Condition keys available in Neptune IAM
data-access policy statements).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeWaiting"`: If set to TRUE, the list returned includes waiting queries. The
default is FALSE;
"""
function list_gremlin_queries(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/gremlin/status"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_gremlin_queries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/gremlin/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_loader_jobs()
list_loader_jobs(params::Dict{String,<:Any})
Retrieves a list of the loadIds for all active loader jobs. When invoking this operation in
a Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the neptune-db:ListLoaderJobs IAM action in
that cluster..
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeQueuedLoads"`: An optional parameter that can be used to exclude the load IDs of
queued load requests when requesting a list of load IDs by setting the parameter to FALSE.
The default value is TRUE.
- `"limit"`: The number of load IDs to list. Must be a positive integer greater than zero
and not more than 100 (which is the default).
"""
function list_loader_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/loader"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_loader_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET", "/loader", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_mldata_processing_jobs()
list_mldata_processing_jobs(params::Dict{String,<:Any})
Returns a list of Neptune ML data processing jobs. See Listing active data-processing jobs
using the Neptune ML dataprocessing command. When invoking this operation in a Neptune
cluster that has IAM authentication enabled, the IAM user or role making the request must
have a policy attached that allows the neptune-db:ListMLDataProcessingJobs IAM action in
that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The maximum number of items to return (from 1 to 1024; the default is 10).
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function list_mldata_processing_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/ml/dataprocessing"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_mldata_processing_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/dataprocessing",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mlendpoints()
list_mlendpoints(params::Dict{String,<:Any})
Lists existing inference endpoints. See Managing inference endpoints using the endpoints
command. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:ListMLEndpoints IAM action in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The maximum number of items to return (from 1 to 1024; the default is 10.
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function list_mlendpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/ml/endpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_mlendpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/endpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mlmodel_training_jobs()
list_mlmodel_training_jobs(params::Dict{String,<:Any})
Lists Neptune ML model-training jobs. See Model training using the modeltraining command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the
IAM user or role making the request must have a policy attached that allows the
neptune-db:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The maximum number of items to return (from 1 to 1024; the default is 10).
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function list_mlmodel_training_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/ml/modeltraining"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_mlmodel_training_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/modeltraining",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mlmodel_transform_jobs()
list_mlmodel_transform_jobs(params::Dict{String,<:Any})
Returns a list of model transform job IDs. See Use a trained model to generate new model
artifacts. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:ListMLModelTransformJobs IAM action in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The maximum number of items to return (from 1 to 1024; the default is 10).
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
"""
function list_mlmodel_transform_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/ml/modeltransform"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_mlmodel_transform_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/ml/modeltransform",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_open_cypher_queries()
list_open_cypher_queries(params::Dict{String,<:Any})
Lists active openCypher queries. See Neptune openCypher status endpoint for more
information. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:GetQueryStatus IAM action in that cluster. Note that the
neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to
restrict the use of openCypher queries (see Condition keys available in Neptune IAM
data-access policy statements).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeWaiting"`: When set to TRUE and other parameters are not present, causes status
information to be returned for waiting queries as well as for running queries.
"""
function list_open_cypher_queries(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"GET", "/opencypher/status"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_open_cypher_queries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"GET",
"/opencypher/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
manage_propertygraph_statistics()
manage_propertygraph_statistics(params::Dict{String,<:Any})
Manages the generation and use of property graph statistics. When invoking this operation
in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the neptune-db:ManageStatistics IAM action
in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"mode"`: The statistics generation mode. One of: DISABLE_AUTOCOMPUTE,
ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics
generation.
"""
function manage_propertygraph_statistics(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/propertygraph/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function manage_propertygraph_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/propertygraph/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
manage_sparql_statistics()
manage_sparql_statistics(params::Dict{String,<:Any})
Manages the generation and use of RDF graph statistics. When invoking this operation in a
Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the neptune-db:ManageStatistics IAM action
in that cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"mode"`: The statistics generation mode. One of: DISABLE_AUTOCOMPUTE,
ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics
generation.
"""
function manage_sparql_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return neptunedata(
"POST", "/sparql/statistics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function manage_sparql_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/sparql/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_loader_job(format, iam_role_arn, region, source)
start_loader_job(format, iam_role_arn, region, source, params::Dict{String,<:Any})
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB
instance. See Using the Amazon Neptune Bulk Loader to Ingest Data. When invoking this
operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role
making the request must have a policy attached that allows the neptune-db:StartLoaderJob
IAM action in that cluster.
# Arguments
- `format`: The format of the data. For more information about data formats for the Neptune
Loader command, see Load Data Formats. Allowed values csv for the Gremlin CSV data
format. opencypher for the openCypher CSV data format. ntriples for the N-Triples
RDF data format. nquads for the N-Quads RDF data format. rdfxml for the RDFXML
RDF data format. turtle for the Turtle RDF data format.
- `iam_role_arn`: The Amazon Resource Name (ARN) for an IAM role to be assumed by the
Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be
attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
- `region`: The Amazon region of the S3 bucket. This must match the Amazon Region of the DB
cluster.
- `source`: The source parameter accepts an S3 URI that identifies a single file, multiple
files, a folder, or multiple folders. Neptune loads every data file in any folder that is
specified. The URI can be in any of the following formats.
s3://(bucket_name)/(object-key-name)
https://s3.amazonaws.com/(bucket_name)/(object-key-name)
https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name) The object-key-name
element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It
identifies all the objects in the specified S3 bucket whose names begin with that prefix.
That can be a single file or folder, or multiple files and/or folders. The specified folder
or folders can contain multiple vertex files and multiple edge files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dependencies"`: This is an optional parameter that can make a queued load request
contingent on the successful completion of one or more previous jobs in the queue. Neptune
can queue up as many as 64 load requests at a time, if their queueRequest parameters are
set to \"TRUE\". The dependencies parameter lets you make execution of such a queued
request dependent on the successful completion of one or more specified previous requests
in the queue. For example, if load Job-A and Job-B are independent of each other, but load
Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows: Submit
load-job-A and load-job-B one after another in any order, and save their load-ids. Submit
load-job-C with the load-ids of the two jobs in its dependencies field: Because of the
dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have
completed successfully. If either one of them fails, Job-C will not be executed, and its
status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED. You can set up multiple
levels of dependency in this way, so that the failure of one job will cause all requests
that are directly or indirectly dependent on it to be cancelled.
- `"failOnError"`: failOnError – A flag to toggle a complete stop on an error.
Allowed values: \"TRUE\", \"FALSE\". Default value: \"TRUE\". When this parameter is set
to \"FALSE\", the loader tries to load all the data in the location specified, skipping any
entries with errors. When this parameter is set to \"TRUE\", the loader stops as soon as it
encounters an error. Data loaded up to that point persists.
- `"mode"`: The load job mode. Allowed values: RESUME, NEW, AUTO. Default value: AUTO.
RESUME – In RESUME mode, the loader looks for a previous load from this source,
and if it finds one, resumes that load job. If no previous load job is found, the loader
stops. The loader avoids reloading files that were successfully loaded in a previous job.
It only tries to process failed files. If you dropped previously loaded data from your
Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all
files from the same source successfully, nothing is reloaded, and the loader returns
success. NEW – In NEW mode, the creates a new load request regardless of any
previous loads. You can use this mode to reload all the data from a source after dropping
previously loaded data from your Neptune cluster, or to load new data available at the same
source. AUTO – In AUTO mode, the loader looks for a previous load job from the
same source, and if it finds one, resumes that job, just as in RESUME mode. If the loader
doesn't find a previous load job from the same source, it loads all data from the source,
just as in NEW mode.
- `"parallelism"`: The optional parallelism parameter can be set to reduce the number of
threads used by the bulk load process. Allowed values: LOW – The number of threads
used is the number of available vCPUs divided by 8. MEDIUM – The number of threads
used is the number of available vCPUs divided by 2. HIGH – The number of threads
used is the same as the number of available vCPUs. OVERSUBSCRIBE – The number of
threads used is the number of available vCPUs multiplied by 2. If this value is used, the
bulk loader takes up all available resources. This does not mean, however, that the
OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O
bound, the highest CPU utilization to expect is in the 60% to 70% range. Default value:
HIGH The parallelism setting can sometimes result in a deadlock between threads when
loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error.
You can generally fix the issue by setting parallelism to a lower setting and retrying the
load command.
- `"parserConfiguration"`: parserConfiguration – An optional object with
additional parser configuration values. Each of the child parameters is also optional:
namedGraphUri – The default graph for all RDF formats when no graph is specified
(for non-quads formats and NQUAD entries with no graph). The default is
https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph. baseUri – The base
URI for RDF/XML and Turtle formats. The default is https://aws.amazon.com/neptune/default.
allowEmptyStrings – Gremlin users need to be able to pass empty string
values(\"\") as node and edge properties when loading CSV data. If allowEmptyStrings is set
to false (the default), such empty strings are treated as nulls and are not loaded. If
allowEmptyStrings is set to true, the loader treats empty strings as valid property values
and loads them accordingly.
- `"queueRequest"`: This is an optional flag parameter that indicates whether the load
request can be queued up or not. You don't have to wait for one load job to complete
before issuing the next one, because Neptune can queue up as many as 64 jobs at a time,
provided that their queueRequest parameters are all set to \"TRUE\". The queue order of the
jobs will be first-in-first-out (FIFO). If the queueRequest parameter is omitted or set to
\"FALSE\", the load request will fail if another load job is already running. Allowed
values: \"TRUE\", \"FALSE\". Default value: \"FALSE\".
- `"updateSingleCardinalityProperties"`: updateSingleCardinalityProperties is an optional
parameter that controls how the bulk loader treats a new value for single-cardinality
vertex or edge properties. This is not supported for loading openCypher data. Allowed
values: \"TRUE\", \"FALSE\". Default value: \"FALSE\". By default, or when
updateSingleCardinalityProperties is explicitly set to \"FALSE\", the loader treats a new
value as an error, because it violates single cardinality. When
updateSingleCardinalityProperties is set to \"TRUE\", on the other hand, the bulk loader
replaces the existing value with the new one. If multiple edge or single-cardinality vertex
property values are provided in the source file(s) being loaded, the final value at the end
of the bulk load could be any one of those new values. The loader only guarantees that the
existing value has been replaced by one of the new ones.
- `"userProvidedEdgeIds"`: This parameter is required only when loading openCypher data
that contains relationship IDs. It must be included and set to True when openCypher
relationship IDs are explicitly provided in the load data (recommended). When
userProvidedEdgeIds is absent or set to True, an :ID column must be present in every
relationship file in the load. When userProvidedEdgeIds is present and set to False,
relationship files in the load must not contain an :ID column. Instead, the Neptune loader
automatically generates an ID for each relationship. It's useful to provide relationship
IDs explicitly so that the loader can resume loading after error in the CSV data have been
fixed, without having to reload any relationships that have already been loaded. If
relationship IDs have not been explicitly assigned, the loader cannot resume a failed load
if any relationship file has had to be corrected, and must instead reload all the
relationships.
"""
function start_loader_job(
format, iamRoleArn, region, source; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/loader",
Dict{String,Any}(
"format" => format,
"iamRoleArn" => iamRoleArn,
"region" => region,
"source" => source,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_loader_job(
format,
iamRoleArn,
region,
source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/loader",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"format" => format,
"iamRoleArn" => iamRoleArn,
"region" => region,
"source" => source,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_mldata_processing_job(input_data_s3_location, processed_data_s3_location)
start_mldata_processing_job(input_data_s3_location, processed_data_s3_location, params::Dict{String,<:Any})
Creates a new Neptune ML data processing job for processing the graph data exported from
Neptune for training. See The dataprocessing command. When invoking this operation in a
Neptune cluster that has IAM authentication enabled, the IAM user or role making the
request must have a policy attached that allows the
neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.
# Arguments
- `input_data_s3_location`: The URI of the Amazon S3 location where you want SageMaker to
download the data needed to run the data processing job.
- `processed_data_s3_location`: The URI of the Amazon S3 location where you want SageMaker
to save the results of a data processing job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configFileName"`: A data specification file that describes how to load the exported
graph data for training. The file is automatically generated by the Neptune export toolkit.
The default is training-data-configuration.json.
- `"id"`: A unique identifier for the new job. The default is an autogenerated UUID.
- `"modelType"`: One of the two model types that Neptune ML currently supports:
heterogeneous graph models (heterogeneous), and knowledge graph (kge). The default is none.
If not specified, Neptune ML chooses the model type automatically based on the data.
- `"neptuneIamRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that SageMaker can
assume to perform tasks on your behalf. This must be listed in your DB cluster parameter
group or an error will occur.
- `"previousDataProcessingJobId"`: The job ID of a completed data processing job run on an
earlier version of the data.
- `"processingInstanceType"`: The type of ML instance used during data processing. Its
memory should be large enough to hold the processed dataset. The default is the smallest
ml.r5 type whose memory is ten times larger than the size of the exported graph data on
disk.
- `"processingInstanceVolumeSizeInGB"`: The disk volume size of the processing instance.
Both input data and processed data are stored on disk, so the volume size must be large
enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses
the volume size automatically based on the data size.
- `"processingTimeOutInSeconds"`: Timeout in seconds for the data processing job. The
default is 86,400 (1 day).
- `"s3OutputEncryptionKMSKey"`: The Amazon Key Management Service (Amazon KMS) key that
SageMaker uses to encrypt the output of the processing job. The default is none.
- `"sagemakerIamRoleArn"`: The ARN of an IAM role for SageMaker execution. This must be
listed in your DB cluster parameter group or an error will occur.
- `"securityGroupIds"`: The VPC security group IDs. The default is None.
- `"subnets"`: The IDs of the subnets in the Neptune VPC. The default is None.
- `"volumeEncryptionKMSKey"`: The Amazon Key Management Service (Amazon KMS) key that
SageMaker uses to encrypt data on the storage volume attached to the ML compute instances
that run the training job. The default is None.
"""
function start_mldata_processing_job(
inputDataS3Location,
processedDataS3Location;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/ml/dataprocessing",
Dict{String,Any}(
"inputDataS3Location" => inputDataS3Location,
"processedDataS3Location" => processedDataS3Location,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_mldata_processing_job(
inputDataS3Location,
processedDataS3Location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/ml/dataprocessing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputDataS3Location" => inputDataS3Location,
"processedDataS3Location" => processedDataS3Location,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_mlmodel_training_job(data_processing_job_id, train_model_s3_location)
start_mlmodel_training_job(data_processing_job_id, train_model_s3_location, params::Dict{String,<:Any})
Creates a new Neptune ML model training job. See Model training using the modeltraining
command. When invoking this operation in a Neptune cluster that has IAM authentication
enabled, the IAM user or role making the request must have a policy attached that allows
the neptune-db:StartMLModelTrainingJob IAM action in that cluster.
# Arguments
- `data_processing_job_id`: The job ID of the completed data-processing job that has
created the data that the training will work with.
- `train_model_s3_location`: The location in Amazon S3 where the model artifacts are to be
stored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"baseProcessingInstanceType"`: The type of ML instance used in preparing and managing
training of ML models. This is a CPU instance chosen based on memory requirements for
processing the training data and model.
- `"customModelTrainingParameters"`: The configuration for custom model training. This is a
JSON object.
- `"enableManagedSpotTraining"`: Optimizes the cost of training machine-learning models by
using Amazon Elastic Compute Cloud spot instances. The default is False.
- `"id"`: A unique identifier for the new job. The default is An autogenerated UUID.
- `"maxHPONumberOfTrainingJobs"`: Maximum total number of training jobs to start for the
hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the
hyperparameters of the machine learning model. To obtain a model that performs well, use at
least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10). In general, the more
tuning runs, the better the results.
- `"maxHPOParallelTrainingJobs"`: Maximum number of parallel training jobs to start for the
hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is
limited by the available resources on your training instance.
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
- `"previousModelTrainingJobId"`: The job ID of a completed model-training job that you
want to update incrementally based on updated data.
- `"s3OutputEncryptionKMSKey"`: The Amazon Key Management Service (KMS) key that SageMaker
uses to encrypt the output of the processing job. The default is none.
- `"sagemakerIamRoleArn"`: The ARN of an IAM role for SageMaker execution.This must be
listed in your DB cluster parameter group or an error will occur.
- `"securityGroupIds"`: The VPC security group IDs. The default is None.
- `"subnets"`: The IDs of the subnets in the Neptune VPC. The default is None.
- `"trainingInstanceType"`: The type of ML instance used for model training. All Neptune ML
models support CPU, GPU, and multiGPU training. The default is ml.p3.2xlarge. Choosing the
right instance type for training depends on the task type, graph size, and your budget.
- `"trainingInstanceVolumeSizeInGB"`: The disk volume size of the training instance. Both
input data and the output model are stored on disk, so the volume size must be large enough
to hold both data sets. The default is 0. If not specified or 0, Neptune ML selects a disk
volume size based on the recommendation generated in the data processing step.
- `"trainingTimeOutInSeconds"`: Timeout in seconds for the training job. The default is
86,400 (1 day).
- `"volumeEncryptionKMSKey"`: The Amazon Key Management Service (KMS) key that SageMaker
uses to encrypt data on the storage volume attached to the ML compute instances that run
the training job. The default is None.
"""
function start_mlmodel_training_job(
dataProcessingJobId,
trainModelS3Location;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/ml/modeltraining",
Dict{String,Any}(
"dataProcessingJobId" => dataProcessingJobId,
"trainModelS3Location" => trainModelS3Location,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_mlmodel_training_job(
dataProcessingJobId,
trainModelS3Location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/ml/modeltraining",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataProcessingJobId" => dataProcessingJobId,
"trainModelS3Location" => trainModelS3Location,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_mlmodel_transform_job(model_transform_output_s3_location)
start_mlmodel_transform_job(model_transform_output_s3_location, params::Dict{String,<:Any})
Creates a new model transform job. See Use a trained model to generate new model artifacts.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the
IAM user or role making the request must have a policy attached that allows the
neptune-db:StartMLModelTransformJob IAM action in that cluster.
# Arguments
- `model_transform_output_s3_location`: The location in Amazon S3 where the model artifacts
are to be stored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"baseProcessingInstanceType"`: The type of ML instance used in preparing and managing
training of ML models. This is an ML compute instance chosen based on memory requirements
for processing the training data and model.
- `"baseProcessingInstanceVolumeSizeInGB"`: The disk volume size of the training instance
in gigabytes. The default is 0. Both input data and the output model are stored on disk, so
the volume size must be large enough to hold both data sets. If not specified or 0, Neptune
ML selects a disk volume size based on the recommendation generated in the data processing
step.
- `"customModelTransformParameters"`: Configuration information for a model transform using
a custom model. The customModelTransformParameters object contains the following fields,
which must have values compatible with the saved model parameters from the training job:
- `"dataProcessingJobId"`: The job ID of a completed data-processing job. You must include
either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.
- `"id"`: A unique identifier for the new job. The default is an autogenerated UUID.
- `"mlModelTrainingJobId"`: The job ID of a completed model-training job. You must include
either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.
- `"neptuneIamRoleArn"`: The ARN of an IAM role that provides Neptune access to SageMaker
and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error
will occur.
- `"s3OutputEncryptionKMSKey"`: The Amazon Key Management Service (KMS) key that SageMaker
uses to encrypt the output of the processing job. The default is none.
- `"sagemakerIamRoleArn"`: The ARN of an IAM role for SageMaker execution. This must be
listed in your DB cluster parameter group or an error will occur.
- `"securityGroupIds"`: The VPC security group IDs. The default is None.
- `"subnets"`: The IDs of the subnets in the Neptune VPC. The default is None.
- `"trainingJobName"`: The name of a completed SageMaker training job. You must include
either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.
- `"volumeEncryptionKMSKey"`: The Amazon Key Management Service (KMS) key that SageMaker
uses to encrypt data on the storage volume attached to the ML compute instances that run
the training job. The default is None.
"""
function start_mlmodel_transform_job(
modelTransformOutputS3Location; aws_config::AbstractAWSConfig=global_aws_config()
)
return neptunedata(
"POST",
"/ml/modeltransform",
Dict{String,Any}(
"modelTransformOutputS3Location" => modelTransformOutputS3Location
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_mlmodel_transform_job(
modelTransformOutputS3Location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return neptunedata(
"POST",
"/ml/modeltransform",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"modelTransformOutputS3Location" => modelTransformOutputS3Location
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 82072 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: network_firewall
using AWS.Compat
using AWS.UUIDs
"""
associate_firewall_policy(firewall_policy_arn)
associate_firewall_policy(firewall_policy_arn, params::Dict{String,<:Any})
Associates a FirewallPolicy to a Firewall. A firewall policy defines how to monitor and
manage your VPC network traffic, using a collection of inspection rule groups and other
settings. Each firewall requires one firewall policy association, and you can use the same
firewall policy for multiple firewalls.
# Arguments
- `firewall_policy_arn`: The Amazon Resource Name (ARN) of the firewall policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function associate_firewall_policy(
FirewallPolicyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"AssociateFirewallPolicy",
Dict{String,Any}("FirewallPolicyArn" => FirewallPolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_firewall_policy(
FirewallPolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"AssociateFirewallPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FirewallPolicyArn" => FirewallPolicyArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_subnets(subnet_mappings)
associate_subnets(subnet_mappings, params::Dict{String,<:Any})
Associates the specified subnets in the Amazon VPC to the firewall. You can specify one
subnet for each of the Availability Zones that the VPC spans. This request creates an
Network Firewall firewall endpoint in each of the subnets. To enable the firewall's
protections, you must also modify the VPC's route tables for each subnet's Availability
Zone, to redirect the traffic that's coming into and going out of the zone through the
firewall endpoint.
# Arguments
- `subnet_mappings`: The IDs of the subnets that you want to associate with the firewall.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function associate_subnets(
SubnetMappings; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"AssociateSubnets",
Dict{String,Any}("SubnetMappings" => SubnetMappings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_subnets(
SubnetMappings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"AssociateSubnets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SubnetMappings" => SubnetMappings), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_firewall(firewall_name, firewall_policy_arn, subnet_mappings, vpc_id)
create_firewall(firewall_name, firewall_policy_arn, subnet_mappings, vpc_id, params::Dict{String,<:Any})
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC. The
firewall defines the configuration settings for an Network Firewall firewall. The settings
that you can define at creation include the firewall policy, the subnets in your VPC to use
for the firewall endpoints, and any tags that are attached to the firewall Amazon Web
Services resource. After you create a firewall, you can provide additional settings, like
the logging configuration. To update the settings for a firewall, you use the operations
that apply to the settings themselves, for example UpdateLoggingConfiguration,
AssociateSubnets, and UpdateFirewallDeleteProtection. To manage a firewall's tags, use the
standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource,
and UntagResource. To retrieve information about firewalls, use ListFirewalls and
DescribeFirewall.
# Arguments
- `firewall_name`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it.
- `firewall_policy_arn`: The Amazon Resource Name (ARN) of the FirewallPolicy that you want
to use for the firewall.
- `subnet_mappings`: The public subnets to use for your Network Firewall firewalls. Each
subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a
firewall endpoint in each subnet.
- `vpc_id`: The unique identifier of the VPC where Network Firewall should create the
firewall. You can't change this setting after you create the firewall.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteProtection"`: A flag indicating whether it is possible to delete the firewall. A
setting of TRUE indicates that the firewall is protected against deletion. Use this setting
to protect against accidentally deleting a firewall that is in use. When you create a
firewall, the operation initializes this flag to TRUE.
- `"Description"`: A description of the firewall.
- `"EncryptionConfiguration"`: A complex type that contains settings for encryption of your
firewall resources.
- `"FirewallPolicyChangeProtection"`: A setting indicating whether the firewall is
protected against a change to the firewall policy association. Use this setting to protect
against accidentally modifying the firewall policy for a firewall that is in use. When you
create a firewall, the operation initializes this setting to TRUE.
- `"SubnetChangeProtection"`: A setting indicating whether the firewall is protected
against changes to the subnet associations. Use this setting to protect against
accidentally modifying the subnet associations for a firewall that is in use. When you
create a firewall, the operation initializes this setting to TRUE.
- `"Tags"`: The key:value pairs to associate with the resource.
"""
function create_firewall(
FirewallName,
FirewallPolicyArn,
SubnetMappings,
VpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"CreateFirewall",
Dict{String,Any}(
"FirewallName" => FirewallName,
"FirewallPolicyArn" => FirewallPolicyArn,
"SubnetMappings" => SubnetMappings,
"VpcId" => VpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_firewall(
FirewallName,
FirewallPolicyArn,
SubnetMappings,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"CreateFirewall",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallName" => FirewallName,
"FirewallPolicyArn" => FirewallPolicyArn,
"SubnetMappings" => SubnetMappings,
"VpcId" => VpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_firewall_policy(firewall_policy, firewall_policy_name)
create_firewall_policy(firewall_policy, firewall_policy_name, params::Dict{String,<:Any})
Creates the firewall policy for the firewall according to the specifications. An Network
Firewall firewall policy defines the behavior of a firewall, in a collection of stateless
and stateful rule groups and other settings. You can use one firewall policy for multiple
firewalls.
# Arguments
- `firewall_policy`: The rule groups and policy actions to use in the firewall policy.
- `firewall_policy_name`: The descriptive name of the firewall policy. You can't change the
name of a firewall policy after you create it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the firewall policy.
- `"DryRun"`: Indicates whether you want Network Firewall to just check the validity of the
request, rather than run the request. If set to TRUE, Network Firewall checks whether the
request can run successfully, but doesn't actually make the requested changes. The call
returns the value that the request would return if you ran it with dry run set to FALSE,
but doesn't make additions or changes to your resources. This option allows you to make
sure that you have the required permissions to run the request and that your request
parameters are valid. If set to FALSE, Network Firewall makes the requested changes to
your resources.
- `"EncryptionConfiguration"`: A complex type that contains settings for encryption of your
firewall policy resources.
- `"Tags"`: The key:value pairs to associate with the resource.
"""
function create_firewall_policy(
FirewallPolicy, FirewallPolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"CreateFirewallPolicy",
Dict{String,Any}(
"FirewallPolicy" => FirewallPolicy, "FirewallPolicyName" => FirewallPolicyName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_firewall_policy(
FirewallPolicy,
FirewallPolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"CreateFirewallPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallPolicy" => FirewallPolicy,
"FirewallPolicyName" => FirewallPolicyName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule_group(capacity, rule_group_name, type)
create_rule_group(capacity, rule_group_name, type, params::Dict{String,<:Any})
Creates the specified stateless or stateful rule group, which includes the rules for
network traffic inspection, a capacity setting, and tags. You provide your rule group
specification in your request using either RuleGroup or Rules.
# Arguments
- `capacity`: The maximum operating resources that this rule group can use. Rule group
capacity is fixed at creation. When you update a rule group, you are limited to this
capacity. When you reference a rule group from a firewall policy, Network Firewall reserves
this capacity for the rule group. You can retrieve the capacity that would be required for
a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to
TRUE. You can't change or exceed this capacity when you update the rule group, so leave
room for your rule group to grow. Capacity for a stateless rule group For a stateless
rule group, the capacity required is the sum of the capacity requirements of the individual
rules that you expect to have in the rule group. To calculate the capacity requirement of
a single rule, multiply the capacity requirement values of each of the rule's match
settings: A match setting with no criteria specified has a value of 1. A match setting
with Any specified has a value of 1. All other match settings have a value equal to the
number of elements provided in the setting. For example, a protocol setting [\"UDP\"] and a
source setting [\"10.0.0.0/24\"] each have a value of 1. A protocol setting
[\"UDP\",\"TCP\"] has a value of 2. A source setting
[\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3. A rule with no
criteria specified in any of its match settings has a capacity requirement of 1. A rule
with protocol setting [\"UDP\",\"TCP\"], source setting
[\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no
specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group For a stateful rule group, the minimum capacity
required is the number of individual rules that you expect to have in the rule group.
- `rule_group_name`: The descriptive name of the rule group. You can't change the name of a
rule group after you create it.
- `type`: Indicates whether the rule group is stateless or stateful. If the rule group is
stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyzeRuleGroup"`: Indicates whether you want Network Firewall to analyze the
stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE, Network Firewall runs the analysis and then creates the rule group for you. To run
the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.
- `"Description"`: A description of the rule group.
- `"DryRun"`: Indicates whether you want Network Firewall to just check the validity of the
request, rather than run the request. If set to TRUE, Network Firewall checks whether the
request can run successfully, but doesn't actually make the requested changes. The call
returns the value that the request would return if you ran it with dry run set to FALSE,
but doesn't make additions or changes to your resources. This option allows you to make
sure that you have the required permissions to run the request and that your request
parameters are valid. If set to FALSE, Network Firewall makes the requested changes to
your resources.
- `"EncryptionConfiguration"`: A complex type that contains settings for encryption of your
rule group resources.
- `"RuleGroup"`: An object that defines the rule group rules. You must provide either
this rule group setting or a Rules setting, but not both.
- `"Rules"`: A string containing stateful rule group rules specifications in Suricata flat
format, with one rule per line. Use this to import your existing Suricata compatible rule
groups. You must provide either this rules setting or a populated RuleGroup setting, but
not both. You can provide your rule group specification in Suricata flat format through
this setting when you create or update your rule group. The call response returns a
RuleGroup object that Network Firewall has populated from your string.
- `"SourceMetadata"`: A complex type that contains metadata about the rule group that your
own rule group is copied from. You can use the metadata to keep track of updates made to
the originating rule group.
- `"Tags"`: The key:value pairs to associate with the resource.
"""
function create_rule_group(
Capacity, RuleGroupName, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"CreateRuleGroup",
Dict{String,Any}(
"Capacity" => Capacity, "RuleGroupName" => RuleGroupName, "Type" => Type
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule_group(
Capacity,
RuleGroupName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"CreateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Capacity" => Capacity, "RuleGroupName" => RuleGroupName, "Type" => Type
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tlsinspection_configuration(tlsinspection_configuration, tlsinspection_configuration_name)
create_tlsinspection_configuration(tlsinspection_configuration, tlsinspection_configuration_name, params::Dict{String,<:Any})
Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration
contains Certificate Manager certificate associations between and the scope configurations
that Network Firewall uses to decrypt and re-encrypt traffic traveling through your
firewall. After you create a TLS inspection configuration, you can associate it with a new
firewall policy. To update the settings for a TLS inspection configuration, use
UpdateTLSInspectionConfiguration. To manage a TLS inspection configuration's tags, use the
standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource,
and UntagResource. To retrieve information about TLS inspection configurations, use
ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration. For more
information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS
inspection configurations in the Network Firewall Developer Guide.
# Arguments
- `tlsinspection_configuration`: The object that defines a TLS inspection configuration.
This, along with TLSInspectionConfigurationResponse, define the TLS inspection
configuration. You can retrieve all objects for a TLS inspection configuration by calling
DescribeTLSInspectionConfiguration. Network Firewall uses a TLS inspection configuration
to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its
destination. To use a TLS inspection configuration, you add it to a new Network Firewall
firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as
a proxy service to decrypt and inspect the traffic traveling through your firewalls. You
can reference a TLS inspection configuration from more than one firewall policy, and you
can use a firewall policy in more than one firewall. For more information about using TLS
inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection
configurations in the Network Firewall Developer Guide.
- `tlsinspection_configuration_name`: The descriptive name of the TLS inspection
configuration. You can't change the name of a TLS inspection configuration after you create
it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the TLS inspection configuration.
- `"EncryptionConfiguration"`:
- `"Tags"`: The key:value pairs to associate with the resource.
"""
function create_tlsinspection_configuration(
TLSInspectionConfiguration,
TLSInspectionConfigurationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"CreateTLSInspectionConfiguration",
Dict{String,Any}(
"TLSInspectionConfiguration" => TLSInspectionConfiguration,
"TLSInspectionConfigurationName" => TLSInspectionConfigurationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tlsinspection_configuration(
TLSInspectionConfiguration,
TLSInspectionConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"CreateTLSInspectionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TLSInspectionConfiguration" => TLSInspectionConfiguration,
"TLSInspectionConfigurationName" => TLSInspectionConfigurationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_firewall()
delete_firewall(params::Dict{String,<:Any})
Deletes the specified Firewall and its FirewallStatus. This operation requires the
firewall's DeleteProtection flag to be FALSE. You can't revert this operation. You can
check whether a firewall is in use by reviewing the route tables for the Availability Zones
where you have firewall subnet mappings. Retrieve the subnet mappings by calling
DescribeFirewall. You define and update the route tables through Amazon VPC. As needed,
update the route tables for the zones to remove the firewall endpoints. When the route
tables no longer use the firewall endpoints, you can remove the firewall safely. To delete
a firewall, remove the delete protection if you need to using
UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
"""
function delete_firewall(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DeleteFirewall"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_firewall(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DeleteFirewall", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_firewall_policy()
delete_firewall_policy(params::Dict{String,<:Any})
Deletes the specified FirewallPolicy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallPolicyArn"`: The Amazon Resource Name (ARN) of the firewall policy. You must
specify the ARN or the name, and you can specify both.
- `"FirewallPolicyName"`: The descriptive name of the firewall policy. You can't change the
name of a firewall policy after you create it. You must specify the ARN or the name, and
you can specify both.
"""
function delete_firewall_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DeleteFirewallPolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_firewall_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DeleteFirewallPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Deletes a resource policy that you created in a PutResourcePolicy request.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rule group or firewall policy whose
resource policy you want to delete.
"""
function delete_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DeleteResourcePolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule_group()
delete_rule_group(params::Dict{String,<:Any})
Deletes the specified RuleGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RuleGroupArn"`: The Amazon Resource Name (ARN) of the rule group. You must specify the
ARN or the name, and you can specify both.
- `"RuleGroupName"`: The descriptive name of the rule group. You can't change the name of a
rule group after you create it. You must specify the ARN or the name, and you can specify
both.
- `"Type"`: Indicates whether the rule group is stateless or stateful. If the rule group is
stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN.
"""
function delete_rule_group(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DeleteRuleGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_rule_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DeleteRuleGroup", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_tlsinspection_configuration()
delete_tlsinspection_configuration(params::Dict{String,<:Any})
Deletes the specified TLSInspectionConfiguration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TLSInspectionConfigurationArn"`: The Amazon Resource Name (ARN) of the TLS inspection
configuration. You must specify the ARN or the name, and you can specify both.
- `"TLSInspectionConfigurationName"`: The descriptive name of the TLS inspection
configuration. You can't change the name of a TLS inspection configuration after you create
it. You must specify the ARN or the name, and you can specify both.
"""
function delete_tlsinspection_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DeleteTLSInspectionConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tlsinspection_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DeleteTLSInspectionConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_firewall()
describe_firewall(params::Dict{String,<:Any})
Returns the data objects for the specified firewall.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
"""
function describe_firewall(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DescribeFirewall"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_firewall(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeFirewall", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_firewall_policy()
describe_firewall_policy(params::Dict{String,<:Any})
Returns the data objects for the specified firewall policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallPolicyArn"`: The Amazon Resource Name (ARN) of the firewall policy. You must
specify the ARN or the name, and you can specify both.
- `"FirewallPolicyName"`: The descriptive name of the firewall policy. You can't change the
name of a firewall policy after you create it. You must specify the ARN or the name, and
you can specify both.
"""
function describe_firewall_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DescribeFirewallPolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_firewall_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeFirewallPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_logging_configuration()
describe_logging_configuration(params::Dict{String,<:Any})
Returns the logging configuration for the specified firewall.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
"""
function describe_logging_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DescribeLoggingConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_logging_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeLoggingConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_policy(resource_arn)
describe_resource_policy(resource_arn, params::Dict{String,<:Any})
Retrieves a resource policy that you created in a PutResourcePolicy request.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rule group or firewall policy whose
resource policy you want to retrieve.
"""
function describe_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeResourcePolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"DescribeResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rule_group()
describe_rule_group(params::Dict{String,<:Any})
Returns the data objects for the specified rule group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyzeRuleGroup"`: Indicates whether you want Network Firewall to analyze the
stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE, Network Firewall runs the analysis.
- `"RuleGroupArn"`: The Amazon Resource Name (ARN) of the rule group. You must specify the
ARN or the name, and you can specify both.
- `"RuleGroupName"`: The descriptive name of the rule group. You can't change the name of a
rule group after you create it. You must specify the ARN or the name, and you can specify
both.
- `"Type"`: Indicates whether the rule group is stateless or stateful. If the rule group is
stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN.
"""
function describe_rule_group(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DescribeRuleGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_rule_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeRuleGroup", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_rule_group_metadata()
describe_rule_group_metadata(params::Dict{String,<:Any})
High-level information about a rule group, returned by operations like create and describe.
You can use the information provided in the metadata to retrieve and manage a rule group.
You can retrieve all objects for a rule group by calling DescribeRuleGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RuleGroupArn"`: The descriptive name of the rule group. You can't change the name of a
rule group after you create it. You must specify the ARN or the name, and you can specify
both.
- `"RuleGroupName"`: The descriptive name of the rule group. You can't change the name of a
rule group after you create it. You must specify the ARN or the name, and you can specify
both.
- `"Type"`: Indicates whether the rule group is stateless or stateful. If the rule group is
stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN.
"""
function describe_rule_group_metadata(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DescribeRuleGroupMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_rule_group_metadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeRuleGroupMetadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tlsinspection_configuration()
describe_tlsinspection_configuration(params::Dict{String,<:Any})
Returns the data objects for the specified TLS inspection configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TLSInspectionConfigurationArn"`: The Amazon Resource Name (ARN) of the TLS inspection
configuration. You must specify the ARN or the name, and you can specify both.
- `"TLSInspectionConfigurationName"`: The descriptive name of the TLS inspection
configuration. You can't change the name of a TLS inspection configuration after you create
it. You must specify the ARN or the name, and you can specify both.
"""
function describe_tlsinspection_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeTLSInspectionConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tlsinspection_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"DescribeTLSInspectionConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_subnets(subnet_ids)
disassociate_subnets(subnet_ids, params::Dict{String,<:Any})
Removes the specified subnet associations from the firewall. This removes the firewall
endpoints from the subnets and removes any network filtering protections that the endpoints
were providing.
# Arguments
- `subnet_ids`: The unique identifiers for the subnets that you want to disassociate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function disassociate_subnets(SubnetIds; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"DisassociateSubnets",
Dict{String,Any}("SubnetIds" => SubnetIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_subnets(
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"DisassociateSubnets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SubnetIds" => SubnetIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_policies()
list_firewall_policies(params::Dict{String,<:Any})
Retrieves the metadata for the firewall policies that you have defined. Depending on your
setting for max results and the number of firewall policies, a single call might not return
the full list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response, Network Firewall provides
a NextToken value that you can use in a subsequent call to get the next batch of objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Network Firewall returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
"""
function list_firewall_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"ListFirewallPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_firewall_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"ListFirewallPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewalls()
list_firewalls(params::Dict{String,<:Any})
Retrieves the metadata for the firewalls that you have defined. If you provide VPC
identifiers in your request, this returns only the firewalls for those VPCs. Depending on
your setting for max results and the number of firewalls, a single call might not return
the full list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response, Network Firewall provides
a NextToken value that you can use in a subsequent call to get the next batch of objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Network Firewall returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
- `"VpcIds"`: The unique identifiers of the VPCs that you want Network Firewall to retrieve
the firewalls for. Leave this blank to retrieve all firewalls that you have defined.
"""
function list_firewalls(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"ListFirewalls"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_firewalls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"ListFirewalls", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rule_groups()
list_rule_groups(params::Dict{String,<:Any})
Retrieves the metadata for the rule groups that you have defined. Depending on your setting
for max results and the number of rule groups, a single call might not return the full
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ManagedType"`: Indicates the general category of the Amazon Web Services managed rule
group.
- `"MaxResults"`: The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response, Network Firewall provides
a NextToken value that you can use in a subsequent call to get the next batch of objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Network Firewall returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
- `"Scope"`: The scope of the request. The default setting of ACCOUNT or a setting of NULL
returns all of the rule groups in your account. A setting of MANAGED returns all available
managed rule groups.
- `"Type"`: Indicates whether the rule group is stateless or stateful. If the rule group is
stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
"""
function list_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"ListRuleGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"ListRuleGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the tags associated with the specified resource. Tags are key:value pairs that
you can use to categorize and manage your resources, for purposes like billing. For
example, you might set the tag key to \"customer\" and the value to the customer name or
ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50
tags for a resource. You can tag the Amazon Web Services resources that you manage through
Network Firewall: firewalls, firewall policies, and rule groups.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response, Network Firewall provides
a NextToken value that you can use in a subsequent call to get the next batch of objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Network Firewall returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tlsinspection_configurations()
list_tlsinspection_configurations(params::Dict{String,<:Any})
Retrieves the metadata for the TLS inspection configurations that you have defined.
Depending on your setting for max results and the number of TLS inspection configurations,
a single call might not return the full list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response, Network Firewall provides
a NextToken value that you can use in a subsequent call to get the next batch of objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Network Firewall returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
"""
function list_tlsinspection_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"ListTLSInspectionConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tlsinspection_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"ListTLSInspectionConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Creates or updates an IAM policy for your rule group or firewall policy. Use this to share
rule groups and firewall policies between accounts. This operation works in conjunction
with the Amazon Web Services Resource Access Manager (RAM) service to manage resource
sharing for Network Firewall. Use this operation to create or update a resource policy for
your rule group or firewall policy. In the policy, you specify the accounts that you want
to share the resource with and the operations that you want the accounts to be able to
perform. When you add an account in the resource policy, you then run the following
Resource Access Manager (RAM) operations to access and accept the shared rule group or
firewall policy. GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs)
of the resource share invitations. AcceptResourceShareInvitation - Accepts the share
invitation for a specified resource share. For additional information about resource
sharing using RAM, see Resource Access Manager User Guide.
# Arguments
- `policy`: The IAM policy statement that lists the accounts that you want to share your
rule group or firewall policy with and the operations that you want the accounts to be able
to perform. For a rule group resource, you can specify the following operations in the
Actions section of the statement: network-firewall:CreateFirewallPolicy
network-firewall:UpdateFirewallPolicy network-firewall:ListRuleGroups For a firewall
policy resource, you can specify the following operations in the Actions section of the
statement: network-firewall:AssociateFirewallPolicy
network-firewall:ListFirewallPolicies In the Resource section of the statement, you
specify the ARNs for the rule groups and firewall policies that you want to share with the
account that you specified in Arn.
- `resource_arn`: The Amazon Resource Name (ARN) of the account that you want to share rule
groups and firewall policies with.
"""
function put_resource_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"PutResourcePolicy",
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
Policy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tags to the specified resource. Tags are key:value pairs that you can
use to categorize and manage your resources, for purposes like billing. For example, you
might set the tag key to \"customer\" and the value to the customer name or ID. You can
specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
resource. You can tag the Amazon Web Services resources that you manage through Network
Firewall: firewalls, firewall policies, and rule groups.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`:
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the tags with the specified keys from the specified resource. Tags are key:value
pairs that you can use to categorize and manage your resources, for purposes like billing.
For example, you might set the tag key to \"customer\" and the value to the customer name
or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to
50 tags for a resource. You can manage tags for the Amazon Web Services resources that you
manage through Network Firewall: firewalls, firewall policies, and rule groups.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`:
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_delete_protection(delete_protection)
update_firewall_delete_protection(delete_protection, params::Dict{String,<:Any})
Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the
firewall. If the flag is set to TRUE, the firewall is protected against deletion. This
setting helps protect against accidentally deleting a firewall that's in use.
# Arguments
- `delete_protection`: A flag indicating whether it is possible to delete the firewall. A
setting of TRUE indicates that the firewall is protected against deletion. Use this setting
to protect against accidentally deleting a firewall that is in use. When you create a
firewall, the operation initializes this flag to TRUE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function update_firewall_delete_protection(
DeleteProtection; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateFirewallDeleteProtection",
Dict{String,Any}("DeleteProtection" => DeleteProtection);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_delete_protection(
DeleteProtection,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateFirewallDeleteProtection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeleteProtection" => DeleteProtection), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_description()
update_firewall_description(params::Dict{String,<:Any})
Modifies the description for the specified firewall. Use the description to help you
identify the firewall when you're working with it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The new description for the firewall. If you omit this setting, Network
Firewall removes the description for the firewall.
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function update_firewall_description(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"UpdateFirewallDescription"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_firewall_description(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateFirewallDescription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_encryption_configuration()
update_firewall_encryption_configuration(params::Dict{String,<:Any})
A complex type that contains settings for encryption of your firewall resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EncryptionConfiguration"`:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function update_firewall_encryption_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateFirewallEncryptionConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_encryption_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateFirewallEncryptionConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_policy(firewall_policy, update_token)
update_firewall_policy(firewall_policy, update_token, params::Dict{String,<:Any})
Updates the properties of the specified firewall policy.
# Arguments
- `firewall_policy`: The updated firewall policy to use for the firewall. You can't add or
remove a TLSInspectionConfiguration after you create a firewall policy. However, you can
replace an existing TLS inspection configuration with another TLSInspectionConfiguration.
- `update_token`: A token used for optimistic locking. Network Firewall returns a token to
your requests that access the firewall policy. The token marks the state of the policy
resource at the time of the request. To make changes to the policy, you provide the token
in your request. Network Firewall uses the token to ensure that the policy hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall policy again to get a current
copy of it with current token. Reapply your changes as needed, then try the operation again
using the new token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the firewall policy.
- `"DryRun"`: Indicates whether you want Network Firewall to just check the validity of the
request, rather than run the request. If set to TRUE, Network Firewall checks whether the
request can run successfully, but doesn't actually make the requested changes. The call
returns the value that the request would return if you ran it with dry run set to FALSE,
but doesn't make additions or changes to your resources. This option allows you to make
sure that you have the required permissions to run the request and that your request
parameters are valid. If set to FALSE, Network Firewall makes the requested changes to
your resources.
- `"EncryptionConfiguration"`: A complex type that contains settings for encryption of your
firewall policy resources.
- `"FirewallPolicyArn"`: The Amazon Resource Name (ARN) of the firewall policy. You must
specify the ARN or the name, and you can specify both.
- `"FirewallPolicyName"`: The descriptive name of the firewall policy. You can't change the
name of a firewall policy after you create it. You must specify the ARN or the name, and
you can specify both.
"""
function update_firewall_policy(
FirewallPolicy, UpdateToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateFirewallPolicy",
Dict{String,Any}("FirewallPolicy" => FirewallPolicy, "UpdateToken" => UpdateToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_policy(
FirewallPolicy,
UpdateToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateFirewallPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallPolicy" => FirewallPolicy, "UpdateToken" => UpdateToken
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_policy_change_protection(firewall_policy_change_protection)
update_firewall_policy_change_protection(firewall_policy_change_protection, params::Dict{String,<:Any})
Modifies the flag, ChangeProtection, which indicates whether it is possible to change the
firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting
helps protect against accidentally changing a firewall that's in use.
# Arguments
- `firewall_policy_change_protection`: A setting indicating whether the firewall is
protected against a change to the firewall policy association. Use this setting to protect
against accidentally modifying the firewall policy for a firewall that is in use. When you
create a firewall, the operation initializes this setting to TRUE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function update_firewall_policy_change_protection(
FirewallPolicyChangeProtection; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateFirewallPolicyChangeProtection",
Dict{String,Any}(
"FirewallPolicyChangeProtection" => FirewallPolicyChangeProtection
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_policy_change_protection(
FirewallPolicyChangeProtection,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateFirewallPolicyChangeProtection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallPolicyChangeProtection" => FirewallPolicyChangeProtection
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_logging_configuration()
update_logging_configuration(params::Dict{String,<:Any})
Sets the logging configuration for the specified firewall. To change the logging
configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration,
then change it and provide the modified object to this update call. You must change the
logging configuration one LogDestinationConfig at a time inside the retrieved
LoggingConfiguration object. You can perform only one of the following actions in any call
to UpdateLoggingConfiguration: Create a new log destination object by adding a single
LogDestinationConfig array element to LogDestinationConfigs. Delete a log destination
object by removing a single LogDestinationConfig array element from LogDestinationConfigs.
Change the LogDestination setting in a single LogDestinationConfig array element. You
can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these
settings, delete the existing LogDestinationConfig object and create a new one, using two
separate calls to this update operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"LoggingConfiguration"`: Defines how Network Firewall performs logging for a firewall.
If you omit this setting, Network Firewall disables logging for the firewall.
"""
function update_logging_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"UpdateLoggingConfiguration"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_logging_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateLoggingConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_group(update_token)
update_rule_group(update_token, params::Dict{String,<:Any})
Updates the rule settings for the specified rule group. You use a rule group by reference
in one or more firewall policies. When you modify a rule group, you modify all firewall
policies that use the rule group. To update a rule group, first call DescribeRuleGroup to
retrieve the current RuleGroup object, update the object as needed, and then provide the
updated object to this call.
# Arguments
- `update_token`: A token used for optimistic locking. Network Firewall returns a token to
your requests that access the rule group. The token marks the state of the rule group
resource at the time of the request. To make changes to the rule group, you provide the
token in your request. Network Firewall uses the token to ensure that the rule group hasn't
changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the rule group again to get a current copy
of it with a current token. Reapply your changes as needed, then try the operation again
using the new token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyzeRuleGroup"`: Indicates whether you want Network Firewall to analyze the
stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run
the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.
- `"Description"`: A description of the rule group.
- `"DryRun"`: Indicates whether you want Network Firewall to just check the validity of the
request, rather than run the request. If set to TRUE, Network Firewall checks whether the
request can run successfully, but doesn't actually make the requested changes. The call
returns the value that the request would return if you ran it with dry run set to FALSE,
but doesn't make additions or changes to your resources. This option allows you to make
sure that you have the required permissions to run the request and that your request
parameters are valid. If set to FALSE, Network Firewall makes the requested changes to
your resources.
- `"EncryptionConfiguration"`: A complex type that contains settings for encryption of your
rule group resources.
- `"RuleGroup"`: An object that defines the rule group rules. You must provide either
this rule group setting or a Rules setting, but not both.
- `"RuleGroupArn"`: The Amazon Resource Name (ARN) of the rule group. You must specify the
ARN or the name, and you can specify both.
- `"RuleGroupName"`: The descriptive name of the rule group. You can't change the name of a
rule group after you create it. You must specify the ARN or the name, and you can specify
both.
- `"Rules"`: A string containing stateful rule group rules specifications in Suricata flat
format, with one rule per line. Use this to import your existing Suricata compatible rule
groups. You must provide either this rules setting or a populated RuleGroup setting, but
not both. You can provide your rule group specification in Suricata flat format through
this setting when you create or update your rule group. The call response returns a
RuleGroup object that Network Firewall has populated from your string.
- `"SourceMetadata"`: A complex type that contains metadata about the rule group that your
own rule group is copied from. You can use the metadata to keep track of updates made to
the originating rule group.
- `"Type"`: Indicates whether the rule group is stateless or stateful. If the rule group is
stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN.
"""
function update_rule_group(UpdateToken; aws_config::AbstractAWSConfig=global_aws_config())
return network_firewall(
"UpdateRuleGroup",
Dict{String,Any}("UpdateToken" => UpdateToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_group(
UpdateToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateRuleGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UpdateToken" => UpdateToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subnet_change_protection(subnet_change_protection)
update_subnet_change_protection(subnet_change_protection, params::Dict{String,<:Any})
# Arguments
- `subnet_change_protection`: A setting indicating whether the firewall is protected
against changes to the subnet associations. Use this setting to protect against
accidentally modifying the subnet associations for a firewall that is in use. When you
create a firewall, the operation initializes this setting to TRUE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallArn"`: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN
or the name, and you can specify both.
- `"FirewallName"`: The descriptive name of the firewall. You can't change the name of a
firewall after you create it. You must specify the ARN or the name, and you can specify
both.
- `"UpdateToken"`: An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The token marks the
state of the firewall resource at the time of the request. To make an unconditional change
to the firewall, omit the token in your update request. Without the token, Network Firewall
performs your updates regardless of whether the firewall has changed since you last
retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the firewall hasn't changed
since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy
of it with a new token. Reapply your changes as needed, then try the operation again using
the new token.
"""
function update_subnet_change_protection(
SubnetChangeProtection; aws_config::AbstractAWSConfig=global_aws_config()
)
return network_firewall(
"UpdateSubnetChangeProtection",
Dict{String,Any}("SubnetChangeProtection" => SubnetChangeProtection);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subnet_change_protection(
SubnetChangeProtection,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateSubnetChangeProtection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SubnetChangeProtection" => SubnetChangeProtection),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_tlsinspection_configuration(tlsinspection_configuration, update_token)
update_tlsinspection_configuration(tlsinspection_configuration, update_token, params::Dict{String,<:Any})
Updates the TLS inspection configuration settings for the specified TLS inspection
configuration. You use a TLS inspection configuration by referencing it in one or more
firewall policies. When you modify a TLS inspection configuration, you modify all firewall
policies that use the TLS inspection configuration. To update a TLS inspection
configuration, first call DescribeTLSInspectionConfiguration to retrieve the current
TLSInspectionConfiguration object, update the object as needed, and then provide the
updated object to this call.
# Arguments
- `tlsinspection_configuration`: The object that defines a TLS inspection configuration.
This, along with TLSInspectionConfigurationResponse, define the TLS inspection
configuration. You can retrieve all objects for a TLS inspection configuration by calling
DescribeTLSInspectionConfiguration. Network Firewall uses a TLS inspection configuration
to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its
destination. To use a TLS inspection configuration, you add it to a new Network Firewall
firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as
a proxy service to decrypt and inspect the traffic traveling through your firewalls. You
can reference a TLS inspection configuration from more than one firewall policy, and you
can use a firewall policy in more than one firewall. For more information about using TLS
inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection
configurations in the Network Firewall Developer Guide.
- `update_token`: A token used for optimistic locking. Network Firewall returns a token to
your requests that access the TLS inspection configuration. The token marks the state of
the TLS inspection configuration resource at the time of the request. To make changes to
the TLS inspection configuration, you provide the token in your request. Network Firewall
uses the token to ensure that the TLS inspection configuration hasn't changed since you
last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If
this happens, retrieve the TLS inspection configuration again to get a current copy of it
with a current token. Reapply your changes as needed, then try the operation again using
the new token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the TLS inspection configuration.
- `"EncryptionConfiguration"`: A complex type that contains the Amazon Web Services KMS
encryption configuration settings for your TLS inspection configuration.
- `"TLSInspectionConfigurationArn"`: The Amazon Resource Name (ARN) of the TLS inspection
configuration.
- `"TLSInspectionConfigurationName"`: The descriptive name of the TLS inspection
configuration. You can't change the name of a TLS inspection configuration after you create
it.
"""
function update_tlsinspection_configuration(
TLSInspectionConfiguration,
UpdateToken;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateTLSInspectionConfiguration",
Dict{String,Any}(
"TLSInspectionConfiguration" => TLSInspectionConfiguration,
"UpdateToken" => UpdateToken,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_tlsinspection_configuration(
TLSInspectionConfiguration,
UpdateToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return network_firewall(
"UpdateTLSInspectionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TLSInspectionConfiguration" => TLSInspectionConfiguration,
"UpdateToken" => UpdateToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 110898 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: networkmanager
using AWS.Compat
using AWS.UUIDs
"""
accept_attachment(attachment_id)
accept_attachment(attachment_id, params::Dict{String,<:Any})
Accepts a core network attachment request. Once the attachment request is accepted by a
core network owner, the attachment is created and connected to a core network.
# Arguments
- `attachment_id`: The ID of the attachment.
"""
function accept_attachment(attachmentId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"POST",
"/attachments/$(attachmentId)/accept";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/attachments/$(attachmentId)/accept",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_connect_peer(connect_peer_id, device_id, global_network_id)
associate_connect_peer(connect_peer_id, device_id, global_network_id, params::Dict{String,<:Any})
Associates a core network Connect peer with a device and optionally, with a link. If you
specify a link, it must be associated with the specified device. You can only associate
core network Connect peers that have been created on a core network Connect attachment on a
core network.
# Arguments
- `connect_peer_id`: The ID of the Connect peer.
- `device_id`: The ID of the device.
- `global_network_id`: The ID of your global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkId"`: The ID of the link.
"""
function associate_connect_peer(
ConnectPeerId,
DeviceId,
globalNetworkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/connect-peer-associations",
Dict{String,Any}("ConnectPeerId" => ConnectPeerId, "DeviceId" => DeviceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_connect_peer(
ConnectPeerId,
DeviceId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/connect-peer-associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConnectPeerId" => ConnectPeerId, "DeviceId" => DeviceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_customer_gateway(customer_gateway_arn, device_id, global_network_id)
associate_customer_gateway(customer_gateway_arn, device_id, global_network_id, params::Dict{String,<:Any})
Associates a customer gateway with a device and optionally, with a link. If you specify a
link, it must be associated with the specified device. You can only associate customer
gateways that are connected to a VPN attachment on a transit gateway or core network
registered in your global network. When you register a transit gateway or core network,
customer gateways that are connected to the transit gateway are automatically included in
the global network. To list customer gateways that are connected to a transit gateway, use
the DescribeVpnConnections EC2 API and filter by transit-gateway-id. You cannot associate a
customer gateway with more than one device and link.
# Arguments
- `customer_gateway_arn`: The Amazon Resource Name (ARN) of the customer gateway.
- `device_id`: The ID of the device.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkId"`: The ID of the link.
"""
function associate_customer_gateway(
CustomerGatewayArn,
DeviceId,
globalNetworkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/customer-gateway-associations",
Dict{String,Any}(
"CustomerGatewayArn" => CustomerGatewayArn, "DeviceId" => DeviceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_customer_gateway(
CustomerGatewayArn,
DeviceId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/customer-gateway-associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomerGatewayArn" => CustomerGatewayArn, "DeviceId" => DeviceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_link(device_id, link_id, global_network_id)
associate_link(device_id, link_id, global_network_id, params::Dict{String,<:Any})
Associates a link to a device. A device can be associated to multiple links and a link can
be associated to multiple devices. The device and link must be in the same global network
and the same site.
# Arguments
- `device_id`: The ID of the device.
- `link_id`: The ID of the link.
- `global_network_id`: The ID of the global network.
"""
function associate_link(
DeviceId, LinkId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/link-associations",
Dict{String,Any}("DeviceId" => DeviceId, "LinkId" => LinkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_link(
DeviceId,
LinkId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/link-associations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeviceId" => DeviceId, "LinkId" => LinkId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_transit_gateway_connect_peer(device_id, transit_gateway_connect_peer_arn, global_network_id)
associate_transit_gateway_connect_peer(device_id, transit_gateway_connect_peer_arn, global_network_id, params::Dict{String,<:Any})
Associates a transit gateway Connect peer with a device, and optionally, with a link. If
you specify a link, it must be associated with the specified device. You can only
associate transit gateway Connect peers that have been created on a transit gateway that's
registered in your global network. You cannot associate a transit gateway Connect peer with
more than one device and link.
# Arguments
- `device_id`: The ID of the device.
- `transit_gateway_connect_peer_arn`: The Amazon Resource Name (ARN) of the Connect peer.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkId"`: The ID of the link.
"""
function associate_transit_gateway_connect_peer(
DeviceId,
TransitGatewayConnectPeerArn,
globalNetworkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/transit-gateway-connect-peer-associations",
Dict{String,Any}(
"DeviceId" => DeviceId,
"TransitGatewayConnectPeerArn" => TransitGatewayConnectPeerArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_transit_gateway_connect_peer(
DeviceId,
TransitGatewayConnectPeerArn,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/transit-gateway-connect-peer-associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceId" => DeviceId,
"TransitGatewayConnectPeerArn" => TransitGatewayConnectPeerArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connect_attachment(core_network_id, edge_location, options, transport_attachment_id)
create_connect_attachment(core_network_id, edge_location, options, transport_attachment_id, params::Dict{String,<:Any})
Creates a core network Connect attachment from a specified core network attachment. A core
network Connect attachment is a GRE-based tunnel attachment that you can use to establish a
connection between a core network and an appliance. A core network Connect attachment uses
an existing VPC attachment as the underlying transport mechanism.
# Arguments
- `core_network_id`: The ID of a core network where you want to create the attachment.
- `edge_location`: The Region where the edge is located.
- `options`: Options for creating an attachment.
- `transport_attachment_id`: The ID of the attachment between the two connections.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with the request.
- `"Tags"`: The list of key-value tags associated with the request.
"""
function create_connect_attachment(
CoreNetworkId,
EdgeLocation,
Options,
TransportAttachmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/connect-attachments",
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"EdgeLocation" => EdgeLocation,
"Options" => Options,
"TransportAttachmentId" => TransportAttachmentId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connect_attachment(
CoreNetworkId,
EdgeLocation,
Options,
TransportAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/connect-attachments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"EdgeLocation" => EdgeLocation,
"Options" => Options,
"TransportAttachmentId" => TransportAttachmentId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connect_peer(connect_attachment_id, peer_address)
create_connect_peer(connect_attachment_id, peer_address, params::Dict{String,<:Any})
Creates a core network Connect peer for a specified core network connect attachment between
a core network and an appliance. The peer address and transit gateway address must be the
same IP address family (IPv4 or IPv6).
# Arguments
- `connect_attachment_id`: The ID of the connection attachment.
- `peer_address`: The Connect peer address.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BgpOptions"`: The Connect peer BGP options. This only applies only when the protocol is
GRE.
- `"ClientToken"`: The client token associated with the request.
- `"CoreNetworkAddress"`: A Connect peer core network address. This only applies only when
the protocol is GRE.
- `"InsideCidrBlocks"`: The inside IP addresses used for BGP peering.
- `"SubnetArn"`: The subnet ARN for the Connect peer. This only applies only when the
protocol is NO_ENCAP.
- `"Tags"`: The tags associated with the peer request.
"""
function create_connect_peer(
ConnectAttachmentId, PeerAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/connect-peers",
Dict{String,Any}(
"ConnectAttachmentId" => ConnectAttachmentId,
"PeerAddress" => PeerAddress,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connect_peer(
ConnectAttachmentId,
PeerAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/connect-peers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectAttachmentId" => ConnectAttachmentId,
"PeerAddress" => PeerAddress,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connection(connected_device_id, device_id, global_network_id)
create_connection(connected_device_id, device_id, global_network_id, params::Dict{String,<:Any})
Creates a connection between two devices. The devices can be a physical or virtual
appliance that connects to a third-party appliance in a VPC, or a physical appliance that
connects to another physical appliance in an on-premises network.
# Arguments
- `connected_device_id`: The ID of the second device in the connection.
- `device_id`: The ID of the first device in the connection.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectedLinkId"`: The ID of the link for the second device.
- `"Description"`: A description of the connection. Length Constraints: Maximum length of
256 characters.
- `"LinkId"`: The ID of the link for the first device.
- `"Tags"`: The tags to apply to the resource during creation.
"""
function create_connection(
ConnectedDeviceId,
DeviceId,
globalNetworkId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/connections",
Dict{String,Any}("ConnectedDeviceId" => ConnectedDeviceId, "DeviceId" => DeviceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connection(
ConnectedDeviceId,
DeviceId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/connections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectedDeviceId" => ConnectedDeviceId, "DeviceId" => DeviceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_core_network(global_network_id)
create_core_network(global_network_id, params::Dict{String,<:Any})
Creates a core network as part of your global network, and optionally, with a core network
policy.
# Arguments
- `global_network_id`: The ID of the global network that a core network will be a part of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with a core network request.
- `"Description"`: The description of a core network.
- `"PolicyDocument"`: The policy document for creating a core network.
- `"Tags"`: Key-value tags associated with a core network request.
"""
function create_core_network(
GlobalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/core-networks",
Dict{String,Any}(
"GlobalNetworkId" => GlobalNetworkId, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_core_network(
GlobalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/core-networks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalNetworkId" => GlobalNetworkId, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device(global_network_id)
create_device(global_network_id, params::Dict{String,<:Any})
Creates a new device in a global network. If you specify both a site ID and a location, the
location of the site is used for visualization in the Network Manager console.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AWSLocation"`: The Amazon Web Services location of the device, if applicable. For an
on-premises device, you can omit this parameter.
- `"Description"`: A description of the device. Constraints: Maximum length of 256
characters.
- `"Location"`: The location of the device.
- `"Model"`: The model of the device. Constraints: Maximum length of 128 characters.
- `"SerialNumber"`: The serial number of the device. Constraints: Maximum length of 128
characters.
- `"SiteId"`: The ID of the site.
- `"Tags"`: The tags to apply to the resource during creation.
- `"Type"`: The type of the device.
- `"Vendor"`: The vendor of the device. Constraints: Maximum length of 128 characters.
"""
function create_device(globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/devices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_global_network()
create_global_network(params::Dict{String,<:Any})
Creates a new, empty global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the global network. Constraints: Maximum length of 256
characters.
- `"Tags"`: The tags to apply to the resource during creation.
"""
function create_global_network(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"POST", "/global-networks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_global_network(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/global-networks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_link(bandwidth, site_id, global_network_id)
create_link(bandwidth, site_id, global_network_id, params::Dict{String,<:Any})
Creates a new link for a specified site.
# Arguments
- `bandwidth`: The upload speed and download speed in Mbps.
- `site_id`: The ID of the site.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the link. Constraints: Maximum length of 256 characters.
- `"Provider"`: The provider of the link. Constraints: Maximum length of 128 characters.
Cannot include the following characters: | ^
- `"Tags"`: The tags to apply to the resource during creation.
- `"Type"`: The type of the link. Constraints: Maximum length of 128 characters. Cannot
include the following characters: | ^
"""
function create_link(
Bandwidth, SiteId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/links",
Dict{String,Any}("Bandwidth" => Bandwidth, "SiteId" => SiteId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_link(
Bandwidth,
SiteId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/links",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Bandwidth" => Bandwidth, "SiteId" => SiteId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_site(global_network_id)
create_site(global_network_id, params::Dict{String,<:Any})
Creates a new site in a global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of your site. Constraints: Maximum length of 256
characters.
- `"Location"`: The site location. This information is used for visualization in the
Network Manager console. If you specify the address, the latitude and longitude are
automatically calculated. Address: The physical address of the site. Latitude: The
latitude of the site. Longitude: The longitude of the site.
- `"Tags"`: The tags to apply to the resource during creation.
"""
function create_site(globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/sites";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_site(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/sites",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_site_to_site_vpn_attachment(core_network_id, vpn_connection_arn)
create_site_to_site_vpn_attachment(core_network_id, vpn_connection_arn, params::Dict{String,<:Any})
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core
network.
# Arguments
- `core_network_id`: The ID of a core network where you're creating a site-to-site VPN
attachment.
- `vpn_connection_arn`: The ARN identifying the VPN attachment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with the request.
- `"Tags"`: The tags associated with the request.
"""
function create_site_to_site_vpn_attachment(
CoreNetworkId, VpnConnectionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/site-to-site-vpn-attachments",
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"VpnConnectionArn" => VpnConnectionArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_site_to_site_vpn_attachment(
CoreNetworkId,
VpnConnectionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/site-to-site-vpn-attachments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"VpnConnectionArn" => VpnConnectionArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_peering(core_network_id, transit_gateway_arn)
create_transit_gateway_peering(core_network_id, transit_gateway_arn, params::Dict{String,<:Any})
Creates a transit gateway peering connection.
# Arguments
- `core_network_id`: The ID of a core network.
- `transit_gateway_arn`: The ARN of the transit gateway for the peering request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with the request.
- `"Tags"`: The list of key-value tags associated with the request.
"""
function create_transit_gateway_peering(
CoreNetworkId, TransitGatewayArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/transit-gateway-peerings",
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"TransitGatewayArn" => TransitGatewayArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_peering(
CoreNetworkId,
TransitGatewayArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/transit-gateway-peerings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"TransitGatewayArn" => TransitGatewayArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_route_table_attachment(peering_id, transit_gateway_route_table_arn)
create_transit_gateway_route_table_attachment(peering_id, transit_gateway_route_table_arn, params::Dict{String,<:Any})
Creates a transit gateway route table attachment.
# Arguments
- `peering_id`: The ID of the peer for the
- `transit_gateway_route_table_arn`: The ARN of the transit gateway route table for the
attachment request. For example, \"TransitGatewayRouteTableArn\":
\"arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with the request.
- `"Tags"`: The list of key-value tags associated with the request.
"""
function create_transit_gateway_route_table_attachment(
PeeringId,
TransitGatewayRouteTableArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/transit-gateway-route-table-attachments",
Dict{String,Any}(
"PeeringId" => PeeringId,
"TransitGatewayRouteTableArn" => TransitGatewayRouteTableArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_route_table_attachment(
PeeringId,
TransitGatewayRouteTableArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/transit-gateway-route-table-attachments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PeeringId" => PeeringId,
"TransitGatewayRouteTableArn" => TransitGatewayRouteTableArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_attachment(core_network_id, subnet_arns, vpc_arn)
create_vpc_attachment(core_network_id, subnet_arns, vpc_arn, params::Dict{String,<:Any})
Creates a VPC attachment on an edge location of a core network.
# Arguments
- `core_network_id`: The ID of a core network for the VPC attachment.
- `subnet_arns`: The subnet ARN of the VPC attachment.
- `vpc_arn`: The ARN of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with the request.
- `"Options"`: Options for the VPC attachment.
- `"Tags"`: The key-value tags associated with the request.
"""
function create_vpc_attachment(
CoreNetworkId, SubnetArns, VpcArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/vpc-attachments",
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"SubnetArns" => SubnetArns,
"VpcArn" => VpcArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_attachment(
CoreNetworkId,
SubnetArns,
VpcArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/vpc-attachments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CoreNetworkId" => CoreNetworkId,
"SubnetArns" => SubnetArns,
"VpcArn" => VpcArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_attachment(attachment_id)
delete_attachment(attachment_id, params::Dict{String,<:Any})
Deletes an attachment. Supports all attachment types.
# Arguments
- `attachment_id`: The ID of the attachment to delete.
"""
function delete_attachment(attachmentId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"DELETE",
"/attachments/$(attachmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/attachments/$(attachmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connect_peer(connect_peer_id)
delete_connect_peer(connect_peer_id, params::Dict{String,<:Any})
Deletes a Connect peer.
# Arguments
- `connect_peer_id`: The ID of the deleted Connect peer.
"""
function delete_connect_peer(
connectPeerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/connect-peers/$(connectPeerId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connect_peer(
connectPeerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/connect-peers/$(connectPeerId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connection(connection_id, global_network_id)
delete_connection(connection_id, global_network_id, params::Dict{String,<:Any})
Deletes the specified connection in your global network.
# Arguments
- `connection_id`: The ID of the connection.
- `global_network_id`: The ID of the global network.
"""
function delete_connection(
connectionId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/connections/$(connectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connection(
connectionId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/connections/$(connectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_core_network(core_network_id)
delete_core_network(core_network_id, params::Dict{String,<:Any})
Deletes a core network along with all core network policies. This can only be done if there
are no attachments on a core network.
# Arguments
- `core_network_id`: The network ID of the deleted core network.
"""
function delete_core_network(
coreNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/core-networks/$(coreNetworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_core_network(
coreNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/core-networks/$(coreNetworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_core_network_policy_version(core_network_id, policy_version_id)
delete_core_network_policy_version(core_network_id, policy_version_id, params::Dict{String,<:Any})
Deletes a policy version from a core network. You can't delete the current LIVE policy.
# Arguments
- `core_network_id`: The ID of a core network for the deleted policy.
- `policy_version_id`: The version ID of the deleted policy.
"""
function delete_core_network_policy_version(
coreNetworkId, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/core-networks/$(coreNetworkId)/core-network-policy-versions/$(policyVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_core_network_policy_version(
coreNetworkId,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/core-networks/$(coreNetworkId)/core-network-policy-versions/$(policyVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device(device_id, global_network_id)
delete_device(device_id, global_network_id, params::Dict{String,<:Any})
Deletes an existing device. You must first disassociate the device from any links and
customer gateways.
# Arguments
- `device_id`: The ID of the device.
- `global_network_id`: The ID of the global network.
"""
function delete_device(
deviceId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/devices/$(deviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device(
deviceId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/devices/$(deviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_global_network(global_network_id)
delete_global_network(global_network_id, params::Dict{String,<:Any})
Deletes an existing global network. You must first delete all global network objects
(devices, links, and sites), deregister all transit gateways, and delete any core networks.
# Arguments
- `global_network_id`: The ID of the global network.
"""
function delete_global_network(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_global_network(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_link(global_network_id, link_id)
delete_link(global_network_id, link_id, params::Dict{String,<:Any})
Deletes an existing link. You must first disassociate the link from any devices and
customer gateways.
# Arguments
- `global_network_id`: The ID of the global network.
- `link_id`: The ID of the link.
"""
function delete_link(
globalNetworkId, linkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/links/$(linkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_link(
globalNetworkId,
linkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/links/$(linkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_peering(peering_id)
delete_peering(peering_id, params::Dict{String,<:Any})
Deletes an existing peering connection.
# Arguments
- `peering_id`: The ID of the peering connection to delete.
"""
function delete_peering(peeringId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"DELETE",
"/peerings/$(peeringId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_peering(
peeringId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/peerings/$(peeringId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Deletes a resource policy for the specified resource. This revokes the access of the
principals specified in the resource policy.
# Arguments
- `resource_arn`: The ARN of the policy to delete.
"""
function delete_resource_policy(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/resource-policy/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/resource-policy/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_site(global_network_id, site_id)
delete_site(global_network_id, site_id, params::Dict{String,<:Any})
Deletes an existing site. The site cannot be associated with any device or link.
# Arguments
- `global_network_id`: The ID of the global network.
- `site_id`: The ID of the site.
"""
function delete_site(
globalNetworkId, siteId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/sites/$(siteId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_site(
globalNetworkId,
siteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/sites/$(siteId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_transit_gateway(global_network_id, transit_gateway_arn)
deregister_transit_gateway(global_network_id, transit_gateway_arn, params::Dict{String,<:Any})
Deregisters a transit gateway from your global network. This action does not delete your
transit gateway, or modify any of its attachments. This action removes any customer gateway
associations.
# Arguments
- `global_network_id`: The ID of the global network.
- `transit_gateway_arn`: The Amazon Resource Name (ARN) of the transit gateway.
"""
function deregister_transit_gateway(
globalNetworkId, transitGatewayArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/transit-gateway-registrations/$(transitGatewayArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_transit_gateway(
globalNetworkId,
transitGatewayArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/transit-gateway-registrations/$(transitGatewayArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_global_networks()
describe_global_networks(params::Dict{String,<:Any})
Describes one or more global networks. By default, all global networks are described. To
describe the objects in your global network, you must use the appropriate Get* action. For
example, to list the transit gateways in your global network, use
GetTransitGatewayRegistrations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"globalNetworkIds"`: The IDs of one or more global networks. The maximum is 10.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function describe_global_networks(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET", "/global-networks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_global_networks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_connect_peer(connect_peer_id, global_network_id)
disassociate_connect_peer(connect_peer_id, global_network_id, params::Dict{String,<:Any})
Disassociates a core network Connect peer from a device and a link.
# Arguments
- `connect_peer_id`: The ID of the Connect peer to disassociate from a device.
- `global_network_id`: The ID of the global network.
"""
function disassociate_connect_peer(
connectPeerId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/connect-peer-associations/$(connectPeerId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_connect_peer(
connectPeerId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/connect-peer-associations/$(connectPeerId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_customer_gateway(customer_gateway_arn, global_network_id)
disassociate_customer_gateway(customer_gateway_arn, global_network_id, params::Dict{String,<:Any})
Disassociates a customer gateway from a device and a link.
# Arguments
- `customer_gateway_arn`: The Amazon Resource Name (ARN) of the customer gateway.
- `global_network_id`: The ID of the global network.
"""
function disassociate_customer_gateway(
customerGatewayArn, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/customer-gateway-associations/$(customerGatewayArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_customer_gateway(
customerGatewayArn,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/customer-gateway-associations/$(customerGatewayArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_link(device_id, global_network_id, link_id)
disassociate_link(device_id, global_network_id, link_id, params::Dict{String,<:Any})
Disassociates an existing device from a link. You must first disassociate any customer
gateways that are associated with the link.
# Arguments
- `device_id`: The ID of the device.
- `global_network_id`: The ID of the global network.
- `link_id`: The ID of the link.
"""
function disassociate_link(
deviceId, globalNetworkId, linkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/link-associations",
Dict{String,Any}("deviceId" => deviceId, "linkId" => linkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_link(
deviceId,
globalNetworkId,
linkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/link-associations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("deviceId" => deviceId, "linkId" => linkId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_transit_gateway_connect_peer(global_network_id, transit_gateway_connect_peer_arn)
disassociate_transit_gateway_connect_peer(global_network_id, transit_gateway_connect_peer_arn, params::Dict{String,<:Any})
Disassociates a transit gateway Connect peer from a device and link.
# Arguments
- `global_network_id`: The ID of the global network.
- `transit_gateway_connect_peer_arn`: The Amazon Resource Name (ARN) of the transit gateway
Connect peer.
"""
function disassociate_transit_gateway_connect_peer(
globalNetworkId,
transitGatewayConnectPeerArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/transit-gateway-connect-peer-associations/$(transitGatewayConnectPeerArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_transit_gateway_connect_peer(
globalNetworkId,
transitGatewayConnectPeerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/global-networks/$(globalNetworkId)/transit-gateway-connect-peer-associations/$(transitGatewayConnectPeerArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_core_network_change_set(core_network_id, policy_version_id)
execute_core_network_change_set(core_network_id, policy_version_id, params::Dict{String,<:Any})
Executes a change set on your core network. Deploys changes globally based on the policy
submitted..
# Arguments
- `core_network_id`: The ID of a core network.
- `policy_version_id`: The ID of the policy version.
"""
function execute_core_network_change_set(
coreNetworkId, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/core-networks/$(coreNetworkId)/core-network-change-sets/$(policyVersionId)/execute";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_core_network_change_set(
coreNetworkId,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/core-networks/$(coreNetworkId)/core-network-change-sets/$(policyVersionId)/execute",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connect_attachment(attachment_id)
get_connect_attachment(attachment_id, params::Dict{String,<:Any})
Returns information about a core network Connect attachment.
# Arguments
- `attachment_id`: The ID of the attachment.
"""
function get_connect_attachment(
attachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/connect-attachments/$(attachmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connect_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/connect-attachments/$(attachmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connect_peer(connect_peer_id)
get_connect_peer(connect_peer_id, params::Dict{String,<:Any})
Returns information about a core network Connect peer.
# Arguments
- `connect_peer_id`: The ID of the Connect peer.
"""
function get_connect_peer(connectPeerId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/connect-peers/$(connectPeerId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connect_peer(
connectPeerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/connect-peers/$(connectPeerId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connect_peer_associations(global_network_id)
get_connect_peer_associations(global_network_id, params::Dict{String,<:Any})
Returns information about a core network Connect peer associations.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectPeerIds"`: The IDs of the Connect peers.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function get_connect_peer_associations(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/connect-peer-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connect_peer_associations(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/connect-peer-associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connections(global_network_id)
get_connections(global_network_id, params::Dict{String,<:Any})
Gets information about one or more of your connections in a global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectionIds"`: One or more connection IDs.
- `"deviceId"`: The ID of the device.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function get_connections(globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/connections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connections(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/connections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_network(core_network_id)
get_core_network(core_network_id, params::Dict{String,<:Any})
Returns information about the LIVE policy for a core network.
# Arguments
- `core_network_id`: The ID of a core network.
"""
function get_core_network(coreNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_network(
coreNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_network_change_events(core_network_id, policy_version_id)
get_core_network_change_events(core_network_id, policy_version_id, params::Dict{String,<:Any})
Returns information about a core network change event.
# Arguments
- `core_network_id`: The ID of a core network.
- `policy_version_id`: The ID of the policy version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function get_core_network_change_events(
coreNetworkId, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-change-events/$(policyVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_network_change_events(
coreNetworkId,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-change-events/$(policyVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_network_change_set(core_network_id, policy_version_id)
get_core_network_change_set(core_network_id, policy_version_id, params::Dict{String,<:Any})
Returns a change set between the LIVE core network policy and a submitted policy.
# Arguments
- `core_network_id`: The ID of a core network.
- `policy_version_id`: The ID of the policy version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function get_core_network_change_set(
coreNetworkId, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-change-sets/$(policyVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_network_change_set(
coreNetworkId,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-change-sets/$(policyVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_network_policy(core_network_id)
get_core_network_policy(core_network_id, params::Dict{String,<:Any})
Returns details about a core network policy. You can get details about your current live
policy or any previous policy version.
# Arguments
- `core_network_id`: The ID of a core network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias"`: The alias of a core network policy
- `"policyVersionId"`: The ID of a core network policy version.
"""
function get_core_network_policy(
coreNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_network_policy(
coreNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_customer_gateway_associations(global_network_id)
get_customer_gateway_associations(global_network_id, params::Dict{String,<:Any})
Gets the association information for customer gateways that are associated with devices and
links in your global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"customerGatewayArns"`: One or more customer gateway Amazon Resource Names (ARNs). The
maximum is 10.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function get_customer_gateway_associations(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/customer-gateway-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_customer_gateway_associations(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/customer-gateway-associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_devices(global_network_id)
get_devices(global_network_id, params::Dict{String,<:Any})
Gets information about one or more of your devices in a global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deviceIds"`: One or more device IDs. The maximum is 10.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"siteId"`: The ID of the site.
"""
function get_devices(globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/devices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_devices(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_link_associations(global_network_id)
get_link_associations(global_network_id, params::Dict{String,<:Any})
Gets the link associations for a device or a link. Either the device ID or the link ID must
be specified.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deviceId"`: The ID of the device.
- `"linkId"`: The ID of the link.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function get_link_associations(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/link-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_link_associations(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/link-associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_links(global_network_id)
get_links(global_network_id, params::Dict{String,<:Any})
Gets information about one or more links in a specified global network. If you specify the
site ID, you cannot specify the type or provider in the same request. You can specify the
type and provider in the same request.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"linkIds"`: One or more link IDs. The maximum is 10.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"provider"`: The link provider.
- `"siteId"`: The ID of the site.
- `"type"`: The link type.
"""
function get_links(globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/links";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_links(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/links",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_resource_counts(global_network_id)
get_network_resource_counts(global_network_id, params::Dict{String,<:Any})
Gets the count of network resources, by resource type, for the specified global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"resourceType"`: The resource type. The following are the supported resource types for
Direct Connect: dxcon dx-gateway dx-vif The following are the supported
resource types for Network Manager: attachment connect-peer connection
core-network device link peering site The following are the supported
resource types for Amazon VPC: customer-gateway transit-gateway
transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table
vpn-connection
"""
function get_network_resource_counts(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-resource-count";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_resource_counts(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-resource-count",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_resource_relationships(global_network_id)
get_network_resource_relationships(global_network_id, params::Dict{String,<:Any})
Gets the network resource relationships for the specified global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: The Amazon Web Services account ID.
- `"awsRegion"`: The Amazon Web Services Region.
- `"coreNetworkId"`: The ID of a core network.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"registeredGatewayArn"`: The ARN of the registered gateway.
- `"resourceArn"`: The ARN of the gateway.
- `"resourceType"`: The resource type. The following are the supported resource types for
Direct Connect: dxcon dx-gateway dx-vif The following are the supported
resource types for Network Manager: attachment connect-peer connection
core-network device link peering site The following are the supported
resource types for Amazon VPC: customer-gateway transit-gateway
transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table
vpn-connection
"""
function get_network_resource_relationships(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-resource-relationships";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_resource_relationships(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-resource-relationships",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_resources(global_network_id)
get_network_resources(global_network_id, params::Dict{String,<:Any})
Describes the network resources for the specified global network. The results include
information from the corresponding Describe call for the resource, minus any sensitive
information such as pre-shared keys.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: The Amazon Web Services account ID.
- `"awsRegion"`: The Amazon Web Services Region.
- `"coreNetworkId"`: The ID of a core network.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"registeredGatewayArn"`: The ARN of the gateway.
- `"resourceArn"`: The ARN of the resource.
- `"resourceType"`: The resource type. The following are the supported resource types for
Direct Connect: dxcon dx-gateway dx-vif The following are the supported
resource types for Network Manager: attachment connect-peer connection
core-network device link peering site The following are the supported
resource types for Amazon VPC: customer-gateway transit-gateway
transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table
vpn-connection
"""
function get_network_resources(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_resources(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_routes(route_table_identifier, global_network_id)
get_network_routes(route_table_identifier, global_network_id, params::Dict{String,<:Any})
Gets the network routes of the specified global network.
# Arguments
- `route_table_identifier`: The ID of the route table.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationFilters"`: Filter by route table destination. Possible Values:
TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
- `"ExactCidrMatches"`: An exact CIDR block.
- `"LongestPrefixMatches"`: The most specific route that matches the traffic (longest
prefix match).
- `"PrefixListIds"`: The IDs of the prefix lists.
- `"States"`: The route states.
- `"SubnetOfMatches"`: The routes with a subnet that match the specified CIDR filter.
- `"SupernetOfMatches"`: The routes with a CIDR that encompasses the CIDR filter. Example:
If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
- `"Types"`: The route types.
"""
function get_network_routes(
RouteTableIdentifier, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/network-routes",
Dict{String,Any}("RouteTableIdentifier" => RouteTableIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_routes(
RouteTableIdentifier,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/network-routes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RouteTableIdentifier" => RouteTableIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_telemetry(global_network_id)
get_network_telemetry(global_network_id, params::Dict{String,<:Any})
Gets the network telemetry of the specified global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: The Amazon Web Services account ID.
- `"awsRegion"`: The Amazon Web Services Region.
- `"coreNetworkId"`: The ID of a core network.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"registeredGatewayArn"`: The ARN of the gateway.
- `"resourceArn"`: The ARN of the resource.
- `"resourceType"`: The resource type. The following are the supported resource types:
connect-peer transit-gateway-connect-peer vpn-connection
"""
function get_network_telemetry(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-telemetry";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_telemetry(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/network-telemetry",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})
Returns information about a resource policy.
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function get_resource_policy(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/resource-policy/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policy(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/resource-policy/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_route_analysis(global_network_id, route_analysis_id)
get_route_analysis(global_network_id, route_analysis_id, params::Dict{String,<:Any})
Gets information about the specified route analysis.
# Arguments
- `global_network_id`: The ID of the global network.
- `route_analysis_id`: The ID of the route analysis.
"""
function get_route_analysis(
globalNetworkId, routeAnalysisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/route-analyses/$(routeAnalysisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_route_analysis(
globalNetworkId,
routeAnalysisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/route-analyses/$(routeAnalysisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_site_to_site_vpn_attachment(attachment_id)
get_site_to_site_vpn_attachment(attachment_id, params::Dict{String,<:Any})
Returns information about a site-to-site VPN attachment.
# Arguments
- `attachment_id`: The ID of the attachment.
"""
function get_site_to_site_vpn_attachment(
attachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/site-to-site-vpn-attachments/$(attachmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_site_to_site_vpn_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/site-to-site-vpn-attachments/$(attachmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sites(global_network_id)
get_sites(global_network_id, params::Dict{String,<:Any})
Gets information about one or more of your sites in a global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"siteIds"`: One or more site IDs. The maximum is 10.
"""
function get_sites(globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/sites";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sites(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/sites",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_connect_peer_associations(global_network_id)
get_transit_gateway_connect_peer_associations(global_network_id, params::Dict{String,<:Any})
Gets information about one or more of your transit gateway Connect peer associations in a
global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"transitGatewayConnectPeerArns"`: One or more transit gateway Connect peer Amazon
Resource Names (ARNs).
"""
function get_transit_gateway_connect_peer_associations(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/transit-gateway-connect-peer-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_connect_peer_associations(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/transit-gateway-connect-peer-associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_peering(peering_id)
get_transit_gateway_peering(peering_id, params::Dict{String,<:Any})
Returns information about a transit gateway peer.
# Arguments
- `peering_id`: The ID of the peering request.
"""
function get_transit_gateway_peering(
peeringId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/transit-gateway-peerings/$(peeringId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_peering(
peeringId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/transit-gateway-peerings/$(peeringId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_registrations(global_network_id)
get_transit_gateway_registrations(global_network_id, params::Dict{String,<:Any})
Gets information about the transit gateway registrations in a specified global network.
# Arguments
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"transitGatewayArns"`: The Amazon Resource Names (ARNs) of one or more transit gateways.
The maximum is 10.
"""
function get_transit_gateway_registrations(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/transit-gateway-registrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_registrations(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/global-networks/$(globalNetworkId)/transit-gateway-registrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_route_table_attachment(attachment_id)
get_transit_gateway_route_table_attachment(attachment_id, params::Dict{String,<:Any})
Returns information about a transit gateway route table attachment.
# Arguments
- `attachment_id`: The ID of the transit gateway route table attachment.
"""
function get_transit_gateway_route_table_attachment(
attachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/transit-gateway-route-table-attachments/$(attachmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_route_table_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/transit-gateway-route-table-attachments/$(attachmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vpc_attachment(attachment_id)
get_vpc_attachment(attachment_id, params::Dict{String,<:Any})
Returns information about a VPC attachment.
# Arguments
- `attachment_id`: The ID of the attachment.
"""
function get_vpc_attachment(attachmentId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET",
"/vpc-attachments/$(attachmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vpc_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/vpc-attachments/$(attachmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attachments()
list_attachments(params::Dict{String,<:Any})
Returns a list of core network attachments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachmentType"`: The type of attachment.
- `"coreNetworkId"`: The ID of a core network.
- `"edgeLocation"`: The Region where the edge is located.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"state"`: The state of the attachment.
"""
function list_attachments(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET", "/attachments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/attachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connect_peers()
list_connect_peers(params::Dict{String,<:Any})
Returns a list of core network Connect peers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectAttachmentId"`: The ID of the attachment.
- `"coreNetworkId"`: The ID of a core network.
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function list_connect_peers(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET", "/connect-peers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connect_peers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/connect-peers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_core_network_policy_versions(core_network_id)
list_core_network_policy_versions(core_network_id, params::Dict{String,<:Any})
Returns a list of core network policy versions.
# Arguments
- `core_network_id`: The ID of a core network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function list_core_network_policy_versions(
coreNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-policy-versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_core_network_policy_versions(
coreNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/core-networks/$(coreNetworkId)/core-network-policy-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_core_networks()
list_core_networks(params::Dict{String,<:Any})
Returns a list of owned and shared core networks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function list_core_networks(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET", "/core-networks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_core_networks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/core-networks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organization_service_access_status()
list_organization_service_access_status(params::Dict{String,<:Any})
Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given
Amazon Web Services Organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
"""
function list_organization_service_access_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/organizations/service-access";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organization_service_access_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/organizations/service-access",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_peerings()
list_peerings(params::Dict{String,<:Any})
Lists the peerings for a core network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"coreNetworkId"`: The ID of a core network.
- `"edgeLocation"`: Returns a list edge locations for the
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: The token for the next page of results.
- `"peeringType"`: Returns a list of a peering requests.
- `"state"`: Returns a list of the peering request states.
"""
function list_peerings(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"GET", "/peerings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_peerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET", "/peerings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_core_network_policy(policy_document, core_network_id)
put_core_network_policy(policy_document, core_network_id, params::Dict{String,<:Any})
Creates a new, immutable version of a core network policy. A subsequent change set is
created showing the differences between the LIVE policy and the submitted policy.
# Arguments
- `policy_document`: The policy document.
- `core_network_id`: The ID of a core network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The client token associated with the request.
- `"Description"`: a core network policy description.
- `"LatestVersionId"`: The ID of a core network policy.
"""
function put_core_network_policy(
PolicyDocument, coreNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/core-networks/$(coreNetworkId)/core-network-policy",
Dict{String,Any}(
"PolicyDocument" => PolicyDocument, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_core_network_policy(
PolicyDocument,
coreNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/core-networks/$(coreNetworkId)/core-network-policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyDocument" => PolicyDocument, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy_document, resource_arn)
put_resource_policy(policy_document, resource_arn, params::Dict{String,<:Any})
Creates or updates a resource policy.
# Arguments
- `policy_document`: The JSON resource policy document.
- `resource_arn`: The ARN of the resource policy.
"""
function put_resource_policy(
PolicyDocument, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/resource-policy/$(resourceArn)",
Dict{String,Any}("PolicyDocument" => PolicyDocument);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
PolicyDocument,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/resource-policy/$(resourceArn)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyDocument" => PolicyDocument), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_transit_gateway(transit_gateway_arn, global_network_id)
register_transit_gateway(transit_gateway_arn, global_network_id, params::Dict{String,<:Any})
Registers a transit gateway in your global network. Not all Regions support transit
gateways for global networks. For a list of the supported Regions, see Region Availability
in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit
gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by
the same Amazon Web Services account that owns the global network. You cannot register a
transit gateway in more than one global network.
# Arguments
- `transit_gateway_arn`: The Amazon Resource Name (ARN) of the transit gateway.
- `global_network_id`: The ID of the global network.
"""
function register_transit_gateway(
TransitGatewayArn, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/transit-gateway-registrations",
Dict{String,Any}("TransitGatewayArn" => TransitGatewayArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_transit_gateway(
TransitGatewayArn,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/transit-gateway-registrations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransitGatewayArn" => TransitGatewayArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_attachment(attachment_id)
reject_attachment(attachment_id, params::Dict{String,<:Any})
Rejects a core network attachment request.
# Arguments
- `attachment_id`: The ID of the attachment.
"""
function reject_attachment(attachmentId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"POST",
"/attachments/$(attachmentId)/reject";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/attachments/$(attachmentId)/reject",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_core_network_policy_version(core_network_id, policy_version_id)
restore_core_network_policy_version(core_network_id, policy_version_id, params::Dict{String,<:Any})
Restores a previous policy version as a new, immutable version of a core network policy. A
subsequent change set is created showing the differences between the LIVE policy and
restored policy.
# Arguments
- `core_network_id`: The ID of a core network.
- `policy_version_id`: The ID of the policy version to restore.
"""
function restore_core_network_policy_version(
coreNetworkId, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/core-networks/$(coreNetworkId)/core-network-policy-versions/$(policyVersionId)/restore";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_core_network_policy_version(
coreNetworkId,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/core-networks/$(coreNetworkId)/core-network-policy-versions/$(policyVersionId)/restore",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_organization_service_access_update(action)
start_organization_service_access_update(action, params::Dict{String,<:Any})
Enables the Network Manager service for an Amazon Web Services Organization. This can only
be called by a management account within the organization.
# Arguments
- `action`: The action to take for the update request. This can be either ENABLE or DISABLE.
"""
function start_organization_service_access_update(
Action; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/organizations/service-access",
Dict{String,Any}("Action" => Action);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_organization_service_access_update(
Action, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/organizations/service-access",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Action" => Action), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_route_analysis(destination, source, global_network_id)
start_route_analysis(destination, source, global_network_id, params::Dict{String,<:Any})
Starts analyzing the routing path between the specified source and destination. For more
information, see Route Analyzer.
# Arguments
- `destination`: The destination.
- `source`: The source from which traffic originates.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeReturnPath"`: Indicates whether to analyze the return path. The default is false.
- `"UseMiddleboxes"`: Indicates whether to include the location of middlebox appliances in
the route analysis. The default is false.
"""
function start_route_analysis(
Destination, Source, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/route-analyses",
Dict{String,Any}("Destination" => Destination, "Source" => Source);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_route_analysis(
Destination,
Source,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/global-networks/$(globalNetworkId)/route-analyses",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Destination" => Destination, "Source" => Source),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})
Tags a specified resource.
# Arguments
- `tags`: The tags to apply to the specified resource.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return networkmanager(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Tags,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The tag keys to remove from the specified resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connection(connection_id, global_network_id)
update_connection(connection_id, global_network_id, params::Dict{String,<:Any})
Updates the information for an existing connection. To remove information for any of the
parameters, specify an empty string.
# Arguments
- `connection_id`: The ID of the connection.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectedLinkId"`: The ID of the link for the second device in the connection.
- `"Description"`: A description of the connection. Length Constraints: Maximum length of
256 characters.
- `"LinkId"`: The ID of the link for the first device in the connection.
"""
function update_connection(
connectionId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/connections/$(connectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connection(
connectionId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/connections/$(connectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_core_network(core_network_id)
update_core_network(core_network_id, params::Dict{String,<:Any})
Updates the description of a core network.
# Arguments
- `core_network_id`: The ID of a core network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the update.
"""
function update_core_network(
coreNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/core-networks/$(coreNetworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_core_network(
coreNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/core-networks/$(coreNetworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_device(device_id, global_network_id)
update_device(device_id, global_network_id, params::Dict{String,<:Any})
Updates the details for an existing device. To remove information for any of the
parameters, specify an empty string.
# Arguments
- `device_id`: The ID of the device.
- `global_network_id`: The ID of the global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AWSLocation"`: The Amazon Web Services location of the device, if applicable. For an
on-premises device, you can omit this parameter.
- `"Description"`: A description of the device. Constraints: Maximum length of 256
characters.
- `"Location"`:
- `"Model"`: The model of the device. Constraints: Maximum length of 128 characters.
- `"SerialNumber"`: The serial number of the device. Constraints: Maximum length of 128
characters.
- `"SiteId"`: The ID of the site.
- `"Type"`: The type of the device.
- `"Vendor"`: The vendor of the device. Constraints: Maximum length of 128 characters.
"""
function update_device(
deviceId, globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/devices/$(deviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device(
deviceId,
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/devices/$(deviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_global_network(global_network_id)
update_global_network(global_network_id, params::Dict{String,<:Any})
Updates an existing global network. To remove information for any of the parameters,
specify an empty string.
# Arguments
- `global_network_id`: The ID of your global network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the global network. Constraints: Maximum length of 256
characters.
"""
function update_global_network(
globalNetworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_global_network(
globalNetworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_link(global_network_id, link_id)
update_link(global_network_id, link_id, params::Dict{String,<:Any})
Updates the details for an existing link. To remove information for any of the parameters,
specify an empty string.
# Arguments
- `global_network_id`: The ID of the global network.
- `link_id`: The ID of the link.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Bandwidth"`: The upload and download speed in Mbps.
- `"Description"`: A description of the link. Constraints: Maximum length of 256 characters.
- `"Provider"`: The provider of the link. Constraints: Maximum length of 128 characters.
- `"Type"`: The type of the link. Constraints: Maximum length of 128 characters.
"""
function update_link(
globalNetworkId, linkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/links/$(linkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_link(
globalNetworkId,
linkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/links/$(linkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_network_resource_metadata(metadata, global_network_id, resource_arn)
update_network_resource_metadata(metadata, global_network_id, resource_arn, params::Dict{String,<:Any})
Updates the resource metadata for the specified global network.
# Arguments
- `metadata`: The resource metadata.
- `global_network_id`: The ID of the global network.
- `resource_arn`: The ARN of the resource.
"""
function update_network_resource_metadata(
Metadata,
globalNetworkId,
resourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/network-resources/$(resourceArn)/metadata",
Dict{String,Any}("Metadata" => Metadata);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_network_resource_metadata(
Metadata,
globalNetworkId,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/network-resources/$(resourceArn)/metadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Metadata" => Metadata), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_site(global_network_id, site_id)
update_site(global_network_id, site_id, params::Dict{String,<:Any})
Updates the information for an existing site. To remove information for any of the
parameters, specify an empty string.
# Arguments
- `global_network_id`: The ID of the global network.
- `site_id`: The ID of your site.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of your site. Constraints: Maximum length of 256
characters.
- `"Location"`: The site location: Address: The physical address of the site.
Latitude: The latitude of the site. Longitude: The longitude of the site.
"""
function update_site(
globalNetworkId, siteId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/sites/$(siteId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_site(
globalNetworkId,
siteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/global-networks/$(globalNetworkId)/sites/$(siteId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vpc_attachment(attachment_id)
update_vpc_attachment(attachment_id, params::Dict{String,<:Any})
Updates a VPC attachment.
# Arguments
- `attachment_id`: The ID of the attachment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddSubnetArns"`: Adds a subnet ARN to the VPC attachment.
- `"Options"`: Additional options for updating the VPC attachment.
- `"RemoveSubnetArns"`: Removes a subnet ARN from the attachment.
"""
function update_vpc_attachment(
attachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmanager(
"PATCH",
"/vpc-attachments/$(attachmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vpc_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmanager(
"PATCH",
"/vpc-attachments/$(attachmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 16070 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: networkmonitor
using AWS.Compat
using AWS.UUIDs
"""
create_monitor(monitor_name)
create_monitor(monitor_name, params::Dict{String,<:Any})
Creates a monitor between a source subnet and destination IP address. Within a monitor
you'll create one or more probes that monitor network traffic between your source Amazon
Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and
sends metrics to Amazon CloudWatch. You can also create a monitor with probes using this
command. For each probe, you define the following: source—The subnet IDs where the
probes will be created. destination— The target destination IP address for the probe.
destinationPort—Required only if the protocol is TCP. protocol—The communication
protocol between the source and destination. This will be either TCP or ICMP.
packetSize—The size of the packets. This must be a number between 56 and 8500.
(Optional) tags —Key-value pairs created and assigned to the probe.
# Arguments
- `monitor_name`: The name identifying the monitor. It can contain only letters,
underscores (_), or dashes (-), and can be up to 200 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"aggregationPeriod"`: The time, in seconds, that metrics are aggregated and sent to
Amazon CloudWatch. Valid values are either 30 or 60. 60 is the default if no period is
chosen.
- `"clientToken"`: Unique, case-sensitive identifier to ensure the idempotency of the
request. Only returned if a client token was provided in the request.
- `"probes"`: Displays a list of all of the probes created for a monitor.
- `"tags"`: The list of key-value pairs created and assigned to the monitor.
"""
function create_monitor(monitorName; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"POST",
"/monitors",
Dict{String,Any}("monitorName" => monitorName, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_monitor(
monitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"POST",
"/monitors",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"monitorName" => monitorName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_probe(monitor_name, probe)
create_probe(monitor_name, probe, params::Dict{String,<:Any})
Create a probe within a monitor. Once you create a probe, and it begins monitoring your
network traffic, you'll incur billing charges for that probe. This action requires the
monitorName parameter. Run ListMonitors to get a list of monitor names. Note the name of
the monitorName you want to create the probe for.
# Arguments
- `monitor_name`: The name of the monitor to associated with the probe.
- `probe`: Describes the details of an individual probe for a monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure the idempotency of the
request. Only returned if a client token was provided in the request.
- `"tags"`: The list of key-value pairs created and assigned to the probe.
"""
function create_probe(monitorName, probe; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"POST",
"/monitors/$(monitorName)/probes",
Dict{String,Any}("probe" => probe, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_probe(
monitorName,
probe,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"POST",
"/monitors/$(monitorName)/probes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("probe" => probe, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_monitor(monitor_name)
delete_monitor(monitor_name, params::Dict{String,<:Any})
Deletes a specified monitor. This action requires the monitorName parameter. Run
ListMonitors to get a list of monitor names.
# Arguments
- `monitor_name`: The name of the monitor to delete.
"""
function delete_monitor(monitorName; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"DELETE",
"/monitors/$(monitorName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_monitor(
monitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"DELETE",
"/monitors/$(monitorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_probe(monitor_name, probe_id)
delete_probe(monitor_name, probe_id, params::Dict{String,<:Any})
Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing
fees for that probe. This action requires both the monitorName and probeId parameters. Run
ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and
probe IDs. You can only delete a single probe at a time using this action.
# Arguments
- `monitor_name`: The name of the monitor to delete.
- `probe_id`: The ID of the probe to delete.
"""
function delete_probe(
monitorName, probeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmonitor(
"DELETE",
"/monitors/$(monitorName)/probes/$(probeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_probe(
monitorName,
probeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"DELETE",
"/monitors/$(monitorName)/probes/$(probeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_monitor(monitor_name)
get_monitor(monitor_name, params::Dict{String,<:Any})
Returns details about a specific monitor. This action requires the monitorName parameter.
Run ListMonitors to get a list of monitor names.
# Arguments
- `monitor_name`: The name of the monitor that details are returned for.
"""
function get_monitor(monitorName; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"GET",
"/monitors/$(monitorName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_monitor(
monitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"GET",
"/monitors/$(monitorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_probe(monitor_name, probe_id)
get_probe(monitor_name, probe_id, params::Dict{String,<:Any})
Returns the details about a probe. This action requires both the monitorName and probeId
parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list
of probes and probe IDs.
# Arguments
- `monitor_name`: The name of the monitor associated with the probe. Run ListMonitors to
get a list of monitor names.
- `probe_id`: The ID of the probe to get information about. Run GetMonitor action to get a
list of probes and probe IDs for the monitor.
"""
function get_probe(monitorName, probeId; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"GET",
"/monitors/$(monitorName)/probes/$(probeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_probe(
monitorName,
probeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"GET",
"/monitors/$(monitorName)/probes/$(probeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitors()
list_monitors(params::Dict{String,<:Any})
Returns a list of all of your monitors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value. If MaxResults
is given a value larger than 100, only 100 results are returned.
- `"nextToken"`: The token for the next page of results.
- `"state"`: The list of all monitors and their states.
"""
function list_monitors(; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"GET", "/monitors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_monitors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmonitor(
"GET", "/monitors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags assigned to this resource.
# Arguments
- `resource_arn`: The
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmonitor(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds key-value pairs to a monitor or probe.
# Arguments
- `resource_arn`: The ARN of the monitor or probe to tag.
- `tags`: The list of key-value pairs assigned to the monitor or probe.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return networkmonitor(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a key-value pair from a monitor or probe.
# Arguments
- `resource_arn`: The ARN of the monitor or probe that the tag should be removed from.
- `tag_keys`: The key-value pa
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmonitor(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_monitor(aggregation_period, monitor_name)
update_monitor(aggregation_period, monitor_name, params::Dict{String,<:Any})
Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of
either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run
ListMonitors to get a list of monitor names.
# Arguments
- `aggregation_period`: The aggregation time, in seconds, to change to. This must be either
30 or 60.
- `monitor_name`: The name of the monitor to update.
"""
function update_monitor(
aggregationPeriod, monitorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmonitor(
"PATCH",
"/monitors/$(monitorName)",
Dict{String,Any}("aggregationPeriod" => aggregationPeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_monitor(
aggregationPeriod,
monitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"PATCH",
"/monitors/$(monitorName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("aggregationPeriod" => aggregationPeriod), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_probe(monitor_name, probe_id)
update_probe(monitor_name, probe_id, params::Dict{String,<:Any})
Updates a monitor probe. This action requires both the monitorName and probeId parameters.
Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and
probe IDs. You can update the following para create a monitor with probes using this
command. For each probe, you define the following: state—The state of the probe.
destination— The target destination IP address for the probe.
destinationPort—Required only if the protocol is TCP. protocol—The communication
protocol between the source and destination. This will be either TCP or ICMP.
packetSize—The size of the packets. This must be a number between 56 and 8500.
(Optional) tags —Key-value pairs created and assigned to the probe.
# Arguments
- `monitor_name`: The name of the monitor that the probe was updated for.
- `probe_id`: The ID of the probe to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destination"`: The updated IP address for the probe destination. This must be either an
IPv4 or IPv6 address.
- `"destinationPort"`: The updated port for the probe destination. This is required only if
the protocol is TCP and must be a number between 1 and 65536.
- `"packetSize"`: he updated packets size for network traffic between the source and
destination. This must be a number between 56 and 8500.
- `"protocol"`: The updated network protocol for the destination. This can be either TCP or
ICMP. If the protocol is TCP, then port is also required.
- `"state"`: The state of the probe update.
"""
function update_probe(
monitorName, probeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return networkmonitor(
"PATCH",
"/monitors/$(monitorName)/probes/$(probeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_probe(
monitorName,
probeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return networkmonitor(
"PATCH",
"/monitors/$(monitorName)/probes/$(probeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 75899 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: nimble
using AWS.Compat
using AWS.UUIDs
"""
accept_eulas(studio_id)
accept_eulas(studio_id, params::Dict{String,<:Any})
Accept EULAs.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"eulaIds"`: The EULA ID.
"""
function accept_eulas(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/eula-acceptances",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_eulas(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/eula-acceptances",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_launch_profile(ec2_subnet_ids, launch_profile_protocol_versions, name, stream_configuration, studio_component_ids, studio_id)
create_launch_profile(ec2_subnet_ids, launch_profile_protocol_versions, name, stream_configuration, studio_component_ids, studio_id, params::Dict{String,<:Any})
Create a launch profile.
# Arguments
- `ec2_subnet_ids`: Specifies the IDs of the EC2 subnets where streaming sessions will be
accessible from. These subnets must support the specified instance types.
- `launch_profile_protocol_versions`: The version number of the protocol that is used by
the launch profile. The only valid version is \"2021-03-31\".
- `name`: The name for the launch profile.
- `stream_configuration`: A configuration for a streaming session.
- `studio_component_ids`: Unique identifiers for a collection of studio components that can
be used with this launch profile.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"description"`: The description.
- `"tags"`: A collection of labels, in the form of key-value pairs, that apply to this
resource.
"""
function create_launch_profile(
ec2SubnetIds,
launchProfileProtocolVersions,
name,
streamConfiguration,
studioComponentIds,
studioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/launch-profiles",
Dict{String,Any}(
"ec2SubnetIds" => ec2SubnetIds,
"launchProfileProtocolVersions" => launchProfileProtocolVersions,
"name" => name,
"streamConfiguration" => streamConfiguration,
"studioComponentIds" => studioComponentIds,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_launch_profile(
ec2SubnetIds,
launchProfileProtocolVersions,
name,
streamConfiguration,
studioComponentIds,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/launch-profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ec2SubnetIds" => ec2SubnetIds,
"launchProfileProtocolVersions" => launchProfileProtocolVersions,
"name" => name,
"streamConfiguration" => streamConfiguration,
"studioComponentIds" => studioComponentIds,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_streaming_image(ec2_image_id, name, studio_id)
create_streaming_image(ec2_image_id, name, studio_id, params::Dict{String,<:Any})
Creates a streaming image resource in a studio.
# Arguments
- `ec2_image_id`: The ID of an EC2 machine image with which to create this streaming image.
- `name`: A friendly name for a streaming image resource.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"description"`: A human-readable description of the streaming image.
- `"tags"`: A collection of labels, in the form of key-value pairs, that apply to this
resource.
"""
function create_streaming_image(
ec2ImageId, name, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-images",
Dict{String,Any}(
"ec2ImageId" => ec2ImageId,
"name" => name,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_streaming_image(
ec2ImageId,
name,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-images",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ec2ImageId" => ec2ImageId,
"name" => name,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_streaming_session(launch_profile_id, studio_id)
create_streaming_session(launch_profile_id, studio_id, params::Dict{String,<:Any})
Creates a streaming session in a studio. After invoking this operation, you must poll
GetStreamingSession until the streaming session is in the READY state.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"ec2InstanceType"`: The EC2 Instance type used for the streaming session.
- `"ownedBy"`: The user ID of the user that owns the streaming session. The user that owns
the session will be logging into the session and interacting with the virtual workstation.
- `"streamingImageId"`: The ID of the streaming image.
- `"tags"`: A collection of labels, in the form of key-value pairs, that apply to this
resource.
"""
function create_streaming_session(
launchProfileId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions",
Dict{String,Any}(
"launchProfileId" => launchProfileId, "X-Amz-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_streaming_session(
launchProfileId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"launchProfileId" => launchProfileId,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_streaming_session_stream(session_id, studio_id)
create_streaming_session_stream(session_id, studio_id, params::Dict{String,<:Any})
Creates a streaming session stream for a streaming session. After invoking this API, invoke
GetStreamingSessionStream with the returned streamId to poll the resource until it is in
the READY state.
# Arguments
- `session_id`: The streaming session ID.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"expirationInSeconds"`: The expiration time in seconds.
"""
function create_streaming_session_stream(
sessionId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/streams",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_streaming_session_stream(
sessionId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/streams",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_studio(admin_role_arn, display_name, studio_name, user_role_arn)
create_studio(admin_role_arn, display_name, studio_name, user_role_arn, params::Dict{String,<:Any})
Create a new studio. When creating a studio, two IAM roles must be provided: the admin role
and the user role. These roles are assumed by your users when they log in to the Nimble
Studio portal. The user role must have the AmazonNimbleStudio-StudioUser managed policy
attached for the portal to function properly. The admin role must have the
AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You may optionally specify a KMS key in the StudioEncryptionConfiguration. In Nimble
Studio, resource names, descriptions, initialization scripts, and other data you provide
are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web
Services and managed on your behalf. You may provide your own KMS key when calling
CreateStudio to encrypt this data using a key you own and manage. When providing an KMS key
during studio creation, Nimble Studio creates KMS grants in your account to provide your
studio user and admin roles access to these KMS keys. If you delete this grant, the studio
will no longer be accessible to your portal users. If you delete the studio KMS key, your
studio will no longer be accessible.
# Arguments
- `admin_role_arn`: The IAM role that studio admins will assume when logging in to the
Nimble Studio portal.
- `display_name`: A friendly name for the studio.
- `studio_name`: The studio name that is used in the URL of the Nimble Studio portal when
accessed by Nimble Studio users.
- `user_role_arn`: The IAM role that studio users will assume when logging in to the Nimble
Studio portal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"studioEncryptionConfiguration"`: The studio encryption configuration.
- `"tags"`: A collection of labels, in the form of key-value pairs, that apply to this
resource.
"""
function create_studio(
adminRoleArn,
displayName,
studioName,
userRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios",
Dict{String,Any}(
"adminRoleArn" => adminRoleArn,
"displayName" => displayName,
"studioName" => studioName,
"userRoleArn" => userRoleArn,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_studio(
adminRoleArn,
displayName,
studioName,
userRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"adminRoleArn" => adminRoleArn,
"displayName" => displayName,
"studioName" => studioName,
"userRoleArn" => userRoleArn,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_studio_component(name, studio_id, type)
create_studio_component(name, studio_id, type, params::Dict{String,<:Any})
Creates a studio component resource.
# Arguments
- `name`: The name for the studio component.
- `studio_id`: The studio ID.
- `type`: The type of the studio component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"configuration"`: The configuration of the studio component, based on component type.
- `"description"`: The description.
- `"ec2SecurityGroupIds"`: The EC2 security groups that control access to the studio
component.
- `"initializationScripts"`: Initialization scripts for studio components.
- `"runtimeRoleArn"`: An IAM role attached to a Studio Component that gives the studio
component access to Amazon Web Services resources at anytime while the instance is running.
- `"scriptParameters"`: Parameters for the studio component scripts.
- `"secureInitializationRoleArn"`: An IAM role attached to Studio Component when the system
initialization script runs which give the studio component access to Amazon Web Services
resources when the system initialization script runs.
- `"subtype"`: The specific subtype of a studio component.
- `"tags"`: A collection of labels, in the form of key-value pairs, that apply to this
resource.
"""
function create_studio_component(
name, studioId, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/studio-components",
Dict{String,Any}(
"name" => name, "type" => type, "X-Amz-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_studio_component(
name,
studioId,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/studio-components",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "X-Amz-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_launch_profile(launch_profile_id, studio_id)
delete_launch_profile(launch_profile_id, studio_id, params::Dict{String,<:Any})
Permanently delete a launch profile.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_launch_profile(
launchProfileId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_launch_profile(
launchProfileId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_launch_profile_member(launch_profile_id, principal_id, studio_id)
delete_launch_profile_member(launch_profile_id, principal_id, studio_id, params::Dict{String,<:Any})
Delete a user from launch profile membership.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `principal_id`: The principal ID. This currently supports a IAM Identity Center UserId.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_launch_profile_member(
launchProfileId,
principalId,
studioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership/$(principalId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_launch_profile_member(
launchProfileId,
principalId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership/$(principalId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_streaming_image(streaming_image_id, studio_id)
delete_streaming_image(streaming_image_id, studio_id, params::Dict{String,<:Any})
Delete streaming image.
# Arguments
- `streaming_image_id`: The streaming image ID.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_streaming_image(
streamingImageId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/streaming-images/$(streamingImageId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_streaming_image(
streamingImageId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/streaming-images/$(streamingImageId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_streaming_session(session_id, studio_id)
delete_streaming_session(session_id, studio_id, params::Dict{String,<:Any})
Deletes streaming session resource. After invoking this operation, use GetStreamingSession
to poll the resource until it transitions to a DELETED state. A streaming session will
count against your streaming session quota until it is marked DELETED.
# Arguments
- `session_id`: The streaming session ID.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_streaming_session(
sessionId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_streaming_session(
sessionId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_studio(studio_id)
delete_studio(studio_id, params::Dict{String,<:Any})
Delete a studio resource.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_studio(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_studio(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_studio_component(studio_component_id, studio_id)
delete_studio_component(studio_component_id, studio_id, params::Dict{String,<:Any})
Deletes a studio component resource.
# Arguments
- `studio_component_id`: The studio component ID.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_studio_component(
studioComponentId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/studio-components/$(studioComponentId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_studio_component(
studioComponentId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/studio-components/$(studioComponentId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_studio_member(principal_id, studio_id)
delete_studio_member(principal_id, studio_id, params::Dict{String,<:Any})
Delete a user from studio membership.
# Arguments
- `principal_id`: The principal ID. This currently supports a IAM Identity Center UserId.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function delete_studio_member(
principalId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/membership/$(principalId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_studio_member(
principalId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/studios/$(studioId)/membership/$(principalId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_eula(eula_id)
get_eula(eula_id, params::Dict{String,<:Any})
Get EULA.
# Arguments
- `eula_id`: The EULA ID.
"""
function get_eula(eulaId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/eulas/$(eulaId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_eula(
eulaId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/eulas/$(eulaId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch_profile(launch_profile_id, studio_id)
get_launch_profile(launch_profile_id, studio_id, params::Dict{String,<:Any})
Get a launch profile.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `studio_id`: The studio ID.
"""
function get_launch_profile(
launchProfileId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch_profile(
launchProfileId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch_profile_details(launch_profile_id, studio_id)
get_launch_profile_details(launch_profile_id, studio_id, params::Dict{String,<:Any})
Launch profile details include the launch profile resource and summary information of
resources that are used by, or available to, the launch profile. This includes the name and
description of all studio components used by the launch profiles, and the name and
description of streaming images that can be used with this launch profile.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `studio_id`: The studio ID.
"""
function get_launch_profile_details(
launchProfileId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/details";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch_profile_details(
launchProfileId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/details",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch_profile_initialization(launch_profile_id, launch_profile_protocol_versions, launch_purpose, platform, studio_id)
get_launch_profile_initialization(launch_profile_id, launch_profile_protocol_versions, launch_purpose, platform, studio_id, params::Dict{String,<:Any})
Get a launch profile initialization.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `launch_profile_protocol_versions`: The launch profile protocol versions supported by the
client.
- `launch_purpose`: The launch purpose.
- `platform`: The platform where this Launch Profile will be used, either Windows or Linux.
- `studio_id`: The studio ID.
"""
function get_launch_profile_initialization(
launchProfileId,
launchProfileProtocolVersions,
launchPurpose,
platform,
studioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/init",
Dict{String,Any}(
"launchProfileProtocolVersions" => launchProfileProtocolVersions,
"launchPurpose" => launchPurpose,
"platform" => platform,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch_profile_initialization(
launchProfileId,
launchProfileProtocolVersions,
launchPurpose,
platform,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/init",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"launchProfileProtocolVersions" => launchProfileProtocolVersions,
"launchPurpose" => launchPurpose,
"platform" => platform,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch_profile_member(launch_profile_id, principal_id, studio_id)
get_launch_profile_member(launch_profile_id, principal_id, studio_id, params::Dict{String,<:Any})
Get a user persona in launch profile membership.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `principal_id`: The principal ID. This currently supports a IAM Identity Center UserId.
- `studio_id`: The studio ID.
"""
function get_launch_profile_member(
launchProfileId,
principalId,
studioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership/$(principalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch_profile_member(
launchProfileId,
principalId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership/$(principalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_streaming_image(streaming_image_id, studio_id)
get_streaming_image(streaming_image_id, studio_id, params::Dict{String,<:Any})
Get streaming image.
# Arguments
- `streaming_image_id`: The streaming image ID.
- `studio_id`: The studio ID.
"""
function get_streaming_image(
streamingImageId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-images/$(streamingImageId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_streaming_image(
streamingImageId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-images/$(streamingImageId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_streaming_session(session_id, studio_id)
get_streaming_session(session_id, studio_id, params::Dict{String,<:Any})
Gets StreamingSession resource. Invoke this operation to poll for a streaming session state
while creating or deleting a session.
# Arguments
- `session_id`: The streaming session ID.
- `studio_id`: The studio ID.
"""
function get_streaming_session(
sessionId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_streaming_session(
sessionId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_streaming_session_backup(backup_id, studio_id)
get_streaming_session_backup(backup_id, studio_id, params::Dict{String,<:Any})
Gets StreamingSessionBackup resource. Invoke this operation to poll for a streaming session
backup while stopping a streaming session.
# Arguments
- `backup_id`: The ID of the backup.
- `studio_id`: The studio ID.
"""
function get_streaming_session_backup(
backupId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-session-backups/$(backupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_streaming_session_backup(
backupId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-session-backups/$(backupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_streaming_session_stream(session_id, stream_id, studio_id)
get_streaming_session_stream(session_id, stream_id, studio_id, params::Dict{String,<:Any})
Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the
resource after invoking CreateStreamingSessionStream. After the StreamingSessionStream
changes to the READY state, the url property will contain a stream to be used with the DCV
streaming client.
# Arguments
- `session_id`: The streaming session ID.
- `stream_id`: The streaming session stream ID.
- `studio_id`: The studio ID.
"""
function get_streaming_session_stream(
sessionId, streamId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/streams/$(streamId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_streaming_session_stream(
sessionId,
streamId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/streams/$(streamId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_studio(studio_id)
get_studio(studio_id, params::Dict{String,<:Any})
Get a studio resource.
# Arguments
- `studio_id`: The studio ID.
"""
function get_studio(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_studio(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_studio_component(studio_component_id, studio_id)
get_studio_component(studio_component_id, studio_id, params::Dict{String,<:Any})
Gets a studio component resource.
# Arguments
- `studio_component_id`: The studio component ID.
- `studio_id`: The studio ID.
"""
function get_studio_component(
studioComponentId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/studio-components/$(studioComponentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_studio_component(
studioComponentId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/studio-components/$(studioComponentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_studio_member(principal_id, studio_id)
get_studio_member(principal_id, studio_id, params::Dict{String,<:Any})
Get a user's membership in a studio.
# Arguments
- `principal_id`: The principal ID. This currently supports a IAM Identity Center UserId.
- `studio_id`: The studio ID.
"""
function get_studio_member(
principalId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/membership/$(principalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_studio_member(
principalId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/membership/$(principalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_eula_acceptances(studio_id)
list_eula_acceptances(studio_id, params::Dict{String,<:Any})
List EULA acceptances.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eulaIds"`: The list of EULA IDs that have been previously accepted.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_eula_acceptances(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/eula-acceptances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_eula_acceptances(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/eula-acceptances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_eulas()
list_eulas(params::Dict{String,<:Any})
List EULAs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eulaIds"`: The list of EULA IDs that should be returned
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_eulas(; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET", "/2020-08-01/eulas"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_eulas(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/eulas",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_launch_profile_members(launch_profile_id, studio_id)
list_launch_profile_members(launch_profile_id, studio_id, params::Dict{String,<:Any})
Get all users in a given launch profile membership.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The max number of results to return in the response.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_launch_profile_members(
launchProfileId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_launch_profile_members(
launchProfileId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_launch_profiles(studio_id)
list_launch_profiles(studio_id, params::Dict{String,<:Any})
List all the launch profiles a studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The max number of results to return in the response.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
- `"principalId"`: The principal ID. This currently supports a IAM Identity Center UserId.
- `"states"`: Filter this request to launch profiles in any of the given states.
"""
function list_launch_profiles(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_launch_profiles(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/launch-profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streaming_images(studio_id)
list_streaming_images(studio_id, params::Dict{String,<:Any})
List the streaming image resources available to this studio. This list will contain both
images provided by Amazon Web Services, as well as streaming images that you have created
in your studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
- `"owner"`: Filter this request to streaming images with the given owner
"""
function list_streaming_images(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-images";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_streaming_images(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-images",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streaming_session_backups(studio_id)
list_streaming_session_backups(studio_id, params::Dict{String,<:Any})
Lists the backups of a streaming session in a studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
- `"ownedBy"`: The user ID of the user that owns the streaming session.
"""
function list_streaming_session_backups(
studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-session-backups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_streaming_session_backups(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-session-backups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streaming_sessions(studio_id)
list_streaming_sessions(studio_id, params::Dict{String,<:Any})
Lists the streaming sessions in a studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"createdBy"`: Filters the request to streaming sessions created by the given user.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
- `"ownedBy"`: Filters the request to streaming session owned by the given user
- `"sessionIds"`: Filters the request to only the provided session IDs.
"""
function list_streaming_sessions(
studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-sessions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_streaming_sessions(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/streaming-sessions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_studio_components(studio_id)
list_studio_components(studio_id, params::Dict{String,<:Any})
Lists the StudioComponents in a studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The max number of results to return in the response.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
- `"states"`: Filters the request to studio components that are in one of the given states.
- `"types"`: Filters the request to studio components that are of one of the given types.
"""
function list_studio_components(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/studio-components";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_studio_components(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/studio-components",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_studio_members(studio_id)
list_studio_members(studio_id, params::Dict{String,<:Any})
Get all users in a given studio membership. ListStudioMembers only returns admin members.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The max number of results to return in the response.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_studio_members(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/membership";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_studio_members(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/studios/$(studioId)/membership",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_studios()
list_studios(params::Dict{String,<:Any})
List studios in your Amazon Web Services accounts in the requested Amazon Web Services
Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_studios(; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"GET", "/2020-08-01/studios"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_studios(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/studios",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets the tags for a resource, given its Amazon Resource Names (ARN). This operation
supports ARNs for all resource types in Nimble Studio that support tags, including studio,
studio component, launch profile, streaming image, and streaming session. All resources
that can be tagged will contain an ARN property, so you do not have to create this ARN
yourself.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want to list
tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"GET",
"/2020-08-01/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"GET",
"/2020-08-01/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_launch_profile_members(identity_store_id, launch_profile_id, members, studio_id)
put_launch_profile_members(identity_store_id, launch_profile_id, members, studio_id, params::Dict{String,<:Any})
Add/update users with given persona to launch profile membership.
# Arguments
- `identity_store_id`: The ID of the identity store.
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `members`: A list of members.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function put_launch_profile_members(
identityStoreId,
launchProfileId,
members,
studioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership",
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"members" => members,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_launch_profile_members(
identityStoreId,
launchProfileId,
members,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"members" => members,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_studio_members(identity_store_id, members, studio_id)
put_studio_members(identity_store_id, members, studio_id, params::Dict{String,<:Any})
Add/update users with given persona to studio membership.
# Arguments
- `identity_store_id`: The ID of the identity store.
- `members`: A list of members.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function put_studio_members(
identityStoreId, members, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/membership",
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"members" => members,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_studio_members(
identityStoreId,
members,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/membership",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"members" => members,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_streaming_session(session_id, studio_id)
start_streaming_session(session_id, studio_id, params::Dict{String,<:Any})
Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS
state is the intermediate state between the STOPPED and READY states.
# Arguments
- `session_id`: The streaming session ID for the StartStreamingSessionRequest.
- `studio_id`: The studio ID for the StartStreamingSessionRequest.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"backupId"`: The ID of the backup.
"""
function start_streaming_session(
sessionId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/start",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_streaming_session(
sessionId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/start",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_studio_ssoconfiguration_repair(studio_id)
start_studio_ssoconfiguration_repair(studio_id, params::Dict{String,<:Any})
Repairs the IAM Identity Center configuration for a given studio. If the studio has a valid
IAM Identity Center configuration currently associated with it, this operation will fail
with a validation error. If the studio does not have a valid IAM Identity Center
configuration currently associated with it, then a new IAM Identity Center application is
created for the studio and the studio is changed to the READY state. After the IAM Identity
Center application is repaired, you must use the Amazon Nimble Studio console to add
administrators and users to your studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function start_studio_ssoconfiguration_repair(
studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"PUT",
"/2020-08-01/studios/$(studioId)/sso-configuration",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_studio_ssoconfiguration_repair(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PUT",
"/2020-08-01/studios/$(studioId)/sso-configuration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_streaming_session(session_id, studio_id)
stop_streaming_session(session_id, studio_id, params::Dict{String,<:Any})
Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS
state is the intermediate state between the READY and STOPPED states.
# Arguments
- `session_id`: The streaming session ID for the StopStreamingSessionRequest.
- `studio_id`: The studioId for the StopStreamingSessionRequest.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"volumeRetentionMode"`: Adds additional instructions to a streaming session stop action
to either retain the EBS volumes or delete the EBS volumes.
"""
function stop_streaming_session(
sessionId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/stop",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_streaming_session(
sessionId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/studios/$(studioId)/streaming-sessions/$(sessionId)/stop",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn)
tag_resource(resource_arn, params::Dict{String,<:Any})
Creates tags for a resource, given its ARN.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to add tags to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of labels, in the form of key-value pairs, that apply to this
resource.
"""
function tag_resource(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"POST",
"/2020-08-01/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"POST",
"/2020-08-01/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Deletes the tags for a resource.
# Arguments
- `resource_arn`: Identifies the Amazon Resource Name(ARN) key from which you are removing
tags.
- `tag_keys`: One or more tag keys. Specify only the tag keys, not the tag values.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"DELETE",
"/2020-08-01/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"DELETE",
"/2020-08-01/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_launch_profile(launch_profile_id, studio_id)
update_launch_profile(launch_profile_id, studio_id, params::Dict{String,<:Any})
Update a launch profile.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"description"`: The description.
- `"launchProfileProtocolVersions"`: The version number of the protocol that is used by the
launch profile. The only valid version is \"2021-03-31\".
- `"name"`: The name for the launch profile.
- `"streamConfiguration"`: A configuration for a streaming session.
- `"studioComponentIds"`: Unique identifiers for a collection of studio components that can
be used with this launch profile.
"""
function update_launch_profile(
launchProfileId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_launch_profile(
launchProfileId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_launch_profile_member(launch_profile_id, persona, principal_id, studio_id)
update_launch_profile_member(launch_profile_id, persona, principal_id, studio_id, params::Dict{String,<:Any})
Update a user persona in launch profile membership.
# Arguments
- `launch_profile_id`: The ID of the launch profile used to control access from the
streaming session.
- `persona`: The persona.
- `principal_id`: The principal ID. This currently supports a IAM Identity Center UserId.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
"""
function update_launch_profile_member(
launchProfileId,
persona,
principalId,
studioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership/$(principalId)",
Dict{String,Any}("persona" => persona, "X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_launch_profile_member(
launchProfileId,
persona,
principalId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/launch-profiles/$(launchProfileId)/membership/$(principalId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"persona" => persona, "X-Amz-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_streaming_image(streaming_image_id, studio_id)
update_streaming_image(streaming_image_id, studio_id, params::Dict{String,<:Any})
Update streaming image.
# Arguments
- `streaming_image_id`: The streaming image ID.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"description"`: The description.
- `"name"`: The name for the streaming image.
"""
function update_streaming_image(
streamingImageId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/streaming-images/$(streamingImageId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_streaming_image(
streamingImageId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/streaming-images/$(streamingImageId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_studio(studio_id)
update_studio(studio_id, params::Dict{String,<:Any})
Update a Studio resource. Currently, this operation only supports updating the displayName
of your studio.
# Arguments
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"adminRoleArn"`: The IAM role that Studio Admins will assume when logging in to the
Nimble Studio portal.
- `"displayName"`: A friendly name for the studio.
- `"userRoleArn"`: The IAM role that Studio Users will assume when logging in to the Nimble
Studio portal.
"""
function update_studio(studioId; aws_config::AbstractAWSConfig=global_aws_config())
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_studio(
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_studio_component(studio_component_id, studio_id)
update_studio_component(studio_component_id, studio_id, params::Dict{String,<:Any})
Updates a studio component resource.
# Arguments
- `studio_component_id`: The studio component ID.
- `studio_id`: The studio ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency.
- `"configuration"`: The configuration of the studio component, based on component type.
- `"description"`: The description.
- `"ec2SecurityGroupIds"`: The EC2 security groups that control access to the studio
component.
- `"initializationScripts"`: Initialization scripts for studio components.
- `"name"`: The name for the studio component.
- `"runtimeRoleArn"`: An IAM role attached to a Studio Component that gives the studio
component access to Amazon Web Services resources at anytime while the instance is running.
- `"scriptParameters"`: Parameters for the studio component scripts.
- `"secureInitializationRoleArn"`: An IAM role attached to Studio Component when the system
initialization script runs which give the studio component access to Amazon Web Services
resources when the system initialization script runs.
- `"subtype"`: The specific subtype of a studio component.
- `"type"`: The type of the studio component.
"""
function update_studio_component(
studioComponentId, studioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/studio-components/$(studioComponentId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_studio_component(
studioComponentId,
studioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return nimble(
"PATCH",
"/2020-08-01/studios/$(studioId)/studio-components/$(studioComponentId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("X-Amz-Client-Token" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 22712 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: oam
using AWS.Compat
using AWS.UUIDs
"""
create_link(label_template, resource_types, sink_identifier)
create_link(label_template, resource_types, sink_identifier, params::Dict{String,<:Any})
Creates a link between a source account and a sink that you have created in a monitoring
account. After the link is created, data is sent from the source account to the monitoring
account. When you create a link, you can optionally specify filters that specify which
metric namespaces and which log groups are shared from the source account to the monitoring
account. Before you create a link, you must create a sink in the monitoring account and
create a sink policy in that account. The sink policy must permit the source account to
link to it. You can grant permission to source accounts by granting permission to an entire
organization or to individual accounts. For more information, see CreateSink and
PutSinkPolicy. Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
# Arguments
- `label_template`: Specify a friendly human-readable name to use to identify this source
account when you are viewing data from it in the monitoring account. You can use a custom
label or use the following variables: AccountName is the name of the account
AccountEmail is the globally unique email address of the account AccountEmailNoDomain is
the email address of the account without the domain name
- `resource_types`: An array of strings that define which types of data that the source
account shares with the monitoring account.
- `sink_identifier`: The ARN of the sink to use to create this link. You can use ListSinks
to find the ARNs of sinks. For more information about sinks, see CreateSink.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkConfiguration"`: Use this structure to optionally create filters that specify that
only some metric namespaces or log groups are to be shared from the source account to the
monitoring account.
- `"Tags"`: Assigns one or more tags (key-value pairs) to the link. Tags can help you
organize and categorize your resources. You can also use them to scope user permissions by
granting a user permission to access or change only resources with certain tag values. For
more information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
"""
function create_link(
LabelTemplate,
ResourceTypes,
SinkIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/CreateLink",
Dict{String,Any}(
"LabelTemplate" => LabelTemplate,
"ResourceTypes" => ResourceTypes,
"SinkIdentifier" => SinkIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_link(
LabelTemplate,
ResourceTypes,
SinkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/CreateLink",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LabelTemplate" => LabelTemplate,
"ResourceTypes" => ResourceTypes,
"SinkIdentifier" => SinkIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sink(name)
create_sink(name, params::Dict{String,<:Any})
Use this to create a sink in the current account, so that it can be used as a monitoring
account in CloudWatch cross-account observability. A sink is a resource that represents an
attachment point in a monitoring account. Source accounts can link to the sink to send
observability data. After you create a sink, you must create a sink policy that allows
source accounts to attach to it. For more information, see PutSinkPolicy. Each account can
contain one sink per Region. If you delete a sink, you can then create a new one in that
Region.
# Arguments
- `name`: A name for the sink.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Assigns one or more tags (key-value pairs) to the link. Tags can help you
organize and categorize your resources. You can also use them to scope user permissions by
granting a user permission to access or change only resources with certain tag values. For
more information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
"""
function create_sink(Name; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"POST",
"/CreateSink",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sink(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"POST",
"/CreateSink",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_link(identifier)
delete_link(identifier, params::Dict{String,<:Any})
Deletes a link between a monitoring account sink and a source account. You must run this
operation in the source account.
# Arguments
- `identifier`: The ARN of the link to delete.
"""
function delete_link(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"POST",
"/DeleteLink",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_link(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/DeleteLink",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sink(identifier)
delete_sink(identifier, params::Dict{String,<:Any})
Deletes a sink. You must delete all links to a sink before you can delete that sink.
# Arguments
- `identifier`: The ARN of the sink to delete.
"""
function delete_sink(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"POST",
"/DeleteSink",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sink(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/DeleteSink",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_link(identifier)
get_link(identifier, params::Dict{String,<:Any})
Returns complete information about one link. To use this operation, provide the link ARN.
To retrieve a list of link ARNs, use ListLinks.
# Arguments
- `identifier`: The ARN of the link to retrieve information for.
"""
function get_link(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"POST",
"/GetLink",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_link(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/GetLink",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sink(identifier)
get_sink(identifier, params::Dict{String,<:Any})
Returns complete information about one monitoring account sink. To use this operation,
provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
# Arguments
- `identifier`: The ARN of the sink to retrieve information for.
"""
function get_sink(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"POST",
"/GetSink",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sink(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/GetSink",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sink_policy(sink_identifier)
get_sink_policy(sink_identifier, params::Dict{String,<:Any})
Returns the current sink policy attached to this sink. The sink policy specifies what
accounts can attach to this sink as source accounts, and what types of data they can share.
# Arguments
- `sink_identifier`: The ARN of the sink to retrieve the policy of.
"""
function get_sink_policy(SinkIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"POST",
"/GetSinkPolicy",
Dict{String,Any}("SinkIdentifier" => SinkIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sink_policy(
SinkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/GetSinkPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SinkIdentifier" => SinkIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attached_links(sink_identifier)
list_attached_links(sink_identifier, params::Dict{String,<:Any})
Returns a list of source account links that are linked to this monitoring account sink. To
use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
# Arguments
- `sink_identifier`: The ARN of the sink that you want to retrieve links for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Limits the number of returned links to the specified number.
- `"NextToken"`: The token for the next set of items to return. You received this token
from a previous call.
"""
function list_attached_links(
SinkIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"POST",
"/ListAttachedLinks",
Dict{String,Any}("SinkIdentifier" => SinkIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attached_links(
SinkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/ListAttachedLinks",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SinkIdentifier" => SinkIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_links()
list_links(params::Dict{String,<:Any})
Use this operation in a source account to return a list of links to monitoring account
sinks that this source account has. To find a list of links for one monitoring account
sink, use ListAttachedLinks from within the monitoring account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Limits the number of returned links to the specified number.
- `"NextToken"`: The token for the next set of items to return. You received this token
from a previous call.
"""
function list_links(; aws_config::AbstractAWSConfig=global_aws_config())
return oam("POST", "/ListLinks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_links(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"POST", "/ListLinks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_sinks()
list_sinks(params::Dict{String,<:Any})
Use this operation in a monitoring account to return the list of sinks created in that
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Limits the number of returned links to the specified number.
- `"NextToken"`: The token for the next set of items to return. You received this token
from a previous call.
"""
function list_sinks(; aws_config::AbstractAWSConfig=global_aws_config())
return oam("POST", "/ListSinks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_sinks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"POST", "/ListSinks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Displays the tags associated with a resource. Both sinks and links support tagging.
# Arguments
- `resource_arn`: The ARN of the resource that you want to view tags for. The ARN format of
a sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is
arn:aws:oam:Region:account-id:link/link-id For more information about ARN format, see
CloudWatch Logs resources and operations. Unlike tagging permissions in other Amazon Web
Services services, to retrieve the list of tags for links or sinks you must have the
oam:RequestTag permission. The aws:ReguestTag permission does not allow you to tag and
untag links and sinks.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_sink_policy(policy, sink_identifier)
put_sink_policy(policy, sink_identifier, params::Dict{String,<:Any})
Creates or updates the resource policy that grants permissions to source accounts to link
to the monitoring account sink. When you create a sink policy, you can grant permissions to
all accounts in an organization or to individual accounts. You can also use a sink policy
to limit the types of data that is shared. The three types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric Log groups - Specify with
AWS::Logs::LogGroup Traces - Specify with AWS::XRay::Trace Application Insights -
Applications - Specify with AWS::ApplicationInsights::Application See the examples in
this section to see how to specify permitted source accounts and data types.
# Arguments
- `policy`: The JSON policy to use. If you are updating an existing policy, the entire
existing policy is replaced by what you specify here. The policy must be in JSON string
format with quotation marks escaped and no newlines. For examples of different types of
policies, see the Examples section on this page.
- `sink_identifier`: The ARN of the sink to attach this policy to.
"""
function put_sink_policy(
Policy, SinkIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"POST",
"/PutSinkPolicy",
Dict{String,Any}("Policy" => Policy, "SinkIdentifier" => SinkIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_sink_policy(
Policy,
SinkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/PutSinkPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "SinkIdentifier" => SinkIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links
can be tagged. 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 resource that already has tags. If you specify a new tag key for the alarm,
this tag is appended to the list of tags associated with the alarm. If you specify a tag
key that is already associated with the alarm, the new tag value that you specify replaces
the previous value for that tag. You can associate as many as 50 tags with a resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and
sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not
allow you to tag and untag links and sinks.
# Arguments
- `resource_arn`: The ARN of the resource that you're adding tags to. The ARN format of a
sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is
arn:aws:oam:Region:account-id:link/link-id For more information about ARN format, see
CloudWatch Logs resources and operations.
- `tags`: The list of key-value pairs to associate with the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return oam(
"PUT",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"PUT",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from the specified resource. Unlike tagging permissions in other
Amazon Web Services services, to tag or untag links and sinks you must have the
oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and
untag links and sinks.
# Arguments
- `resource_arn`: The ARN of the resource that you're removing tags from. The ARN format of
a sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is
arn:aws:oam:Region:account-id:link/link-id For more information about ARN format, see
CloudWatch Logs resources and operations.
- `tag_keys`: The list of tag keys to remove from the resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_link(identifier, resource_types)
update_link(identifier, resource_types, params::Dict{String,<:Any})
Use this operation to change what types of data are shared from a source account to its
linked monitoring account sink. You can't change the sink or change the monitoring account
with this operation. When you update a link, you can optionally specify filters that
specify which metric namespaces and which log groups are shared from the source account to
the monitoring account. To update the list of tags associated with the sink, use
TagResource.
# Arguments
- `identifier`: The ARN of the link that you want to update.
- `resource_types`: An array of strings that define which types of data that the source
account will send to the monitoring account. Your input here replaces the current set of
data types that are shared.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkConfiguration"`: Use this structure to filter which metric namespaces and which log
groups are to be shared from the source account to the monitoring account.
"""
function update_link(
Identifier, ResourceTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return oam(
"POST",
"/UpdateLink",
Dict{String,Any}("Identifier" => Identifier, "ResourceTypes" => ResourceTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_link(
Identifier,
ResourceTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return oam(
"POST",
"/UpdateLink",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identifier" => Identifier, "ResourceTypes" => ResourceTypes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 88978 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: omics
using AWS.Compat
using AWS.UUIDs
"""
abort_multipart_read_set_upload(sequence_store_id, upload_id)
abort_multipart_read_set_upload(sequence_store_id, upload_id, params::Dict{String,<:Any})
Stops a multipart upload.
# Arguments
- `sequence_store_id`: The sequence store ID for the store involved in the multipart upload.
- `upload_id`: The ID for the multipart upload.
"""
function abort_multipart_read_set_upload(
sequenceStoreId, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/abort";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function abort_multipart_read_set_upload(
sequenceStoreId,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"DELETE",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/abort",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_share(share_id)
accept_share(share_id, params::Dict{String,<:Any})
Accept a resource share request.
# Arguments
- `share_id`: The ID of the resource share.
"""
function accept_share(shareId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/share/$(shareId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function accept_share(
shareId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/share/$(shareId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_read_set(ids, sequence_store_id)
batch_delete_read_set(ids, sequence_store_id, params::Dict{String,<:Any})
Deletes one or more read sets.
# Arguments
- `ids`: The read sets' IDs.
- `sequence_store_id`: The read sets' sequence store ID.
"""
function batch_delete_read_set(
ids, sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/readset/batch/delete",
Dict{String,Any}("ids" => ids);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_read_set(
ids,
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/readset/batch/delete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ids" => ids), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_annotation_import_job(job_id)
cancel_annotation_import_job(job_id, params::Dict{String,<:Any})
Cancels an annotation import job.
# Arguments
- `job_id`: The job's ID.
"""
function cancel_annotation_import_job(
jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/import/annotation/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_annotation_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/import/annotation/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_run(id)
cancel_run(id, params::Dict{String,<:Any})
Cancels a run.
# Arguments
- `id`: The run's ID.
"""
function cancel_run(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/run/$(id)/cancel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function cancel_run(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/run/$(id)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_variant_import_job(job_id)
cancel_variant_import_job(job_id, params::Dict{String,<:Any})
Cancels a variant import job.
# Arguments
- `job_id`: The job's ID.
"""
function cancel_variant_import_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE",
"/import/variant/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_variant_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/import/variant/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_multipart_read_set_upload(parts, sequence_store_id, upload_id)
complete_multipart_read_set_upload(parts, sequence_store_id, upload_id, params::Dict{String,<:Any})
Concludes a multipart upload once you have uploaded all the components.
# Arguments
- `parts`: The individual uploads or parts of a multipart upload.
- `sequence_store_id`: The sequence store ID for the store involved in the multipart upload.
- `upload_id`: The ID for the multipart upload.
"""
function complete_multipart_read_set_upload(
parts, sequenceStoreId, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/complete",
Dict{String,Any}("parts" => parts);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_multipart_read_set_upload(
parts,
sequenceStoreId,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/complete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("parts" => parts), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_annotation_store(store_format)
create_annotation_store(store_format, params::Dict{String,<:Any})
Creates an annotation store.
# Arguments
- `store_format`: The annotation file format of the store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the store.
- `"name"`: A name for the store.
- `"reference"`: The genome reference for the store's annotations.
- `"sseConfig"`: Server-side encryption (SSE) settings for the store.
- `"storeOptions"`: File parsing options for the annotation store.
- `"tags"`: Tags for the store.
- `"versionName"`: The name given to an annotation store version to distinguish it from
other versions.
"""
function create_annotation_store(
storeFormat; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore",
Dict{String,Any}("storeFormat" => storeFormat);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_annotation_store(
storeFormat,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/annotationStore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("storeFormat" => storeFormat), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_annotation_store_version(name, version_name)
create_annotation_store_version(name, version_name, params::Dict{String,<:Any})
Creates a new version of an annotation store.
# Arguments
- `name`: The name of an annotation store version from which versions are being created.
- `version_name`: The name given to an annotation store version to distinguish it from
other versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of an annotation store version.
- `"tags"`: Any tags added to annotation store version.
- `"versionOptions"`: The options for an annotation store version.
"""
function create_annotation_store_version(
name, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore/$(name)/version",
Dict{String,Any}("versionName" => versionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_annotation_store_version(
name,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/annotationStore/$(name)/version",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("versionName" => versionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_multipart_read_set_upload(name, sample_id, sequence_store_id, source_file_type, subject_id)
create_multipart_read_set_upload(name, sample_id, sequence_store_id, source_file_type, subject_id, params::Dict{String,<:Any})
Begins a multipart read set upload.
# Arguments
- `name`: The name of the read set.
- `sample_id`: The source's sample ID.
- `sequence_store_id`: The sequence store ID for the store that is the destination of the
multipart uploads.
- `source_file_type`: The type of file being uploaded.
- `subject_id`: The source's subject ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: An idempotency token that can be used to avoid triggering multiple
multipart uploads.
- `"description"`: The description of the read set.
- `"generatedFrom"`: Where the source originated.
- `"referenceArn"`: The ARN of the reference.
- `"tags"`: Any tags to add to the read set.
"""
function create_multipart_read_set_upload(
name,
sampleId,
sequenceStoreId,
sourceFileType,
subjectId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/upload",
Dict{String,Any}(
"name" => name,
"sampleId" => sampleId,
"sourceFileType" => sourceFileType,
"subjectId" => subjectId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_multipart_read_set_upload(
name,
sampleId,
sequenceStoreId,
sourceFileType,
subjectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/upload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"sampleId" => sampleId,
"sourceFileType" => sourceFileType,
"subjectId" => subjectId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_reference_store(name)
create_reference_store(name, params::Dict{String,<:Any})
Creates a reference store.
# Arguments
- `name`: A name for the store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: To ensure that requests don't run multiple times, specify a unique token
for each request.
- `"description"`: A description for the store.
- `"sseConfig"`: Server-side encryption (SSE) settings for the store.
- `"tags"`: Tags for the store.
"""
function create_reference_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/referencestore",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_reference_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/referencestore",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_run_group(request_id)
create_run_group(request_id, params::Dict{String,<:Any})
Creates a run group.
# Arguments
- `request_id`: To ensure that requests don't run multiple times, specify a unique ID for
each request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxCpus"`: The maximum number of CPUs to use in the group.
- `"maxDuration"`: A maximum run time for the group in minutes.
- `"maxGpus"`: The maximum GPUs that can be used by a run group.
- `"maxRuns"`: The maximum number of concurrent runs for the group.
- `"name"`: A name for the group.
- `"tags"`: Tags for the group.
"""
function create_run_group(requestId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/runGroup",
Dict{String,Any}("requestId" => requestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_run_group(
requestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/runGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestId" => requestId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sequence_store(name)
create_sequence_store(name, params::Dict{String,<:Any})
Creates a sequence store.
# Arguments
- `name`: A name for the store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: To ensure that requests don't run multiple times, specify a unique token
for each request.
- `"description"`: A description for the store.
- `"eTagAlgorithmFamily"`: The ETag algorithm family to use for ingested read sets.
- `"fallbackLocation"`: An S3 location that is used to store files that have failed a
direct upload.
- `"sseConfig"`: Server-side encryption (SSE) settings for the store.
- `"tags"`: Tags for the store.
"""
function create_sequence_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/sequencestore",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sequence_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_share(principal_subscriber, resource_arn)
create_share(principal_subscriber, resource_arn, params::Dict{String,<:Any})
Creates a cross-account shared resource. The resource owner makes an offer to share the
resource with the principal subscriber (an AWS user with a different account than the
resource owner). The following resources support cross-account sharing: Healthomics
variant stores Healthomics annotation stores Private workflows
# Arguments
- `principal_subscriber`: The principal subscriber is the account being offered shared
access to the resource.
- `resource_arn`: The ARN of the resource to be shared.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"shareName"`: A name that the owner defines for the share.
"""
function create_share(
principalSubscriber, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/share",
Dict{String,Any}(
"principalSubscriber" => principalSubscriber, "resourceArn" => resourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_share(
principalSubscriber,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/share",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"principalSubscriber" => principalSubscriber,
"resourceArn" => resourceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_variant_store(reference)
create_variant_store(reference, params::Dict{String,<:Any})
Creates a variant store.
# Arguments
- `reference`: The genome reference for the store's variants.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the store.
- `"name"`: A name for the store.
- `"sseConfig"`: Server-side encryption (SSE) settings for the store.
- `"tags"`: Tags for the store.
"""
function create_variant_store(reference; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/variantStore",
Dict{String,Any}("reference" => reference);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_variant_store(
reference,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/variantStore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("reference" => reference), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow(request_id)
create_workflow(request_id, params::Dict{String,<:Any})
Creates a workflow.
# Arguments
- `request_id`: To ensure that requests don't run multiple times, specify a unique ID for
each request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accelerators"`: The computational accelerator specified to run the workflow.
- `"definitionUri"`: The URI of a definition for the workflow.
- `"definitionZip"`: A ZIP archive for the workflow.
- `"description"`: A description for the workflow.
- `"engine"`: An engine for the workflow.
- `"main"`: The path of the main definition file for the workflow.
- `"name"`: A name for the workflow.
- `"parameterTemplate"`: A parameter template for the workflow.
- `"storageCapacity"`: The storage capacity for the workflow in gibibytes.
- `"tags"`: Tags for the workflow.
"""
function create_workflow(requestId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/workflow",
Dict{String,Any}("requestId" => requestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow(
requestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/workflow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestId" => requestId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_annotation_store(name)
delete_annotation_store(name, params::Dict{String,<:Any})
Deletes an annotation store.
# Arguments
- `name`: The store's name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: Whether to force deletion.
"""
function delete_annotation_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE",
"/annotationStore/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_annotation_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/annotationStore/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_annotation_store_versions(name, versions)
delete_annotation_store_versions(name, versions, params::Dict{String,<:Any})
Deletes one or multiple versions of an annotation store.
# Arguments
- `name`: The name of the annotation store from which versions are being deleted.
- `versions`: The versions of an annotation store to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: Forces the deletion of an annotation store version when imports are
in-progress..
"""
function delete_annotation_store_versions(
name, versions; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore/$(name)/versions/delete",
Dict{String,Any}("versions" => versions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_annotation_store_versions(
name,
versions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/annotationStore/$(name)/versions/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("versions" => versions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_reference(id, reference_store_id)
delete_reference(id, reference_store_id, params::Dict{String,<:Any})
Deletes a genome reference.
# Arguments
- `id`: The reference's ID.
- `reference_store_id`: The reference's store ID.
"""
function delete_reference(
id, referenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/referencestore/$(referenceStoreId)/reference/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_reference(
id,
referenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"DELETE",
"/referencestore/$(referenceStoreId)/reference/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_reference_store(id)
delete_reference_store(id, params::Dict{String,<:Any})
Deletes a genome reference store.
# Arguments
- `id`: The store's ID.
"""
function delete_reference_store(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE",
"/referencestore/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_reference_store(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/referencestore/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_run(id)
delete_run(id, params::Dict{String,<:Any})
Deletes a workflow run.
# Arguments
- `id`: The run's ID.
"""
function delete_run(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE", "/run/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_run(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/run/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_run_group(id)
delete_run_group(id, params::Dict{String,<:Any})
Deletes a workflow run group.
# Arguments
- `id`: The run group's ID.
"""
function delete_run_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE", "/runGroup/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_run_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/runGroup/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sequence_store(id)
delete_sequence_store(id, params::Dict{String,<:Any})
Deletes a sequence store.
# Arguments
- `id`: The sequence store's ID.
"""
function delete_sequence_store(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE",
"/sequencestore/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sequence_store(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/sequencestore/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_share(share_id)
delete_share(share_id, params::Dict{String,<:Any})
Deletes a resource share. If you are the resource owner, the subscriber will no longer have
access to the shared resource. If you are the subscriber, this operation deletes your
access to the share.
# Arguments
- `share_id`: The ID for the resource share to be deleted.
"""
function delete_share(shareId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE",
"/share/$(shareId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_share(
shareId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/share/$(shareId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_variant_store(name)
delete_variant_store(name, params::Dict{String,<:Any})
Deletes a variant store.
# Arguments
- `name`: The store's name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: Whether to force deletion.
"""
function delete_variant_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE",
"/variantStore/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_variant_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/variantStore/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(id)
delete_workflow(id, params::Dict{String,<:Any})
Deletes a workflow.
# Arguments
- `id`: The workflow's ID.
"""
function delete_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"DELETE", "/workflow/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/workflow/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_annotation_import_job(job_id)
get_annotation_import_job(job_id, params::Dict{String,<:Any})
Gets information about an annotation import job.
# Arguments
- `job_id`: The job's ID.
"""
function get_annotation_import_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/import/annotation/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_annotation_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/import/annotation/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_annotation_store(name)
get_annotation_store(name, params::Dict{String,<:Any})
Gets information about an annotation store.
# Arguments
- `name`: The store's name.
"""
function get_annotation_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/annotationStore/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_annotation_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/annotationStore/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_annotation_store_version(name, version_name)
get_annotation_store_version(name, version_name, params::Dict{String,<:Any})
Retrieves the metadata for an annotation store version.
# Arguments
- `name`: The name given to an annotation store version to distinguish it from others.
- `version_name`: The name given to an annotation store version to distinguish it from
others.
"""
function get_annotation_store_version(
name, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/annotationStore/$(name)/version/$(versionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_annotation_store_version(
name,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/annotationStore/$(name)/version/$(versionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_read_set(id, part_number, sequence_store_id)
get_read_set(id, part_number, sequence_store_id, params::Dict{String,<:Any})
Gets a file from a read set.
# Arguments
- `id`: The read set's ID.
- `part_number`: The part number to retrieve.
- `sequence_store_id`: The read set's sequence store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"file"`: The file to retrieve.
"""
function get_read_set(
id, partNumber, sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/readset/$(id)",
Dict{String,Any}("partNumber" => partNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_read_set(
id,
partNumber,
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/readset/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("partNumber" => partNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_read_set_activation_job(id, sequence_store_id)
get_read_set_activation_job(id, sequence_store_id, params::Dict{String,<:Any})
Gets information about a read set activation job.
# Arguments
- `id`: The job's ID.
- `sequence_store_id`: The job's sequence store ID.
"""
function get_read_set_activation_job(
id, sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/activationjob/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_read_set_activation_job(
id,
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/activationjob/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_read_set_export_job(id, sequence_store_id)
get_read_set_export_job(id, sequence_store_id, params::Dict{String,<:Any})
Gets information about a read set export job.
# Arguments
- `id`: The job's ID.
- `sequence_store_id`: The job's sequence store ID.
"""
function get_read_set_export_job(
id, sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/exportjob/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_read_set_export_job(
id,
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/exportjob/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_read_set_import_job(id, sequence_store_id)
get_read_set_import_job(id, sequence_store_id, params::Dict{String,<:Any})
Gets information about a read set import job.
# Arguments
- `id`: The job's ID.
- `sequence_store_id`: The job's sequence store ID.
"""
function get_read_set_import_job(
id, sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/importjob/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_read_set_import_job(
id,
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/importjob/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_read_set_metadata(id, sequence_store_id)
get_read_set_metadata(id, sequence_store_id, params::Dict{String,<:Any})
Gets details about a read set.
# Arguments
- `id`: The read set's ID.
- `sequence_store_id`: The read set's sequence store ID.
"""
function get_read_set_metadata(
id, sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/readset/$(id)/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_read_set_metadata(
id,
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/sequencestore/$(sequenceStoreId)/readset/$(id)/metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reference(id, part_number, reference_store_id)
get_reference(id, part_number, reference_store_id, params::Dict{String,<:Any})
Gets a reference file.
# Arguments
- `id`: The reference's ID.
- `part_number`: The part number to retrieve.
- `reference_store_id`: The reference's store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Range"`: The range to retrieve.
- `"file"`: The file to retrieve.
"""
function get_reference(
id, partNumber, referenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/referencestore/$(referenceStoreId)/reference/$(id)",
Dict{String,Any}("partNumber" => partNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reference(
id,
partNumber,
referenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/referencestore/$(referenceStoreId)/reference/$(id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("partNumber" => partNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reference_import_job(id, reference_store_id)
get_reference_import_job(id, reference_store_id, params::Dict{String,<:Any})
Gets information about a reference import job.
# Arguments
- `id`: The job's ID.
- `reference_store_id`: The job's reference store ID.
"""
function get_reference_import_job(
id, referenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/referencestore/$(referenceStoreId)/importjob/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reference_import_job(
id,
referenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/referencestore/$(referenceStoreId)/importjob/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reference_metadata(id, reference_store_id)
get_reference_metadata(id, reference_store_id, params::Dict{String,<:Any})
Gets information about a genome reference's metadata.
# Arguments
- `id`: The reference's ID.
- `reference_store_id`: The reference's reference store ID.
"""
function get_reference_metadata(
id, referenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/referencestore/$(referenceStoreId)/reference/$(id)/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reference_metadata(
id,
referenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/referencestore/$(referenceStoreId)/reference/$(id)/metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reference_store(id)
get_reference_store(id, params::Dict{String,<:Any})
Gets information about a reference store.
# Arguments
- `id`: The store's ID.
"""
function get_reference_store(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/referencestore/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reference_store(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/referencestore/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_run(id)
get_run(id, params::Dict{String,<:Any})
Gets information about a workflow run. If a workflow is shared with you, you cannot export
information about the run.
# Arguments
- `id`: The run's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"export"`: The run's export format.
"""
function get_run(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET", "/run/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_run(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET", "/run/$(id)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_run_group(id)
get_run_group(id, params::Dict{String,<:Any})
Gets information about a workflow run group.
# Arguments
- `id`: The group's ID.
"""
function get_run_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET", "/runGroup/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_run_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/runGroup/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_run_task(id, task_id)
get_run_task(id, task_id, params::Dict{String,<:Any})
Gets information about a workflow run task.
# Arguments
- `id`: The workflow run ID.
- `task_id`: The task's ID.
"""
function get_run_task(id, taskId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/run/$(id)/task/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_run_task(
id,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/run/$(id)/task/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sequence_store(id)
get_sequence_store(id, params::Dict{String,<:Any})
Gets information about a sequence store.
# Arguments
- `id`: The store's ID.
"""
function get_sequence_store(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/sequencestore/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sequence_store(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/sequencestore/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_share(share_id)
get_share(share_id, params::Dict{String,<:Any})
Retrieves the metadata for the specified resource share.
# Arguments
- `share_id`: The ID of the share.
"""
function get_share(shareId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET", "/share/$(shareId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_share(
shareId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/share/$(shareId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_variant_import_job(job_id)
get_variant_import_job(job_id, params::Dict{String,<:Any})
Gets information about a variant import job.
# Arguments
- `job_id`: The job's ID.
"""
function get_variant_import_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/import/variant/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_variant_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/import/variant/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_variant_store(name)
get_variant_store(name, params::Dict{String,<:Any})
Gets information about a variant store.
# Arguments
- `name`: The store's name.
"""
function get_variant_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET",
"/variantStore/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_variant_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/variantStore/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow(id)
get_workflow(id, params::Dict{String,<:Any})
Gets information about a workflow. If a workflow is shared with you, you cannot export the
workflow.
# Arguments
- `id`: The workflow's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"export"`: The export format for the workflow.
- `"type"`: The workflow's type.
- `"workflowOwnerId"`: The ID of the workflow owner.
"""
function get_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET", "/workflow/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/workflow/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_annotation_import_jobs()
list_annotation_import_jobs(params::Dict{String,<:Any})
Retrieves a list of annotation import jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"ids"`: IDs of annotation import jobs to retrieve.
- `"maxResults"`: The maximum number of jobs to return in one page of results.
- `"nextToken"`: Specifies the pagination token from a previous request to retrieve the
next page of results.
"""
function list_annotation_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/import/annotations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_annotation_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/import/annotations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_annotation_store_versions(name)
list_annotation_store_versions(name, params::Dict{String,<:Any})
Lists the versions of an annotation store.
# Arguments
- `name`: The name of an annotation store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list of annotation store versions.
- `"maxResults"`: The maximum number of annotation store versions to return in one page of
results.
- `"nextToken"`: Specifies the pagination token from a previous request to retrieve the
next page of results.
"""
function list_annotation_store_versions(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore/$(name)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_annotation_store_versions(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore/$(name)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_annotation_stores()
list_annotation_stores(params::Dict{String,<:Any})
Retrieves a list of annotation stores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"ids"`: IDs of stores to list.
- `"maxResults"`: The maximum number of stores to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_annotation_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/annotationStores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_annotation_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multipart_read_set_uploads(sequence_store_id)
list_multipart_read_set_uploads(sequence_store_id, params::Dict{String,<:Any})
Lists multipart read set uploads and for in progress uploads. Once the upload is completed,
a read set is created and the upload will no longer be returned in the response.
# Arguments
- `sequence_store_id`: The Sequence Store ID used for the multipart uploads.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of multipart uploads returned in a page.
- `"nextToken"`: Next token returned in the response of a previous
ListMultipartReadSetUploads call. Used to get the next page of results.
"""
function list_multipart_read_set_uploads(
sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/uploads";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_multipart_read_set_uploads(
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/uploads",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_read_set_activation_jobs(sequence_store_id)
list_read_set_activation_jobs(sequence_store_id, params::Dict{String,<:Any})
Retrieves a list of read set activation jobs.
# Arguments
- `sequence_store_id`: The read set's sequence store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of read set activation jobs to return in one page of
results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_read_set_activation_jobs(
sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/activationjobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_read_set_activation_jobs(
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/activationjobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_read_set_export_jobs(sequence_store_id)
list_read_set_export_jobs(sequence_store_id, params::Dict{String,<:Any})
Retrieves a list of read set export jobs.
# Arguments
- `sequence_store_id`: The jobs' sequence store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of jobs to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_read_set_export_jobs(
sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/exportjobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_read_set_export_jobs(
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/exportjobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_read_set_import_jobs(sequence_store_id)
list_read_set_import_jobs(sequence_store_id, params::Dict{String,<:Any})
Retrieves a list of read set import jobs.
# Arguments
- `sequence_store_id`: The jobs' sequence store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of jobs to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_read_set_import_jobs(
sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/importjobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_read_set_import_jobs(
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/importjobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_read_set_upload_parts(part_source, sequence_store_id, upload_id)
list_read_set_upload_parts(part_source, sequence_store_id, upload_id, params::Dict{String,<:Any})
This operation will list all parts in a requested multipart upload for a sequence store.
# Arguments
- `part_source`: The source file for the upload part.
- `sequence_store_id`: The Sequence Store ID used for the multipart uploads.
- `upload_id`: The ID for the initiated multipart upload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Attributes used to filter for a specific subset of read set part uploads.
- `"maxResults"`: The maximum number of read set upload parts returned in a page.
- `"nextToken"`: Next token returned in the response of a previous
ListReadSetUploadPartsRequest call. Used to get the next page of results.
"""
function list_read_set_upload_parts(
partSource, sequenceStoreId, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/parts",
Dict{String,Any}("partSource" => partSource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_read_set_upload_parts(
partSource,
sequenceStoreId,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/parts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("partSource" => partSource), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_read_sets(sequence_store_id)
list_read_sets(sequence_store_id, params::Dict{String,<:Any})
Retrieves a list of read sets.
# Arguments
- `sequence_store_id`: The jobs' sequence store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of read sets to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_read_sets(sequenceStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/readsets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_read_sets(
sequenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/readsets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_reference_import_jobs(reference_store_id)
list_reference_import_jobs(reference_store_id, params::Dict{String,<:Any})
Retrieves a list of reference import jobs.
# Arguments
- `reference_store_id`: The job's reference store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of jobs to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_reference_import_jobs(
referenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/referencestore/$(referenceStoreId)/importjobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_reference_import_jobs(
referenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/referencestore/$(referenceStoreId)/importjobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_reference_stores()
list_reference_stores(params::Dict{String,<:Any})
Retrieves a list of reference stores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of stores to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_reference_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/referencestores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_reference_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/referencestores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_references(reference_store_id)
list_references(reference_store_id, params::Dict{String,<:Any})
Retrieves a list of references.
# Arguments
- `reference_store_id`: The references' reference store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of references to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_references(
referenceStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/referencestore/$(referenceStoreId)/references";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_references(
referenceStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/referencestore/$(referenceStoreId)/references",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_run_groups()
list_run_groups(params::Dict{String,<:Any})
Retrieves a list of run groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of run groups to return in one page of results.
- `"name"`: The run groups' name.
- `"startingToken"`: Specify the pagination token from a previous request to retrieve the
next page of results.
"""
function list_run_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return omics("GET", "/runGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_run_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET", "/runGroup", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_run_tasks(id)
list_run_tasks(id, params::Dict{String,<:Any})
Retrieves a list of tasks for a run.
# Arguments
- `id`: The run's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of run tasks to return in one page of results.
- `"startingToken"`: Specify the pagination token from a previous request to retrieve the
next page of results.
- `"status"`: Filter the list by status.
"""
function list_run_tasks(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"GET", "/run/$(id)/task"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_run_tasks(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/run/$(id)/task",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_runs()
list_runs(params::Dict{String,<:Any})
Retrieves a list of runs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of runs to return in one page of results.
- `"name"`: Filter the list by run name.
- `"runGroupId"`: Filter the list by run group ID.
- `"startingToken"`: Specify the pagination token from a previous request to retrieve the
next page of results.
- `"status"`: The status of a run.
"""
function list_runs(; aws_config::AbstractAWSConfig=global_aws_config())
return omics("GET", "/run"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET", "/run", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_sequence_stores()
list_sequence_stores(params::Dict{String,<:Any})
Retrieves a list of sequence stores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"maxResults"`: The maximum number of stores to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_sequence_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/sequencestores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_sequence_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_shares(resource_owner)
list_shares(resource_owner, params::Dict{String,<:Any})
Retrieves the resource shares associated with an account. Use the filter parameter to
retrieve a specific subset of the shares.
# Arguments
- `resource_owner`: The account that owns the resource shares.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Attributes that you use to filter for a specific subset of resource shares.
- `"maxResults"`: The maximum number of shares to return in one page of results.
- `"nextToken"`: Next token returned in the response of a previous
ListReadSetUploadPartsRequest call. Used to get the next page of results.
"""
function list_shares(resourceOwner; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/shares",
Dict{String,Any}("resourceOwner" => resourceOwner);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_shares(
resourceOwner,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/shares",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceOwner" => resourceOwner), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves a list of tags for a resource.
# Arguments
- `resource_arn`: The resource's ARN.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_variant_import_jobs()
list_variant_import_jobs(params::Dict{String,<:Any})
Retrieves a list of variant import jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"ids"`: A list of job IDs.
- `"maxResults"`: The maximum number of import jobs to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_variant_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/import/variants"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_variant_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/import/variants",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_variant_stores()
list_variant_stores(params::Dict{String,<:Any})
Retrieves a list of variant stores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter to apply to the list.
- `"ids"`: A list of store IDs.
- `"maxResults"`: The maximum number of stores to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_variant_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/variantStores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_variant_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/variantStores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflows()
list_workflows(params::Dict{String,<:Any})
Retrieves a list of workflows.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of workflows to return in one page of results.
- `"name"`: Filter the list by workflow name.
- `"startingToken"`: Specify the pagination token from a previous request to retrieve the
next page of results.
- `"type"`: Filter the list by workflow type.
"""
function list_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return omics("GET", "/workflow"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"GET", "/workflow", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
start_annotation_import_job(destination_name, items, role_arn)
start_annotation_import_job(destination_name, items, role_arn, params::Dict{String,<:Any})
Starts an annotation import job.
# Arguments
- `destination_name`: A destination annotation store for the job.
- `items`: Items to import.
- `role_arn`: A service role for the job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"annotationFields"`: The annotation schema generated by the parsed annotation data.
- `"formatOptions"`: Formatting options for the annotation file.
- `"runLeftNormalization"`: The job's left normalization setting.
- `"versionName"`: The name of the annotation store version.
"""
function start_annotation_import_job(
destinationName, items, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/import/annotation",
Dict{String,Any}(
"destinationName" => destinationName, "items" => items, "roleArn" => roleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_annotation_import_job(
destinationName,
items,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/import/annotation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationName" => destinationName,
"items" => items,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_read_set_activation_job(sequence_store_id, sources)
start_read_set_activation_job(sequence_store_id, sources, params::Dict{String,<:Any})
Activates an archived read set. To reduce storage charges, Amazon Omics archives unused
read sets after 30 days.
# Arguments
- `sequence_store_id`: The read set's sequence store ID.
- `sources`: The job's source files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: To ensure that jobs don't run multiple times, specify a unique token for
each job.
"""
function start_read_set_activation_job(
sequenceStoreId, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/activationjob",
Dict{String,Any}("sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_read_set_activation_job(
sequenceStoreId,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/activationjob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("sources" => sources), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_read_set_export_job(destination, role_arn, sequence_store_id, sources)
start_read_set_export_job(destination, role_arn, sequence_store_id, sources, params::Dict{String,<:Any})
Exports a read set to Amazon S3.
# Arguments
- `destination`: A location for exported files in Amazon S3.
- `role_arn`: A service role for the job.
- `sequence_store_id`: The read set's sequence store ID.
- `sources`: The job's source files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: To ensure that jobs don't run multiple times, specify a unique token for
each job.
"""
function start_read_set_export_job(
destination,
roleArn,
sequenceStoreId,
sources;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/exportjob",
Dict{String,Any}(
"destination" => destination, "roleArn" => roleArn, "sources" => sources
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_read_set_export_job(
destination,
roleArn,
sequenceStoreId,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/exportjob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destination" => destination, "roleArn" => roleArn, "sources" => sources
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_read_set_import_job(role_arn, sequence_store_id, sources)
start_read_set_import_job(role_arn, sequence_store_id, sources, params::Dict{String,<:Any})
Starts a read set import job.
# Arguments
- `role_arn`: A service role for the job.
- `sequence_store_id`: The read set's sequence store ID.
- `sources`: The job's source files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: To ensure that jobs don't run multiple times, specify a unique token for
each job.
"""
function start_read_set_import_job(
roleArn, sequenceStoreId, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/importjob",
Dict{String,Any}("roleArn" => roleArn, "sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_read_set_import_job(
roleArn,
sequenceStoreId,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/sequencestore/$(sequenceStoreId)/importjob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("roleArn" => roleArn, "sources" => sources), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_reference_import_job(reference_store_id, role_arn, sources)
start_reference_import_job(reference_store_id, role_arn, sources, params::Dict{String,<:Any})
Starts a reference import job.
# Arguments
- `reference_store_id`: The job's reference store ID.
- `role_arn`: A service role for the job.
- `sources`: The job's source files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: To ensure that jobs don't run multiple times, specify a unique token for
each job.
"""
function start_reference_import_job(
referenceStoreId, roleArn, sources; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/referencestore/$(referenceStoreId)/importjob",
Dict{String,Any}("roleArn" => roleArn, "sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_reference_import_job(
referenceStoreId,
roleArn,
sources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/referencestore/$(referenceStoreId)/importjob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("roleArn" => roleArn, "sources" => sources), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_run(request_id, role_arn)
start_run(request_id, role_arn, params::Dict{String,<:Any})
Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The
remaining parameters are copied from the previous run. StartRun will not support re-run for
a workflow that is shared with you. The total number of runs in your account is subject to
a quota per Region. To avoid needing to delete runs manually, you can set the retention
mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is
exceeded. By default, the run uses STATIC storage. For STATIC storage, set the
storageCapacity field. You can set the storage type to DYNAMIC. You do not set
storageCapacity, because HealthOmics dynamically scales the storage up or down as required.
For more information about static and dynamic storage, see Running workflows in the AWS
HealthOmics User Guide.
# Arguments
- `request_id`: To ensure that requests don't run multiple times, specify a unique ID for
each request.
- `role_arn`: A service role for the run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"logLevel"`: A log level for the run.
- `"name"`: A name for the run.
- `"outputUri"`: An output URI for the run.
- `"parameters"`: Parameters for the run.
- `"priority"`: A priority for the run.
- `"retentionMode"`: The retention mode for the run.
- `"runGroupId"`: The run's group ID.
- `"runId"`: The ID of a run to duplicate.
- `"storageCapacity"`: A storage capacity for the run in gibibytes. This field is not
required if the storage type is dynamic (the system ignores any value that you enter).
- `"storageType"`: The run's storage type. By default, the run uses STATIC storage type,
which allocates a fixed amount of storage. If you set the storage type to DYNAMIC,
HealthOmics dynamically scales the storage up or down, based on file system utilization.
- `"tags"`: Tags for the run.
- `"workflowId"`: The run's workflow ID.
- `"workflowOwnerId"`: The ID of the workflow owner.
- `"workflowType"`: The run's workflow type.
"""
function start_run(requestId, roleArn; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/run",
Dict{String,Any}("requestId" => requestId, "roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_run(
requestId,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/run",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("requestId" => requestId, "roleArn" => roleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_variant_import_job(destination_name, items, role_arn)
start_variant_import_job(destination_name, items, role_arn, params::Dict{String,<:Any})
Starts a variant import job.
# Arguments
- `destination_name`: The destination variant store for the job.
- `items`: Items to import.
- `role_arn`: A service role for the job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"annotationFields"`: The annotation schema generated by the parsed annotation data.
- `"runLeftNormalization"`: The job's left normalization setting.
"""
function start_variant_import_job(
destinationName, items, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/import/variant",
Dict{String,Any}(
"destinationName" => destinationName, "items" => items, "roleArn" => roleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_variant_import_job(
destinationName,
items,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/import/variant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationName" => destinationName,
"items" => items,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Tags a resource.
# Arguments
- `resource_arn`: The resource's ARN.
- `tags`: Tags for the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a resource.
# Arguments
- `resource_arn`: The resource's ARN.
- `tag_keys`: Keys of tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"DELETE",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_annotation_store(name)
update_annotation_store(name, params::Dict{String,<:Any})
Updates an annotation store.
# Arguments
- `name`: A name for the store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the store.
"""
function update_annotation_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/annotationStore/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_annotation_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_annotation_store_version(name, version_name)
update_annotation_store_version(name, version_name, params::Dict{String,<:Any})
Updates the description of an annotation store version.
# Arguments
- `name`: The name of an annotation store.
- `version_name`: The name of an annotation store version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of an annotation store.
"""
function update_annotation_store_version(
name, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/annotationStore/$(name)/version/$(versionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_annotation_store_version(
name,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"POST",
"/annotationStore/$(name)/version/$(versionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_run_group(id)
update_run_group(id, params::Dict{String,<:Any})
Updates a run group.
# Arguments
- `id`: The group's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxCpus"`: The maximum number of CPUs to use.
- `"maxDuration"`: A maximum run time for the group in minutes.
- `"maxGpus"`: The maximum GPUs that can be used by a run group.
- `"maxRuns"`: The maximum number of concurrent runs for the group.
- `"name"`: A name for the group.
"""
function update_run_group(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/runGroup/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_run_group(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/runGroup/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_variant_store(name)
update_variant_store(name, params::Dict{String,<:Any})
Updates a variant store.
# Arguments
- `name`: A name for the store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the store.
"""
function update_variant_store(name; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST",
"/variantStore/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_variant_store(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/variantStore/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workflow(id)
update_workflow(id, params::Dict{String,<:Any})
Updates a workflow.
# Arguments
- `id`: The workflow's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the workflow.
- `"name"`: A name for the workflow.
"""
function update_workflow(id; aws_config::AbstractAWSConfig=global_aws_config())
return omics(
"POST", "/workflow/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_workflow(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return omics(
"POST",
"/workflow/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_read_set_part(part_number, part_source, payload, sequence_store_id, upload_id)
upload_read_set_part(part_number, part_source, payload, sequence_store_id, upload_id, params::Dict{String,<:Any})
This operation uploads a specific part of a read set. If you upload a new part using a
previously used part number, the previously uploaded part will be overwritten.
# Arguments
- `part_number`: The number of the part being uploaded.
- `part_source`: The source file for an upload part.
- `payload`: The read set data to upload for a part.
- `sequence_store_id`: The Sequence Store ID used for the multipart upload.
- `upload_id`: The ID for the initiated multipart upload.
"""
function upload_read_set_part(
partNumber,
partSource,
payload,
sequenceStoreId,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"PUT",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/part",
Dict{String,Any}(
"partNumber" => partNumber, "partSource" => partSource, "payload" => payload
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_read_set_part(
partNumber,
partSource,
payload,
sequenceStoreId,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return omics(
"PUT",
"/sequencestore/$(sequenceStoreId)/upload/$(uploadId)/part",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"partNumber" => partNumber,
"partSource" => partSource,
"payload" => payload,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 89821 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: opensearch
using AWS.Compat
using AWS.UUIDs
"""
accept_inbound_connection(connection_id)
accept_inbound_connection(connection_id, params::Dict{String,<:Any})
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound
cross-cluster search connection request. For more information, see Cross-cluster search for
Amazon OpenSearch Service.
# Arguments
- `connection_id`: The ID of the inbound connection to accept.
"""
function accept_inbound_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/cc/inboundConnection/$(ConnectionId)/accept";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_inbound_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/cc/inboundConnection/$(ConnectionId)/accept",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_data_source(data_source_type, domain_name, name)
add_data_source(data_source_type, domain_name, name, params::Dict{String,<:Any})
Creates a new direct-query data source to the specified domain. For more information, see
Creating Amazon OpenSearch Service data source integrations with Amazon S3.
# Arguments
- `data_source_type`: The type of data source.
- `domain_name`: The name of the domain to add the data source to.
- `name`: A name for the data source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the data source.
"""
function add_data_source(
DataSourceType, DomainName, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource",
Dict{String,Any}("DataSourceType" => DataSourceType, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_data_source(
DataSourceType,
DomainName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataSourceType" => DataSourceType, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags(arn, tag_list)
add_tags(arn, tag_list, params::Dict{String,<:Any})
Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of
case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see
Tagging Amazon OpenSearch Service domains.
# Arguments
- `arn`: Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to
attach resource tags.
- `tag_list`: List of resource tags.
"""
function add_tags(ARN, TagList; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/tags",
Dict{String,Any}("ARN" => ARN, "TagList" => TagList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
ARN,
TagList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ARN" => ARN, "TagList" => TagList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_package(domain_name, package_id)
associate_package(domain_name, package_id, params::Dict{String,<:Any})
Associates a package with an Amazon OpenSearch Service domain. For more information, see
Custom packages for Amazon OpenSearch Service.
# Arguments
- `domain_name`: Name of the domain to associate the package with.
- `package_id`: Internal ID of the package to associate with a domain. Use DescribePackages
to find this value.
"""
function associate_package(
DomainName, PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/packages/associate/$(PackageID)/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_package(
DomainName,
PackageID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/packages/associate/$(PackageID)/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_vpc_endpoint_access(account, domain_name)
authorize_vpc_endpoint_access(account, domain_name, params::Dict{String,<:Any})
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC
endpoint.
# Arguments
- `account`: The Amazon Web Services account ID to grant access to.
- `domain_name`: The name of the OpenSearch Service domain to provide access to.
"""
function authorize_vpc_endpoint_access(
Account, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/authorizeVpcEndpointAccess",
Dict{String,Any}("Account" => Account);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_vpc_endpoint_access(
Account,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/authorizeVpcEndpointAccess",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Account" => Account), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_domain_config_change(domain_name)
cancel_domain_config_change(domain_name, params::Dict{String,<:Any})
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
# Arguments
- `domain_name`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: When set to True, returns the list of change IDs and properties that will be
cancelled without actually cancelling the change.
"""
function cancel_domain_config_change(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/config/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_domain_config_change(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/config/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_service_software_update(domain_name)
cancel_service_software_update(domain_name, params::Dict{String,<:Any})
Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You
can only perform this operation before the AutomatedUpdateDate and when the domain's
UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in
Amazon OpenSearch Service.
# Arguments
- `domain_name`: Name of the OpenSearch Service domain that you want to cancel the service
software update on.
"""
function cancel_service_software_update(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/serviceSoftwareUpdate/cancel",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_service_software_update(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/serviceSoftwareUpdate/cancel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(domain_name)
create_domain(domain_name, params::Dict{String,<:Any})
Creates an Amazon OpenSearch Service domain. For more information, see Creating and
managing Amazon OpenSearch Service domains.
# Arguments
- `domain_name`: Name of the OpenSearch Service domain to create. Domain names are unique
across the domains owned by an account within an Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPolicies"`: Identity and Access Management (IAM) policy document specifying the
access policies for the new domain.
- `"AdvancedOptions"`: Key-value pairs to specify advanced configuration options. The
following key-value pairs are supported: \"rest.action.multi.allow_explicit_index\":
\"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether
explicit references to indexes are allowed inside the body of HTTP requests. If you want to
configure access policies for domain sub-resources, such as specific indexes and domain
APIs, you must disable this property. Default is true. \"indices.fielddata.cache.size\":
\"80\" - Note the use of a string rather than a boolean. Specifies the percentage of heap
space allocated to field data. Default is unbounded.
\"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string rather than a
boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default
is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error. \"override_main_response_version\": \"true\" | \"false\" - Note the use of a
string rather than a boolean. Specifies whether the domain reports its version as 7.10 to
allow Elasticsearch OSS clients and plugins to continue working with it. Default is false
when creating a domain and true when upgrading a domain. For more information, see
Advanced cluster parameters.
- `"AdvancedSecurityOptions"`: Options for fine-grained access control.
- `"AutoTuneOptions"`: Options for Auto-Tune.
- `"ClusterConfig"`: Container for the cluster configuration of a domain.
- `"CognitoOptions"`: Key-value pairs to configure Amazon Cognito authentication. For more
information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
- `"DomainEndpointOptions"`: Additional options for the domain endpoint, such as whether to
require HTTPS for all traffic.
- `"EBSOptions"`: Container for the parameters required to enable EBS-based storage for an
OpenSearch Service domain.
- `"EncryptionAtRestOptions"`: Key-value pairs to enable encryption at rest.
- `"EngineVersion"`: String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the
engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or
Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch
Service domains.
- `"IPAddressType"`: Specify either dual stack or IPv4 as your IP address type. Dual stack
allows you to share domain resources across IPv4 and IPv6 address types, and is the
recommended option. If you set your IP address type to dual stack, you can't change your
address type later.
- `"LogPublishingOptions"`: Key-value pairs to configure log publishing.
- `"NodeToNodeEncryptionOptions"`: Enables node-to-node encryption.
- `"OffPeakWindowOptions"`: Specifies a daily 10-hour time block during which OpenSearch
Service can perform configuration changes on the domain, including service software updates
and Auto-Tune enhancements that require a blue/green deployment. If no options are
specified, the default start time of 10:00 P.M. local time (for the Region that the domain
is created in) is used.
- `"SnapshotOptions"`: DEPRECATED. Container for the parameters required to configure
automated snapshots of domain indexes.
- `"SoftwareUpdateOptions"`: Software update options for the domain.
- `"TagList"`: List of tags to add to the domain upon creation.
- `"VPCOptions"`: Container for the values required to configure VPC access domains. If you
don't specify these values, OpenSearch Service creates the domain with a public endpoint.
For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
"""
function create_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/opensearch/domain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_outbound_connection(connection_alias, local_domain_info, remote_domain_info)
create_outbound_connection(connection_alias, local_domain_info, remote_domain_info, params::Dict{String,<:Any})
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service
domain to a destination domain. For more information, see Cross-cluster search for Amazon
OpenSearch Service.
# Arguments
- `connection_alias`: Name of the connection.
- `local_domain_info`: Name and Region of the source (local) domain.
- `remote_domain_info`: Name and Region of the destination (remote) domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionMode"`: The connection mode.
- `"ConnectionProperties"`: The ConnectionProperties for the outbound connection.
"""
function create_outbound_connection(
ConnectionAlias,
LocalDomainInfo,
RemoteDomainInfo;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/cc/outboundConnection",
Dict{String,Any}(
"ConnectionAlias" => ConnectionAlias,
"LocalDomainInfo" => LocalDomainInfo,
"RemoteDomainInfo" => RemoteDomainInfo,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_outbound_connection(
ConnectionAlias,
LocalDomainInfo,
RemoteDomainInfo,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/cc/outboundConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectionAlias" => ConnectionAlias,
"LocalDomainInfo" => LocalDomainInfo,
"RemoteDomainInfo" => RemoteDomainInfo,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_package(package_name, package_source, package_type)
create_package(package_name, package_source, package_type, params::Dict{String,<:Any})
Creates a package for use with Amazon OpenSearch Service domains. For more information, see
Custom packages for Amazon OpenSearch Service.
# Arguments
- `package_name`: Unique name for the package.
- `package_source`: The Amazon S3 location from which to import the package.
- `package_type`: The type of package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PackageDescription"`: Description of the package.
"""
function create_package(
PackageName,
PackageSource,
PackageType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/packages",
Dict{String,Any}(
"PackageName" => PackageName,
"PackageSource" => PackageSource,
"PackageType" => PackageType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_package(
PackageName,
PackageSource,
PackageType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/packages",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PackageName" => PackageName,
"PackageSource" => PackageSource,
"PackageType" => PackageType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_endpoint(domain_arn, vpc_options)
create_vpc_endpoint(domain_arn, vpc_options, params::Dict{String,<:Any})
Creates an Amazon OpenSearch Service-managed VPC endpoint.
# Arguments
- `domain_arn`: The Amazon Resource Name (ARN) of the domain to create the endpoint for.
- `vpc_options`: Options to specify the subnets and security groups for the endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
"""
function create_vpc_endpoint(
DomainArn, VpcOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/vpcEndpoints",
Dict{String,Any}("DomainArn" => DomainArn, "VpcOptions" => VpcOptions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_endpoint(
DomainArn,
VpcOptions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/vpcEndpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainArn" => DomainArn, "VpcOptions" => VpcOptions),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_source(data_source_name, domain_name)
delete_data_source(data_source_name, domain_name, params::Dict{String,<:Any})
Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch
Service data source with Amazon S3.
# Arguments
- `data_source_name`: The name of the data source to delete.
- `domain_name`: The name of the domain.
"""
function delete_data_source(
DataSourceName, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource/$(DataSourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_source(
DataSourceName,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource/$(DataSourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})
Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain
after you delete it.
# Arguments
- `domain_name`: The name of the domain you want to permanently delete.
"""
function delete_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"DELETE",
"/2021-01-01/opensearch/domain/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/domain/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inbound_connection(connection_id)
delete_inbound_connection(connection_id, params::Dict{String,<:Any})
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound
cross-cluster search connection. For more information, see Cross-cluster search for Amazon
OpenSearch Service.
# Arguments
- `connection_id`: The ID of the inbound connection to permanently delete.
"""
function delete_inbound_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/cc/inboundConnection/$(ConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inbound_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/cc/inboundConnection/$(ConnectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_outbound_connection(connection_id)
delete_outbound_connection(connection_id, params::Dict{String,<:Any})
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound
cross-cluster search connection. For more information, see Cross-cluster search for Amazon
OpenSearch Service.
# Arguments
- `connection_id`: The ID of the outbound connection you want to permanently delete.
"""
function delete_outbound_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/cc/outboundConnection/$(ConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_outbound_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/cc/outboundConnection/$(ConnectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_package(package_id)
delete_package(package_id, params::Dict{String,<:Any})
Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for
Amazon OpenSearch Service.
# Arguments
- `package_id`: The internal ID of the package you want to delete. Use DescribePackages to
find this value.
"""
function delete_package(PackageID; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"DELETE",
"/2021-01-01/packages/$(PackageID)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_package(
PackageID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"DELETE",
"/2021-01-01/packages/$(PackageID)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_endpoint(vpc_endpoint_id)
delete_vpc_endpoint(vpc_endpoint_id, params::Dict{String,<:Any})
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
# Arguments
- `vpc_endpoint_id`: The unique identifier of the endpoint.
"""
function delete_vpc_endpoint(
VpcEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/vpcEndpoints/$(VpcEndpointId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_endpoint(
VpcEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"DELETE",
"/2021-01-01/opensearch/vpcEndpoints/$(VpcEndpointId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain(domain_name)
describe_domain(domain_name, params::Dict{String,<:Any})
Describes the domain configuration for the specified Amazon OpenSearch Service domain,
including the domain ID, domain service endpoint, and domain ARN.
# Arguments
- `domain_name`: The name of the domain that you want information about.
"""
function describe_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_auto_tunes(domain_name)
describe_domain_auto_tunes(domain_name, params::Dict{String,<:Any})
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service
domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
# Arguments
- `domain_name`: Name of the domain that you want Auto-Tune details about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"NextToken"`: If your initial DescribeDomainAutoTunes operation returns a nextToken, you
can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which
returns results in the next page.
"""
function describe_domain_auto_tunes(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/autoTunes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_auto_tunes(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/autoTunes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_change_progress(domain_name)
describe_domain_change_progress(domain_name, params::Dict{String,<:Any})
Returns information about the current blue/green deployment happening on an Amazon
OpenSearch Service domain. For more information, see Making configuration changes in Amazon
OpenSearch Service.
# Arguments
- `domain_name`: The name of the domain to get progress information for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"changeid"`: The specific change ID for which you want to get progress information. If
omitted, the request returns information about the most recent configuration change.
"""
function describe_domain_change_progress(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/progress";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_change_progress(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/progress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_config(domain_name)
describe_domain_config(domain_name, params::Dict{String,<:Any})
Returns the configuration of an Amazon OpenSearch Service domain.
# Arguments
- `domain_name`: Name of the OpenSearch Service domain configuration that you want to
describe.
"""
function describe_domain_config(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_config(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_health(domain_name)
describe_domain_health(domain_name, params::Dict{String,<:Any})
Returns information about domain and node health, the standby Availability Zone, number of
nodes per Availability Zone, and shard count per node.
# Arguments
- `domain_name`: The name of the domain.
"""
function describe_domain_health(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/health";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_health(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/health",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_nodes(domain_name)
describe_domain_nodes(domain_name, params::Dict{String,<:Any})
Returns information about domain and nodes, including data nodes, master nodes, ultrawarm
nodes, Availability Zone(s), standby nodes, node configurations, and node states.
# Arguments
- `domain_name`: The name of the domain.
"""
function describe_domain_nodes(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/nodes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_nodes(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/nodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domains(domain_names)
describe_domains(domain_names, params::Dict{String,<:Any})
Returns domain configuration information about the specified Amazon OpenSearch Service
domains.
# Arguments
- `domain_names`: Array of OpenSearch Service domain names that you want information about.
You must specify at least one domain name.
"""
function describe_domains(DomainNames; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/opensearch/domain-info",
Dict{String,Any}("DomainNames" => DomainNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domains(
DomainNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain-info",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainNames" => DomainNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dry_run_progress(domain_name)
describe_dry_run_progress(domain_name, params::Dict{String,<:Any})
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service
domain. For more information, see Determining whether a change will cause a blue/green
deployment.
# Arguments
- `domain_name`: The name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dryRunId"`: The unique identifier of the dry run.
- `"loadDryRunConfig"`: Whether to include the configuration of the dry run in the
response. The configuration specifies the updates that you're planning to make on the
domain.
"""
function describe_dry_run_progress(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/dryRun";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dry_run_progress(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/dryRun",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inbound_connections()
describe_inbound_connections(params::Dict{String,<:Any})
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon
OpenSearch Service domain. For more information, see Cross-cluster search for Amazon
OpenSearch Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A list of filters used to match properties for inbound cross-cluster
connections.
- `"MaxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"NextToken"`: If your initial DescribeInboundConnections operation returns a nextToken,
you can include the returned nextToken in subsequent DescribeInboundConnections operations,
which returns results in the next page.
"""
function describe_inbound_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/opensearch/cc/inboundConnection/search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inbound_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/cc/inboundConnection/search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_type_limits(engine_version, instance_type)
describe_instance_type_limits(engine_version, instance_type, params::Dict{String,<:Any})
Describes the instance count, storage, and master node limits for a given OpenSearch or
Elasticsearch version and instance type.
# Arguments
- `engine_version`: Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y
or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
- `instance_type`: The OpenSearch Service instance type for which you need limit
information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: The name of the domain. Only specify if you need the limits for an
existing domain.
"""
function describe_instance_type_limits(
EngineVersion, InstanceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/instanceTypeLimits/$(EngineVersion)/$(InstanceType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_type_limits(
EngineVersion,
InstanceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/instanceTypeLimits/$(EngineVersion)/$(InstanceType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_outbound_connections()
describe_outbound_connections(params::Dict{String,<:Any})
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch
Service domain. For more information, see Cross-cluster search for Amazon OpenSearch
Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: List of filter names and values that you can use for requests.
- `"MaxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"NextToken"`: If your initial DescribeOutboundConnections operation returns a nextToken,
you can include the returned nextToken in subsequent DescribeOutboundConnections
operations, which returns results in the next page.
"""
function describe_outbound_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/opensearch/cc/outboundConnection/search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_outbound_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/cc/outboundConnection/search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_packages()
describe_packages(params::Dict{String,<:Any})
Describes all packages available to OpenSearch Service. For more information, see Custom
packages for Amazon OpenSearch Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Only returns packages that match the DescribePackagesFilterList values.
- `"MaxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"NextToken"`: If your initial DescribePackageFilters operation returns a nextToken, you
can include the returned nextToken in subsequent DescribePackageFilters operations, which
returns results in the next page.
"""
function describe_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/packages/describe";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_packages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/packages/describe",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_instance_offerings()
describe_reserved_instance_offerings(params::Dict{String,<:Any})
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given
Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial DescribeReservedInstanceOfferings operation returns a
nextToken, you can include the returned nextToken in subsequent
DescribeReservedInstanceOfferings operations, which returns results in the next page.
- `"offeringId"`: The Reserved Instance identifier filter value. Use this parameter to show
only the available instance types that match the specified reservation identifier.
"""
function describe_reserved_instance_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/reservedInstanceOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_instance_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/reservedInstanceOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_instances()
describe_reserved_instances(params::Dict{String,<:Any})
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
For more information, see Reserved Instances in Amazon OpenSearch Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial DescribeReservedInstances operation returns a nextToken,
you can include the returned nextToken in subsequent DescribeReservedInstances operations,
which returns results in the next page.
- `"reservationId"`: The reserved instance identifier filter value. Use this parameter to
show only the reservation that matches the specified reserved OpenSearch instance ID.
"""
function describe_reserved_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/reservedInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/reservedInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoints(vpc_endpoint_ids)
describe_vpc_endpoints(vpc_endpoint_ids, params::Dict{String,<:Any})
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
# Arguments
- `vpc_endpoint_ids`: The unique identifiers of the endpoints to get information about.
"""
function describe_vpc_endpoints(
VpcEndpointIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/vpcEndpoints/describe",
Dict{String,Any}("VpcEndpointIds" => VpcEndpointIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_endpoints(
VpcEndpointIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/vpcEndpoints/describe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VpcEndpointIds" => VpcEndpointIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
dissociate_package(domain_name, package_id)
dissociate_package(domain_name, package_id, params::Dict{String,<:Any})
Removes a package from the specified Amazon OpenSearch Service domain. The package can't be
in use with any OpenSearch index for the dissociation to succeed. The package is still
available in OpenSearch Service for association later. For more information, see Custom
packages for Amazon OpenSearch Service.
# Arguments
- `domain_name`: Name of the domain to dissociate the package from.
- `package_id`: Internal ID of the package to dissociate from the domain. Use
ListPackagesForDomain to find this value.
"""
function dissociate_package(
DomainName, PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/packages/dissociate/$(PackageID)/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function dissociate_package(
DomainName,
PackageID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/packages/dissociate/$(PackageID)/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compatible_versions()
get_compatible_versions(params::Dict{String,<:Any})
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: The name of an existing domain. Provide this parameter to limit the
results to a single domain.
"""
function get_compatible_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/compatibleVersions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compatible_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/compatibleVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_source(data_source_name, domain_name)
get_data_source(data_source_name, domain_name, params::Dict{String,<:Any})
Retrieves information about a direct query data source.
# Arguments
- `data_source_name`: The name of the data source to get information about.
- `domain_name`: The name of the domain.
"""
function get_data_source(
DataSourceName, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource/$(DataSourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_source(
DataSourceName,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource/$(DataSourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_maintenance_status(domain_name, maintenance_id)
get_domain_maintenance_status(domain_name, maintenance_id, params::Dict{String,<:Any})
The status of the maintenance action.
# Arguments
- `domain_name`: The name of the domain.
- `maintenance_id`: The request ID of the maintenance action.
"""
function get_domain_maintenance_status(
DomainName, maintenanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/domainMaintenance",
Dict{String,Any}("maintenanceId" => maintenanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_maintenance_status(
DomainName,
maintenanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/domainMaintenance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("maintenanceId" => maintenanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_package_version_history(package_id)
get_package_version_history(package_id, params::Dict{String,<:Any})
Returns a list of Amazon OpenSearch Service package versions, along with their creation
time, commit message, and plugin properties (if the package is a zip plugin package). For
more information, see Custom packages for Amazon OpenSearch Service.
# Arguments
- `package_id`: The unique identifier of the package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial GetPackageVersionHistory operation returns a nextToken,
you can include the returned nextToken in subsequent GetPackageVersionHistory operations,
which returns results in the next page.
"""
function get_package_version_history(
PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/packages/$(PackageID)/history";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_package_version_history(
PackageID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/packages/$(PackageID)/history",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_upgrade_history(domain_name)
get_upgrade_history(domain_name, params::Dict{String,<:Any})
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch
Service domain.
# Arguments
- `domain_name`: The name of an existing domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial GetUpgradeHistory operation returns a nextToken, you can
include the returned nextToken in subsequent GetUpgradeHistory operations, which returns
results in the next page.
"""
function get_upgrade_history(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/upgradeDomain/$(DomainName)/history";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_upgrade_history(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/upgradeDomain/$(DomainName)/history",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_upgrade_status(domain_name)
get_upgrade_status(domain_name, params::Dict{String,<:Any})
Returns the most recent status of the last upgrade or upgrade eligibility check performed
on an Amazon OpenSearch Service domain.
# Arguments
- `domain_name`: The domain of the domain to get upgrade status information for.
"""
function get_upgrade_status(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/upgradeDomain/$(DomainName)/status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_upgrade_status(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/upgradeDomain/$(DomainName)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sources(domain_name)
list_data_sources(domain_name, params::Dict{String,<:Any})
Lists direct-query data sources for a specific domain. For more information, see For more
information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
# Arguments
- `domain_name`: The name of the domain.
"""
function list_data_sources(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sources(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domain_maintenances(domain_name)
list_domain_maintenances(domain_name, params::Dict{String,<:Any})
A list of maintenance actions for the domain.
# Arguments
- `domain_name`: The name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: The name of the action.
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListDomainMaintenances operation returns a nextToken,
include the returned nextToken in subsequent ListDomainMaintenances operations, which
returns results in the next page.
- `"status"`: The status of the action.
"""
function list_domain_maintenances(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/domainMaintenances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_domain_maintenances(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/domainMaintenances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domain_names()
list_domain_names(params::Dict{String,<:Any})
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the
active Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: Filters the output by domain engine type.
"""
function list_domain_names(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET", "/2021-01-01/domain"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domain_names(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/domain",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains_for_package(package_id)
list_domains_for_package(package_id, params::Dict{String,<:Any})
Lists all Amazon OpenSearch Service domains associated with a given package. For more
information, see Custom packages for Amazon OpenSearch Service.
# Arguments
- `package_id`: The unique identifier of the package for which to list associated domains.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListDomainsForPackage operation returns a nextToken, you
can include the returned nextToken in subsequent ListDomainsForPackage operations, which
returns results in the next page.
"""
function list_domains_for_package(
PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/packages/$(PackageID)/domains";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_domains_for_package(
PackageID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/packages/$(PackageID)/domains",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_type_details(engine_version)
list_instance_type_details(engine_version, params::Dict{String,<:Any})
Lists all instance types and available features for a given OpenSearch or Elasticsearch
version.
# Arguments
- `engine_version`: The version of OpenSearch or Elasticsearch, in the format
Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: The name of the domain.
- `"instanceType"`: An optional parameter that lists information for a given instance type.
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListInstanceTypeDetails operation returns a nextToken, you
can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which
returns results in the next page.
- `"retrieveAZs"`: An optional parameter that specifies the Availability Zones for the
domain.
"""
function list_instance_type_details(
EngineVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/instanceTypeDetails/$(EngineVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_type_details(
EngineVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/instanceTypeDetails/$(EngineVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_packages_for_domain(domain_name)
list_packages_for_domain(domain_name, params::Dict{String,<:Any})
Lists all packages associated with an Amazon OpenSearch Service domain. For more
information, see Custom packages for Amazon OpenSearch Service.
# Arguments
- `domain_name`: The name of the domain for which you want to list associated packages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListPackagesForDomain operation returns a nextToken, you
can include the returned nextToken in subsequent ListPackagesForDomain operations, which
returns results in the next page.
"""
function list_packages_for_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/domain/$(DomainName)/packages";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_packages_for_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/domain/$(DomainName)/packages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_scheduled_actions(domain_name)
list_scheduled_actions(domain_name, params::Dict{String,<:Any})
Retrieves a list of configuration changes that are scheduled for a domain. These changes
can be service software updates or blue/green Auto-Tune enhancements.
# Arguments
- `domain_name`: The name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListScheduledActions operation returns a nextToken, you
can include the returned nextToken in subsequent ListScheduledActions operations, which
returns results in the next page.
"""
function list_scheduled_actions(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/scheduledActions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_scheduled_actions(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/scheduledActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(arn)
list_tags(arn, params::Dict{String,<:Any})
Returns all resource tags for an Amazon OpenSearch Service domain. For more information,
see Tagging Amazon OpenSearch Service domains.
# Arguments
- `arn`: Amazon Resource Name (ARN) for the domain to view tags for.
"""
function list_tags(arn; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/tags/",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/tags/",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_versions()
list_versions(params::Dict{String,<:Any})
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListVersions operation returns a nextToken, you can
include the returned nextToken in subsequent ListVersions operations, which returns results
in the next page.
"""
function list_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpc_endpoint_access(domain_name)
list_vpc_endpoint_access(domain_name, params::Dict{String,<:Any})
Retrieves information about each Amazon Web Services principal that is allowed to access a
given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
# Arguments
- `domain_name`: The name of the OpenSearch Service domain to retrieve access information
for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: If your initial ListVpcEndpointAccess operation returns a nextToken, you
can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which
returns results in the next page.
"""
function list_vpc_endpoint_access(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/listVpcEndpointAccess";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vpc_endpoint_access(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/listVpcEndpointAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpc_endpoints()
list_vpc_endpoints(params::Dict{String,<:Any})
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web
Services account and Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: If your initial ListVpcEndpoints operation returns a nextToken, you can
include the returned nextToken in subsequent ListVpcEndpoints operations, which returns
results in the next page.
"""
function list_vpc_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"GET",
"/2021-01-01/opensearch/vpcEndpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vpc_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/vpcEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpc_endpoints_for_domain(domain_name)
list_vpc_endpoints_for_domain(domain_name, params::Dict{String,<:Any})
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular
domain.
# Arguments
- `domain_name`: The name of the domain to list associated VPC endpoints for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: If your initial ListEndpointsForDomain operation returns a nextToken, you
can include the returned nextToken in subsequent ListEndpointsForDomain operations, which
returns results in the next page.
"""
function list_vpc_endpoints_for_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/vpcEndpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vpc_endpoints_for_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"GET",
"/2021-01-01/opensearch/domain/$(DomainName)/vpcEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_instance_offering(reservation_name, reserved_instance_offering_id)
purchase_reserved_instance_offering(reservation_name, reserved_instance_offering_id, params::Dict{String,<:Any})
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
# Arguments
- `reservation_name`: A customer-specified identifier to track this reservation.
- `reserved_instance_offering_id`: The ID of the Reserved Instance offering to purchase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceCount"`: The number of OpenSearch instances to reserve.
"""
function purchase_reserved_instance_offering(
ReservationName,
ReservedInstanceOfferingId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/purchaseReservedInstanceOffering",
Dict{String,Any}(
"ReservationName" => ReservationName,
"ReservedInstanceOfferingId" => ReservedInstanceOfferingId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_instance_offering(
ReservationName,
ReservedInstanceOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/purchaseReservedInstanceOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservationName" => ReservationName,
"ReservedInstanceOfferingId" => ReservedInstanceOfferingId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_inbound_connection(connection_id)
reject_inbound_connection(connection_id, params::Dict{String,<:Any})
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster
connection request.
# Arguments
- `connection_id`: The unique identifier of the inbound connection to reject.
"""
function reject_inbound_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/cc/inboundConnection/$(ConnectionId)/reject";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_inbound_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/cc/inboundConnection/$(ConnectionId)/reject",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags(arn, tag_keys)
remove_tags(arn, tag_keys, params::Dict{String,<:Any})
Removes the specified set of tags from an Amazon OpenSearch Service domain. For more
information, see Tagging Amazon OpenSearch Service domains.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the domain from which you want to delete the
specified tags.
- `tag_keys`: The list of tag keys to remove from the domain.
"""
function remove_tags(ARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/tags-removal",
Dict{String,Any}("ARN" => ARN, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags(
ARN,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/tags-removal",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ARN" => ARN, "TagKeys" => TagKeys), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_vpc_endpoint_access(account, domain_name)
revoke_vpc_endpoint_access(account, domain_name, params::Dict{String,<:Any})
Revokes access to an Amazon OpenSearch Service domain that was provided through an
interface VPC endpoint.
# Arguments
- `account`: The account ID to revoke access from.
- `domain_name`: The name of the OpenSearch Service domain.
"""
function revoke_vpc_endpoint_access(
Account, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/revokeVpcEndpointAccess",
Dict{String,Any}("Account" => Account);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_vpc_endpoint_access(
Account,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/revokeVpcEndpointAccess",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Account" => Account), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_domain_maintenance(action, domain_name)
start_domain_maintenance(action, domain_name, params::Dict{String,<:Any})
Starts the node maintenance process on the data node. These processes can include a node
reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
# Arguments
- `action`: The name of the action.
- `domain_name`: The name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NodeId"`: The ID of the data node.
"""
function start_domain_maintenance(
Action, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/domainMaintenance",
Dict{String,Any}("Action" => Action);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_domain_maintenance(
Action,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/domainMaintenance",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Action" => Action), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_service_software_update(domain_name)
start_service_software_update(domain_name, params::Dict{String,<:Any})
Schedules a service software update for an Amazon OpenSearch Service domain. For more
information, see Service software updates in Amazon OpenSearch Service.
# Arguments
- `domain_name`: The name of the domain that you want to update to the latest service
software.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DesiredStartTime"`: The Epoch timestamp when you want the service software update to
start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.
- `"ScheduleAt"`: When to start the service software update. NOW - Immediately schedules
the update to happen in the current hour if there's capacity available. TIMESTAMP - Lets
you specify a custom date and time to apply the update. If you specify this value, you must
also provide a value for DesiredStartTime. OFF_PEAK_WINDOW - Marks the update to be
picked up during an upcoming off-peak window. There's no guarantee that the update will
happen during the next immediate window. Depending on capacity, it might happen in
subsequent days. Default: NOW if you don't specify a value for DesiredStartTime, and
TIMESTAMP if you do.
"""
function start_service_software_update(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/serviceSoftwareUpdate/start",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_service_software_update(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/serviceSoftwareUpdate/start",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_source(data_source_name, data_source_type, domain_name)
update_data_source(data_source_name, data_source_type, domain_name, params::Dict{String,<:Any})
Updates a direct-query data source. For more information, see Working with Amazon
OpenSearch Service data source integrations with Amazon S3.
# Arguments
- `data_source_name`: The name of the data source to modify.
- `data_source_type`: The type of data source.
- `domain_name`: The name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description of the data source.
- `"Status"`: The status of the data source update.
"""
function update_data_source(
DataSourceName,
DataSourceType,
DomainName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource/$(DataSourceName)",
Dict{String,Any}("DataSourceType" => DataSourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source(
DataSourceName,
DataSourceType,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/domain/$(DomainName)/dataSource/$(DataSourceName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSourceType" => DataSourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain_config(domain_name)
update_domain_config(domain_name, params::Dict{String,<:Any})
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
# Arguments
- `domain_name`: The name of the domain that you're updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPolicies"`: Identity and Access Management (IAM) access policy as a
JSON-formatted string.
- `"AdvancedOptions"`: Key-value pairs to specify advanced configuration options. The
following key-value pairs are supported: \"rest.action.multi.allow_explicit_index\":
\"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether
explicit references to indexes are allowed inside the body of HTTP requests. If you want to
configure access policies for domain sub-resources, such as specific indexes and domain
APIs, you must disable this property. Default is true. \"indices.fielddata.cache.size\":
\"80\" - Note the use of a string rather than a boolean. Specifies the percentage of heap
space allocated to field data. Default is unbounded.
\"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string rather than a
boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default
is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error. For more information, see Advanced cluster parameters.
- `"AdvancedSecurityOptions"`: Options for fine-grained access control.
- `"AutoTuneOptions"`: Options for Auto-Tune.
- `"ClusterConfig"`: Changes that you want to make to the cluster configuration, such as
the instance type and number of EC2 instances.
- `"CognitoOptions"`: Key-value pairs to configure Amazon Cognito authentication for
OpenSearch Dashboards.
- `"DomainEndpointOptions"`: Additional options for the domain endpoint, such as whether to
require HTTPS for all traffic.
- `"DryRun"`: This flag, when set to True, specifies whether the UpdateDomain request
should return the results of a dry run analysis without actually applying the change. A dry
run determines what type of deployment the update will cause.
- `"DryRunMode"`: The type of dry run to perform. Basic only returns the type of
deployment (blue/green or dynamic) that the update will cause. Verbose runs an
additional check to validate the changes you're making. For more information, see
Validating a domain update.
- `"EBSOptions"`: The type and size of the EBS volume to attach to instances in the domain.
- `"EncryptionAtRestOptions"`: Encryption at rest options for the domain.
- `"IPAddressType"`: Specify either dual stack or IPv4 as your IP address type. Dual stack
allows you to share domain resources across IPv4 and IPv6 address types, and is the
recommended option. If your IP address type is currently set to dual stack, you can't
change it.
- `"LogPublishingOptions"`: Options to publish OpenSearch logs to Amazon CloudWatch Logs.
- `"NodeToNodeEncryptionOptions"`: Node-to-node encryption options for the domain.
- `"OffPeakWindowOptions"`: Off-peak window options for the domain.
- `"SnapshotOptions"`: Option to set the time, in UTC format, for the daily automated
snapshot. Default value is 0 hours.
- `"SoftwareUpdateOptions"`: Service software update options for the domain.
- `"VPCOptions"`: Options to specify the subnets and security groups for a VPC endpoint.
For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
"""
function update_domain_config(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain_config(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/domain/$(DomainName)/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_package(package_id, package_source)
update_package(package_id, package_source, params::Dict{String,<:Any})
Updates a package for use with Amazon OpenSearch Service domains. For more information, see
Custom packages for Amazon OpenSearch Service.
# Arguments
- `package_id`: The unique identifier for the package.
- `package_source`: Amazon S3 bucket and key for the package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommitMessage"`: Commit message for the updated file, which is shown as part of
GetPackageVersionHistoryResponse.
- `"PackageDescription"`: A new description of the package.
"""
function update_package(
PackageID, PackageSource; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/packages/update",
Dict{String,Any}("PackageID" => PackageID, "PackageSource" => PackageSource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_package(
PackageID,
PackageSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/packages/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PackageID" => PackageID, "PackageSource" => PackageSource
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_scheduled_action(action_id, action_type, domain_name, schedule_at)
update_scheduled_action(action_id, action_type, domain_name, schedule_at, params::Dict{String,<:Any})
Reschedules a planned domain configuration change for a later time. This change can be a
scheduled service software update or a blue/green Auto-Tune enhancement.
# Arguments
- `action_id`: The unique identifier of the action to reschedule. To retrieve this ID, send
a ListScheduledActions request.
- `action_type`: The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE,
JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a
ListScheduledActions request.
- `domain_name`: The name of the domain to reschedule an action for.
- `schedule_at`: When to schedule the action. NOW - Immediately schedules the update to
happen in the current hour if there's capacity available. TIMESTAMP - Lets you specify a
custom date and time to apply the update. If you specify this value, you must also provide
a value for DesiredStartTime. OFF_PEAK_WINDOW - Marks the action to be picked up during
an upcoming off-peak window. There's no guarantee that the change will be implemented
during the next immediate window. Depending on capacity, it might happen in subsequent
days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DesiredStartTime"`: The time to implement the change, in Coordinated Universal Time
(UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.
"""
function update_scheduled_action(
ActionID,
ActionType,
DomainName,
ScheduleAt;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/domain/$(DomainName)/scheduledAction/update",
Dict{String,Any}(
"ActionID" => ActionID, "ActionType" => ActionType, "ScheduleAt" => ScheduleAt
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_scheduled_action(
ActionID,
ActionType,
DomainName,
ScheduleAt,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"PUT",
"/2021-01-01/opensearch/domain/$(DomainName)/scheduledAction/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActionID" => ActionID,
"ActionType" => ActionType,
"ScheduleAt" => ScheduleAt,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vpc_endpoint(vpc_endpoint_id, vpc_options)
update_vpc_endpoint(vpc_endpoint_id, vpc_options, params::Dict{String,<:Any})
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
# Arguments
- `vpc_endpoint_id`: The unique identifier of the endpoint.
- `vpc_options`: The security groups and/or subnets to add, remove, or modify.
"""
function update_vpc_endpoint(
VpcEndpointId, VpcOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/vpcEndpoints/update",
Dict{String,Any}("VpcEndpointId" => VpcEndpointId, "VpcOptions" => VpcOptions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vpc_endpoint(
VpcEndpointId,
VpcOptions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/vpcEndpoints/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VpcEndpointId" => VpcEndpointId, "VpcOptions" => VpcOptions
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upgrade_domain(domain_name, target_version)
upgrade_domain(domain_name, target_version, params::Dict{String,<:Any})
Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade
eligibility check to a compatible version of OpenSearch or Elasticsearch.
# Arguments
- `domain_name`: Name of the OpenSearch Service domain that you want to upgrade.
- `target_version`: OpenSearch or Elasticsearch version to which you want to upgrade, in
the format Opensearch_X.Y or Elasticsearch_X.Y.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdvancedOptions"`: Only supports the override_main_response_version parameter and not
other advanced options. You can only include this option when upgrading to an OpenSearch
version. Specifies whether the domain reports its version as 7.10 so that it continues to
work with Elasticsearch OSS clients and plugins.
- `"PerformCheckOnly"`: When true, indicates that an upgrade eligibility check needs to be
performed. Does not actually perform the upgrade.
"""
function upgrade_domain(
DomainName, TargetVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearch(
"POST",
"/2021-01-01/opensearch/upgradeDomain",
Dict{String,Any}("DomainName" => DomainName, "TargetVersion" => TargetVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upgrade_domain(
DomainName,
TargetVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearch(
"POST",
"/2021-01-01/opensearch/upgradeDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName, "TargetVersion" => TargetVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 52591 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: opensearchserverless
using AWS.Compat
using AWS.UUIDs
"""
batch_get_collection()
batch_get_collection(params::Dict{String,<:Any})
Returns attributes for one or more collections, including the collection endpoint and the
OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon
OpenSearch Serverless collections.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ids"`: A list of collection IDs. You can't provide names and IDs in the same request.
The ID is part of the collection endpoint. You can also retrieve it using the
ListCollections API.
- `"names"`: A list of collection names. You can't provide names and IDs in the same
request.
"""
function batch_get_collection(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"BatchGetCollection"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_get_collection(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"BatchGetCollection", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
batch_get_effective_lifecycle_policy(resource_identifiers)
batch_get_effective_lifecycle_policy(resource_identifiers, params::Dict{String,<:Any})
Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
For more information, see Viewing data lifecycle policies.
# Arguments
- `resource_identifiers`: The unique identifiers of policy types and resource names.
"""
function batch_get_effective_lifecycle_policy(
resourceIdentifiers; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"BatchGetEffectiveLifecyclePolicy",
Dict{String,Any}("resourceIdentifiers" => resourceIdentifiers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_effective_lifecycle_policy(
resourceIdentifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"BatchGetEffectiveLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceIdentifiers" => resourceIdentifiers),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_lifecycle_policy(identifiers)
batch_get_lifecycle_policy(identifiers, params::Dict{String,<:Any})
Returns one or more configured OpenSearch Serverless lifecycle policies. For more
information, see Viewing data lifecycle policies.
# Arguments
- `identifiers`: The unique identifiers of policy types and policy names.
"""
function batch_get_lifecycle_policy(
identifiers; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"BatchGetLifecyclePolicy",
Dict{String,Any}("identifiers" => identifiers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_lifecycle_policy(
identifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"BatchGetLifecyclePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifiers" => identifiers), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_vpc_endpoint(ids)
batch_get_vpc_endpoint(ids, params::Dict{String,<:Any})
Returns attributes for one or more VPC endpoints associated with the current account. For
more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
# Arguments
- `ids`: A list of VPC endpoint identifiers.
"""
function batch_get_vpc_endpoint(ids; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"BatchGetVpcEndpoint",
Dict{String,Any}("ids" => ids);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_vpc_endpoint(
ids, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"BatchGetVpcEndpoint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ids" => ids), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_policy(name, policy, type)
create_access_policy(name, policy, type, params::Dict{String,<:Any})
Creates a data access policy for OpenSearch Serverless. Access policies limit access to
collections and the resources within them, and allow a user to access that data
irrespective of the access mechanism or network source. For more information, see Data
access control for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the policy.
- `policy`: The JSON policy document to use as the content for the policy.
- `type`: The type of policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the policy. Typically used to store information about
the permissions defined in the policy.
"""
function create_access_policy(
name, policy, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"CreateAccessPolicy",
Dict{String,Any}(
"name" => name,
"policy" => policy,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_policy(
name,
policy,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"CreateAccessPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policy" => policy,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_collection(name)
create_collection(name, params::Dict{String,<:Any})
Creates a new OpenSearch Serverless collection. For more information, see Creating and
managing Amazon OpenSearch Serverless collections.
# Arguments
- `name`: Name of the collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: Description of the collection.
- `"standbyReplicas"`: Indicates whether standby replicas should be used for a collection.
- `"tags"`: An arbitrary set of tags (key–value pairs) to associate with the OpenSearch
Serverless collection.
- `"type"`: The type of collection.
"""
function create_collection(name; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"CreateCollection",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_collection(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"CreateCollection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lifecycle_policy(name, policy, type)
create_lifecycle_policy(name, policy, type, params::Dict{String,<:Any})
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle
policies define the number of days or hours to retain the data on an OpenSearch Serverless
index. For more information, see Creating data lifecycle policies.
# Arguments
- `name`: The name of the lifecycle policy.
- `policy`: The JSON policy document to use as the content for the lifecycle policy.
- `type`: The type of lifecycle policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the lifecycle policy.
"""
function create_lifecycle_policy(
name, policy, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"CreateLifecyclePolicy",
Dict{String,Any}(
"name" => name,
"policy" => policy,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lifecycle_policy(
name,
policy,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"CreateLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policy" => policy,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_config(name, type)
create_security_config(name, type, params::Dict{String,<:Any})
Specifies a security configuration for OpenSearch Serverless. For more information, see
SAML authentication for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the security configuration.
- `type`: The type of security configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the security configuration.
- `"samlOptions"`: Describes SAML options in in the form of a key-value map. This field is
required if you specify saml for the type parameter.
"""
function create_security_config(
name, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"CreateSecurityConfig",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_config(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"CreateSecurityConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_policy(name, policy, type)
create_security_policy(name, policy, type, params::Dict{String,<:Any})
Creates a security policy to be used by one or more OpenSearch Serverless collections.
Security policies provide access to a collection and its OpenSearch Dashboards endpoint
from public networks or specific VPC endpoints. They also allow you to secure a collection
with a KMS encryption key. For more information, see Network access for Amazon OpenSearch
Serverless and Encryption at rest for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the policy.
- `policy`: The JSON policy document to use as the content for the new policy.
- `type`: The type of security policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the policy. Typically used to store information about
the permissions defined in the policy.
"""
function create_security_policy(
name, policy, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"CreateSecurityPolicy",
Dict{String,Any}(
"name" => name,
"policy" => policy,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_policy(
name,
policy,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"CreateSecurityPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policy" => policy,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_endpoint(name, subnet_ids, vpc_id)
create_vpc_endpoint(name, subnet_ids, vpc_id, params::Dict{String,<:Any})
Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see
Access Amazon OpenSearch Serverless using an interface endpoint.
# Arguments
- `name`: The name of the interface endpoint.
- `subnet_ids`: The ID of one or more subnets from which you'll access OpenSearch
Serverless.
- `vpc_id`: The ID of the VPC from which you'll access OpenSearch Serverless.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"securityGroupIds"`: The unique identifiers of the security groups that define the
ports, protocols, and sources for inbound traffic that you are authorizing into your
endpoint.
"""
function create_vpc_endpoint(
name, subnetIds, vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"CreateVpcEndpoint",
Dict{String,Any}(
"name" => name,
"subnetIds" => subnetIds,
"vpcId" => vpcId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_endpoint(
name,
subnetIds,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"CreateVpcEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"subnetIds" => subnetIds,
"vpcId" => vpcId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_policy(name, type)
delete_access_policy(name, type, params::Dict{String,<:Any})
Deletes an OpenSearch Serverless access policy. For more information, see Data access
control for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the policy to delete.
- `type`: The type of policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
"""
function delete_access_policy(name, type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"DeleteAccessPolicy",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_policy(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"DeleteAccessPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_collection(id)
delete_collection(id, params::Dict{String,<:Any})
Deletes an OpenSearch Serverless collection. For more information, see Creating and
managing Amazon OpenSearch Serverless collections.
# Arguments
- `id`: The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part
of the collection endpoint. You can also retrieve it using the ListCollections API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier to ensure idempotency of the request.
"""
function delete_collection(id; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"DeleteCollection",
Dict{String,Any}("id" => id, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_collection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"DeleteCollection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lifecycle_policy(name, type)
delete_lifecycle_policy(name, type, params::Dict{String,<:Any})
Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data
lifecycle policies.
# Arguments
- `name`: The name of the policy to delete.
- `type`: The type of lifecycle policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
"""
function delete_lifecycle_policy(
name, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"DeleteLifecyclePolicy",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lifecycle_policy(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"DeleteLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_config(id)
delete_security_config(id, params::Dict{String,<:Any})
Deletes a security configuration for OpenSearch Serverless. For more information, see SAML
authentication for Amazon OpenSearch Serverless.
# Arguments
- `id`: The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
"""
function delete_security_config(id; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"DeleteSecurityConfig",
Dict{String,Any}("id" => id, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_security_config(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"DeleteSecurityConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_policy(name, type)
delete_security_policy(name, type, params::Dict{String,<:Any})
Deletes an OpenSearch Serverless security policy.
# Arguments
- `name`: The name of the policy to delete.
- `type`: The type of policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
"""
function delete_security_policy(
name, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"DeleteSecurityPolicy",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_security_policy(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"DeleteSecurityPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_endpoint(id)
delete_vpc_endpoint(id, params::Dict{String,<:Any})
Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see
Access Amazon OpenSearch Serverless using an interface endpoint.
# Arguments
- `id`: The VPC endpoint identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
"""
function delete_vpc_endpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"DeleteVpcEndpoint",
Dict{String,Any}("id" => id, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_endpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"DeleteVpcEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_policy(name, type)
get_access_policy(name, type, params::Dict{String,<:Any})
Returns an OpenSearch Serverless access policy. For more information, see Data access
control for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the access policy.
- `type`: Tye type of policy. Currently, the only supported value is data.
"""
function get_access_policy(name, type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"GetAccessPolicy",
Dict{String,Any}("name" => name, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_policy(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"GetAccessPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "type" => type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_settings()
get_account_settings(params::Dict{String,<:Any})
Returns account-level settings related to OpenSearch Serverless.
"""
function get_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"GetAccountSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"GetAccountSettings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_policies_stats()
get_policies_stats(params::Dict{String,<:Any})
Returns statistical information about your OpenSearch Serverless access policies, security
configurations, and security policies.
"""
function get_policies_stats(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"GetPoliciesStats"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_policies_stats(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"GetPoliciesStats", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_security_config(id)
get_security_config(id, params::Dict{String,<:Any})
Returns information about an OpenSearch Serverless security configuration. For more
information, see SAML authentication for Amazon OpenSearch Serverless.
# Arguments
- `id`: The unique identifier of the security configuration.
"""
function get_security_config(id; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"GetSecurityConfig",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_security_config(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"GetSecurityConfig",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_security_policy(name, type)
get_security_policy(name, type, params::Dict{String,<:Any})
Returns information about a configured OpenSearch Serverless security policy. For more
information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for
Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the security policy.
- `type`: The type of security policy.
"""
function get_security_policy(name, type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"GetSecurityPolicy",
Dict{String,Any}("name" => name, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_security_policy(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"GetSecurityPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "type" => type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_policies(type)
list_access_policies(type, params::Dict{String,<:Any})
Returns information about a list of OpenSearch Serverless access policies.
# Arguments
- `type`: The type of access policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The default is 20.
- `"nextToken"`: If your initial ListAccessPolicies operation returns a nextToken, you can
include the returned nextToken in subsequent ListAccessPolicies operations, which returns
results in the next page.
- `"resource"`: Resource filters (can be collections or indexes) that policies can apply to.
"""
function list_access_policies(type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"ListAccessPolicies",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_policies(
type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListAccessPolicies",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_collections()
list_collections(params::Dict{String,<:Any})
Lists all OpenSearch Serverless collections. For more information, see Creating and
managing Amazon OpenSearch Serverless collections. Make sure to include an empty request
body {} if you don't include any collection filters in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"collectionFilters"`: A list of filter names and values that you can use for requests.
- `"maxResults"`: The maximum number of results to return. Default is 20. You can use
nextToken to get the next page of results.
- `"nextToken"`: If your initial ListCollections operation returns a nextToken, you can
include the returned nextToken in subsequent ListCollections operations, which returns
results in the next page.
"""
function list_collections(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"ListCollections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_collections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListCollections", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_lifecycle_policies(type)
list_lifecycle_policies(type, params::Dict{String,<:Any})
Returns a list of OpenSearch Serverless lifecycle policies. For more information, see
Viewing data lifecycle policies.
# Arguments
- `type`: The type of lifecycle policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use use nextToken to get the next page of results. The default is 10.
- `"nextToken"`: If your initial ListLifecyclePolicies operation returns a nextToken, you
can include the returned nextToken in subsequent ListLifecyclePolicies operations, which
returns results in the next page.
- `"resources"`: Resource filters that policies can apply to. Currently, the only supported
resource type is index.
"""
function list_lifecycle_policies(type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"ListLifecyclePolicies",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lifecycle_policies(
type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListLifecyclePolicies",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_configs(type)
list_security_configs(type, params::Dict{String,<:Any})
Returns information about configured OpenSearch Serverless security configurations. For
more information, see SAML authentication for Amazon OpenSearch Serverless.
# Arguments
- `type`: The type of security configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The default is 20.
- `"nextToken"`: If your initial ListSecurityConfigs operation returns a nextToken, you can
include the returned nextToken in subsequent ListSecurityConfigs operations, which returns
results in the next page.
"""
function list_security_configs(type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"ListSecurityConfigs",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_configs(
type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListSecurityConfigs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_policies(type)
list_security_policies(type, params::Dict{String,<:Any})
Returns information about configured OpenSearch Serverless security policies.
# Arguments
- `type`: The type of policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The default is 20.
- `"nextToken"`: If your initial ListSecurityPolicies operation returns a nextToken, you
can include the returned nextToken in subsequent ListSecurityPolicies operations, which
returns results in the next page.
- `"resource"`: Resource filters (can be collection or indexes) that policies can apply to.
"""
function list_security_policies(type; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"ListSecurityPolicies",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_policies(
type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListSecurityPolicies",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging
Amazon OpenSearch Serverless collections.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. The resource must be
active (not in the DELETING state), and must be owned by the account ID included in the
request.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpc_endpoints()
list_vpc_endpoints(params::Dict{String,<:Any})
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the
current account. For more information, see Access Amazon OpenSearch Serverless using an
interface endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The default is 20.
- `"nextToken"`: If your initial ListVpcEndpoints operation returns a nextToken, you can
include the returned nextToken in subsequent ListVpcEndpoints operations, which returns
results in the next page.
- `"vpcEndpointFilters"`: Filter the results according to the current status of the VPC
endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.
"""
function list_vpc_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"ListVpcEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_vpc_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"ListVpcEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates tags with an OpenSearch Serverless resource. For more information, see Tagging
Amazon OpenSearch Serverless collections.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. The resource must be
active (not in the DELETING state), and must be owned by the account ID included in the
request.
- `tags`: A list of tags (key-value pairs) to add to the resource. All tag keys in the
request must be unique.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag or set of tags from an OpenSearch Serverless resource. For more information,
see Tagging Amazon OpenSearch Serverless collections.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to remove tags from. The
resource must be active (not in the DELETING state), and must be owned by the account ID
included in the request.
- `tag_keys`: The tag or set of tags to remove from the resource. All tag keys in the
request must be unique.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_access_policy(name, policy_version, type)
update_access_policy(name, policy_version, type, params::Dict{String,<:Any})
Updates an OpenSearch Serverless access policy. For more information, see Data access
control for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the policy.
- `policy_version`: The version of the policy being updated.
- `type`: The type of policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the policy. Typically used to store information about
the permissions defined in the policy.
- `"policy"`: The JSON policy document to use as the content for the policy.
"""
function update_access_policy(
name, policyVersion, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateAccessPolicy",
Dict{String,Any}(
"name" => name,
"policyVersion" => policyVersion,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_policy(
name,
policyVersion,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"UpdateAccessPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policyVersion" => policyVersion,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_settings()
update_account_settings(params::Dict{String,<:Any})
Update the OpenSearch Serverless settings for the current Amazon Web Services account. For
more information, see Managing capacity limits for Amazon OpenSearch Serverless.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityLimits"`:
"""
function update_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"UpdateAccountSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateAccountSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_collection(id)
update_collection(id, params::Dict{String,<:Any})
Updates an OpenSearch Serverless collection.
# Arguments
- `id`: The unique identifier of the collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the collection.
"""
function update_collection(id; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"UpdateCollection",
Dict{String,Any}("id" => id, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_collection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateCollection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_lifecycle_policy(name, policy_version, type)
update_lifecycle_policy(name, policy_version, type, params::Dict{String,<:Any})
Updates an OpenSearch Serverless access policy. For more information, see Updating data
lifecycle policies.
# Arguments
- `name`: The name of the policy.
- `policy_version`: The version of the policy being updated.
- `type`: The type of lifecycle policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the lifecycle policy.
- `"policy"`: The JSON policy document to use as the content for the lifecycle policy.
"""
function update_lifecycle_policy(
name, policyVersion, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateLifecyclePolicy",
Dict{String,Any}(
"name" => name,
"policyVersion" => policyVersion,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lifecycle_policy(
name,
policyVersion,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"UpdateLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policyVersion" => policyVersion,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_config(config_version, id)
update_security_config(config_version, id, params::Dict{String,<:Any})
Updates a security configuration for OpenSearch Serverless. For more information, see SAML
authentication for Amazon OpenSearch Serverless.
# Arguments
- `config_version`: The version of the security configuration to be updated. You can find
the most recent version of a security configuration using the GetSecurityPolicy command.
- `id`: The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the security configuration.
- `"samlOptions"`: SAML options in in the form of a key-value map.
"""
function update_security_config(
configVersion, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateSecurityConfig",
Dict{String,Any}(
"configVersion" => configVersion, "id" => id, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_config(
configVersion,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"UpdateSecurityConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configVersion" => configVersion,
"id" => id,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_policy(name, policy_version, type)
update_security_policy(name, policy_version, type, params::Dict{String,<:Any})
Updates an OpenSearch Serverless security policy. For more information, see Network access
for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
# Arguments
- `name`: The name of the policy.
- `policy_version`: The version of the policy being updated.
- `type`: The type of access policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"description"`: A description of the policy. Typically used to store information about
the permissions defined in the policy.
- `"policy"`: The JSON policy document to use as the content for the new policy.
"""
function update_security_policy(
name, policyVersion, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateSecurityPolicy",
Dict{String,Any}(
"name" => name,
"policyVersion" => policyVersion,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_policy(
name,
policyVersion,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opensearchserverless(
"UpdateSecurityPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policyVersion" => policyVersion,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vpc_endpoint(id)
update_vpc_endpoint(id, params::Dict{String,<:Any})
Updates an OpenSearch Serverless-managed interface endpoint. For more information, see
Access Amazon OpenSearch Serverless using an interface endpoint.
# Arguments
- `id`: The unique identifier of the interface endpoint to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addSecurityGroupIds"`: The unique identifiers of the security groups to add to the
endpoint. Security groups define the ports, protocols, and sources for inbound traffic that
you are authorizing into your endpoint.
- `"addSubnetIds"`: The ID of one or more subnets to add to the endpoint.
- `"clientToken"`: Unique, case-sensitive identifier to ensure idempotency of the request.
- `"removeSecurityGroupIds"`: The unique identifiers of the security groups to remove from
the endpoint.
- `"removeSubnetIds"`: The unique identifiers of the subnets to remove from the endpoint.
"""
function update_vpc_endpoint(id; aws_config::AbstractAWSConfig=global_aws_config())
return opensearchserverless(
"UpdateVpcEndpoint",
Dict{String,Any}("id" => id, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vpc_endpoint(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opensearchserverless(
"UpdateVpcEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 147630 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: opsworks
using AWS.Compat
using AWS.UUIDs
"""
assign_instance(instance_id, layer_ids)
assign_instance(instance_id, layer_ids, params::Dict{String,<:Any})
Assign a registered instance to a layer. You can assign registered on-premises instances
to any layer type. You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with OpsWorks Stacks.
Required Permissions: To use this action, an Identity and Access Management (IAM) user must
have a Manage permissions level for the stack or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
- `layer_ids`: The layer ID, which must correspond to a custom layer. You cannot assign a
registered instance to a built-in layer.
"""
function assign_instance(
InstanceId, LayerIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"AssignInstance",
Dict{String,Any}("InstanceId" => InstanceId, "LayerIds" => LayerIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assign_instance(
InstanceId,
LayerIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"AssignInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "LayerIds" => LayerIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assign_volume(volume_id)
assign_volume(volume_id, params::Dict{String,<:Any})
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The
volume must first be registered with the stack by calling RegisterVolume. After you
register the volume, you must call UpdateVolume to specify a mount point before calling
AssignVolume. For more information, see Resource Management. Required Permissions: To use
this action, an IAM user must have a Manage permissions level for the stack, or an attached
policy that explicitly grants permissions. For more information on user permissions, see
Managing User Permissions.
# Arguments
- `volume_id`: The volume ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The instance ID.
"""
function assign_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"AssignVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assign_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"AssignVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_elastic_ip(elastic_ip)
associate_elastic_ip(elastic_ip, params::Dict{String,<:Any})
Associates one of the stack's registered Elastic IP addresses with a specified instance.
The address must first be registered with the stack by calling RegisterElasticIp. For more
information, see Resource Management. Required Permissions: To use this action, an IAM
user must have a Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information on user permissions, see Managing User
Permissions.
# Arguments
- `elastic_ip`: The Elastic IP address.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The instance ID.
"""
function associate_elastic_ip(ElasticIp; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"AssociateElasticIp",
Dict{String,Any}("ElasticIp" => ElasticIp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_elastic_ip(
ElasticIp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"AssociateElasticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ElasticIp" => ElasticIp), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_elastic_load_balancer(elastic_load_balancer_name, layer_id)
attach_elastic_load_balancer(elastic_load_balancer_name, layer_id, params::Dict{String,<:Any})
Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does
not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks
Stacks. For more information, see Elastic Load Balancing. You must create the Elastic Load
Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI.
For more information, see the Elastic Load Balancing Developer Guide. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `elastic_load_balancer_name`: The Elastic Load Balancing instance's name.
- `layer_id`: The ID of the layer to which the Elastic Load Balancing instance is to be
attached.
"""
function attach_elastic_load_balancer(
ElasticLoadBalancerName, LayerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"AttachElasticLoadBalancer",
Dict{String,Any}(
"ElasticLoadBalancerName" => ElasticLoadBalancerName, "LayerId" => LayerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_elastic_load_balancer(
ElasticLoadBalancerName,
LayerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"AttachElasticLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ElasticLoadBalancerName" => ElasticLoadBalancerName,
"LayerId" => LayerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
clone_stack(service_role_arn, source_stack_id)
clone_stack(service_role_arn, source_stack_id, params::Dict{String,<:Any})
Creates a clone of a specified stack. For more information, see Clone a Stack. By default,
all parameters are set to the values used by the parent stack. Required Permissions: To
use this action, an IAM user must have an attached policy that explicitly grants
permissions. For more information about user permissions, see Managing User Permissions.
# Arguments
- `service_role_arn`: The stack Identity and Access Management (IAM) role, which allows
OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set
this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a
stack by using the OpsWorkss Stacks console, it creates the role for you. You can obtain an
existing stack's IAM ARN programmatically by calling DescribePermissions. For more
information about IAM ARNs, see Using Identifiers. You must set this parameter to a valid
service role ARN or the action will fail; there is no default value. You can specify the
source stack's service role ARN, if you prefer, but you must do so explicitly.
- `source_stack_id`: The source stack ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentVersion"`: The default OpsWorks Stacks agent version. You have the following
options: Auto-update - Set this parameter to LATEST. OpsWorks Stacks automatically
installs new agent versions on the stack's instances as soon as they are available. Fixed
version - Set this parameter to your preferred agent version. To update the agent version,
you must edit the stack configuration and specify a new version. OpsWorks Stacks
automatically installs that version on the stack's instances. The default setting is
LATEST. To specify an agent version, you must use the complete version number, not the
abbreviated number shown on the console. For a list of available agent version numbers,
call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. You can also specify
an agent version when you create or update an instance, which overrides the stack's default
setting.
- `"Attributes"`: A list of stack attributes and values as key/value pairs to be added to
the cloned stack.
- `"ChefConfiguration"`: A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create
a New Stack.
- `"CloneAppIds"`: A list of source stack app IDs to be included in the cloned stack.
- `"ClonePermissions"`: Whether to clone the source stack's permissions.
- `"ConfigurationManager"`: The configuration manager. When you clone a stack we recommend
that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for
Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently
12.
- `"CustomCookbooksSource"`: Contains the information required to retrieve an app or
cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
- `"CustomJson"`: A string that contains user-defined, custom JSON. It is used to override
the corresponding default stack configuration JSON values. The string should be in the
following format: \"{\"key1\": \"value1\", \"key2\": \"value2\",...}\" For more
information about custom JSON, see Use Custom JSON to Modify the Stack Configuration
Attributes
- `"DefaultAvailabilityZone"`: The cloned stack's default Availability Zone, which must be
in the specified region. For more information, see Regions and Endpoints. If you also
specify a value for DefaultSubnetId, the subnet must be in the same zone. For more
information, see the VpcId parameter description.
- `"DefaultInstanceProfileArn"`: The Amazon Resource Name (ARN) of an IAM profile that is
the default profile for all of the stack's EC2 instances. For more information about IAM
ARNs, see Using Identifiers.
- `"DefaultOs"`: The stack's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon
Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon
Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu
operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu
12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 Microsoft Windows Server
2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows
Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL
Server Web. A custom AMI: Custom. You specify the custom AMI you want to use when you
create instances. For more information about how to use custom AMIs with OpsWorks, see
Using Custom AMIs. The default option is the parent stack's operating system. Not all
operating systems are supported with all versions of Chef. For more information about
supported operating systems, see OpsWorks Stacks Operating Systems. You can specify a
different Linux operating system for the cloned stack, but you cannot change from Linux to
Windows or Windows to Linux.
- `"DefaultRootDeviceType"`: The default root device type. This value is used by default
for all instances in the cloned stack, but you can override it when you create an instance.
For more information, see Storage for the Root Device.
- `"DefaultSshKeyName"`: A default Amazon EC2 key pair name. The default value is none. If
you specify a key pair name, OpsWorks installs the public key on the instance and you can
use the private key with an SSH client to log in to the instance. For more information, see
Using SSH to Communicate with an Instance and Managing SSH Access. You can override this
setting by specifying a different key pair, or no key pair, when you create an instance.
- `"DefaultSubnetId"`: The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId parameter. All instances are launched into this subnet unless
you specify otherwise when you create the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone. For information on default values
and when this parameter is required, see the VpcId parameter description.
- `"HostnameTheme"`: The stack's host name theme, with spaces are replaced by underscores.
The theme is used to generate host names for the stack's instances. By default,
HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to
the layer's short name. The other themes are: Baked_Goods Clouds Europe_Cities
Fruits Greek_Deities_and_Titans Legendary_creatures_from_Japan
Planets_and_Moons Roman_Deities Scottish_Islands US_Cities Wild_Cats To
obtain a generated host name, call GetHostNameSuggestion, which returns a host name based
on the current theme.
- `"Name"`: The cloned stack name. Stack names can be a maximum of 64 characters.
- `"Region"`: The cloned stack Amazon Web Services Region, such as ap-northeast-2. For more
information about Amazon Web Services Regions, see Regions and Endpoints.
- `"UseCustomCookbooks"`: Whether to use custom cookbooks.
- `"UseOpsworksSecurityGroups"`: Whether to associate the OpsWorks Stacks built-in security
groups with the stack's layers. OpsWorks Stacks provides a standard set of security groups,
one for each layer, which are associated with layers by default. With
UseOpsworksSecurityGroups you can instead provide your own custom security groups.
UseOpsworksSecurityGroups has the following settings: True - OpsWorks Stacks
automatically associates the appropriate built-in security group with each layer (default
setting). You can associate additional security groups with a layer after you create it but
you cannot delete the built-in security group. False - OpsWorks Stacks does not associate
built-in security groups with layers. You must create appropriate Amazon EC2 security
groups and associate a security group with each layer that you create. However, you can
still manually associate a built-in security group with a layer on creation; custom
security groups are required only for those layers that need custom settings. For more
information, see Create a New Stack.
- `"VpcId"`: The ID of the VPC that the cloned stack is to be launched into. It must be in
the specified region. All instances are launched into this VPC, and you cannot change the
ID later. If your account supports EC2 Classic, the default value is no VPC. If your
account does not support EC2 Classic, the default value is the default VPC for the
specified region. If the VPC ID corresponds to a default VPC and you have specified
either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, OpsWorks Stacks
infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks
sets these parameters to the first valid Availability Zone for the specified region and the
corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID,
note the following: It must belong to a VPC in your account that is in the specified
region. You must specify a value for DefaultSubnetId. For more information about how to
use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about
default VPC and EC2 Classic, see Supported Platforms.
"""
function clone_stack(
ServiceRoleArn, SourceStackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"CloneStack",
Dict{String,Any}(
"ServiceRoleArn" => ServiceRoleArn, "SourceStackId" => SourceStackId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function clone_stack(
ServiceRoleArn,
SourceStackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CloneStack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServiceRoleArn" => ServiceRoleArn, "SourceStackId" => SourceStackId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app(name, stack_id, type)
create_app(name, stack_id, type, params::Dict{String,<:Any})
Creates an app for a specified stack. For more information, see Creating Apps. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `name`: The app name.
- `stack_id`: The stack ID.
- `type`: The app type. Each supported type is associated with a particular layer. For
example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an
application to those instances that are members of the corresponding layer. If your app
isn't one of the standard types, or you prefer to implement your own Deploy recipes,
specify other.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppSource"`: A Source object that specifies the app repository.
- `"Attributes"`: One or more user-defined key/value pairs to be added to the stack
attributes.
- `"DataSources"`: The app's data source.
- `"Description"`: A description of the app.
- `"Domains"`: The app virtual host settings, with multiple domains separated by commas.
For example: 'www.example.com, example.com'
- `"EnableSsl"`: Whether to enable SSL for the app.
- `"Environment"`: An array of EnvironmentVariable objects that specify environment
variables to be associated with the app. After you deploy the app, these variables are
defined on the associated app server instance. For more information, see Environment
Variables. There is no specific limit on the number of environment variables. However, the
size of the associated data structure - which includes the variables' names, values, and
protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all
use cases. Exceeding it will cause an exception with the message, \"Environment: is too
large (maximum is 20KB).\" If you have specified one or more environment variables, you
cannot modify the stack's Chef version.
- `"Shortname"`: The app's short name.
- `"SslConfiguration"`: An SslConfiguration object with the SSL configuration.
"""
function create_app(Name, StackId, Type; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"CreateApp",
Dict{String,Any}("Name" => Name, "StackId" => StackId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app(
Name,
StackId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateApp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "StackId" => StackId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment(command, stack_id)
create_deployment(command, stack_id, params::Dict{String,<:Any})
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack
Commands. Required Permissions: To use this action, an IAM user must have a Deploy or
Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `command`: A DeploymentCommand object that specifies the deployment command and any
associated arguments.
- `stack_id`: The stack ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppId"`: The app ID. This parameter is required for app deployments, but not for other
deployment commands.
- `"Comment"`: A user-defined comment.
- `"CustomJson"`: A string that contains user-defined, custom JSON. You can use this
parameter to override some corresponding default stack configuration JSON values. The
string should be in the following format: \"{\"key1\": \"value1\", \"key2\":
\"value2\",...}\" For more information about custom JSON, see Use Custom JSON to Modify
the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
- `"InstanceIds"`: The instance IDs for the deployment targets.
- `"LayerIds"`: The layer IDs for the deployment targets.
"""
function create_deployment(
Command, StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"CreateDeployment",
Dict{String,Any}("Command" => Command, "StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
Command,
StackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateDeployment",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Command" => Command, "StackId" => StackId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance(instance_type, layer_ids, stack_id)
create_instance(instance_type, layer_ids, stack_id, params::Dict{String,<:Any})
Creates an instance in a specified stack. For more information, see Adding an Instance to a
Layer. Required Permissions: To use this action, an IAM user must have a Manage
permissions level for the stack, or an attached policy that explicitly grants permissions.
For more information on user permissions, see Managing User Permissions.
# Arguments
- `instance_type`: The instance type, such as t2.micro. For a list of supported instance
types, open the stack in the console, choose Instances, and choose + Instance. The Size
list contains the currently supported types. For more information, see Instance Families
and Types. The parameter values that you use to specify the various types are in the API
Name column of the Available Instance Types table.
- `layer_ids`: An array that contains the instance's layer IDs.
- `stack_id`: The stack ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentVersion"`: The default OpsWorks Stacks agent version. You have the following
options: INHERIT - Use the stack's default agent version setting. version_number -
Use the specified agent version. This value overrides the stack's default setting. To
update the agent version, edit the instance configuration and specify a new version.
OpsWorks Stacks installs that version on the instance. The default setting is INHERIT. To
specify an agent version, you must use the complete version number, not the abbreviated
number shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
- `"AmiId"`: A custom AMI ID to be used to create the instance. The AMI should be based on
one of the supported operating systems. For more information, see Using Custom AMIs. If
you specify a custom AMI, you must set Os to Custom.
- `"Architecture"`: The instance architecture. The default option is x86_64. Instance types
do not necessarily support both architectures. For a list of the architectures that are
supported by the different instance types, see Instance Families and Types.
- `"AutoScalingType"`: For load-based or time-based instances, the type. Windows stacks can
use only time-based instances.
- `"AvailabilityZone"`: The instance Availability Zone. For more information, see Regions
and Endpoints.
- `"BlockDeviceMappings"`: An array of BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block Device Mapping. Note that block
device mappings are not supported for custom AMIs.
- `"EbsOptimized"`: Whether to create an Amazon EBS-optimized instance.
- `"Hostname"`: The instance host name. The following are character limits for instance
host names. Linux-based instances: 63 characters Windows-based instances: 15 characters
- `"InstallUpdatesOnBoot"`: Whether to install operating system and package updates when
the instance boots. The default value is true. To control when updates are installed, set
this value to false. You must then update your instances manually by using CreateDeployment
to run the update_dependencies stack command or by manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true
to ensure that your instances have the latest security updates.
- `"Os"`: The instance's operating system, which must be set to one of the following. A
supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon
Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon
Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu
operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu
12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 A supported Windows
operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server
2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard,
or Microsoft Windows Server 2012 R2 with SQL Server Web. A custom AMI: Custom. Not all
operating systems are supported with all versions of Chef. For more information about the
supported operating systems, see OpsWorks Stacks Operating Systems. The default option is
the current Amazon Linux version. If you set this parameter to Custom, you must use the
CreateInstance action's AmiId parameter to specify the custom AMI that you want to use.
Block device mappings are not supported if the value is Custom. For more information about
how to use custom AMIs with OpsWorks Stacks, see Using Custom AMIs.
- `"RootDeviceType"`: The instance root device type. For more information, see Storage for
the Root Device.
- `"SshKeyName"`: The instance's Amazon EC2 key-pair name.
- `"SubnetId"`: The ID of the instance's subnet. If the stack is running in a VPC, you can
use this parameter to override the stack's default subnet ID value and direct OpsWorks
Stacks to launch the instance in a different subnet.
- `"Tenancy"`: The instance's tenancy option. The default option is no tenancy, or if the
instance is running in a VPC, inherit tenancy settings from the VPC. The following are
valid values for this parameter: dedicated, default, or host. Because there are costs
associated with changes in tenancy options, we recommend that you research tenancy options
before choosing them for your instances. For more information about dedicated hosts, see
Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about
dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.
- `"VirtualizationType"`: The instance's virtualization type, paravirtual or hvm.
"""
function create_instance(
InstanceType, LayerIds, StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"CreateInstance",
Dict{String,Any}(
"InstanceType" => InstanceType, "LayerIds" => LayerIds, "StackId" => StackId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance(
InstanceType,
LayerIds,
StackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceType" => InstanceType,
"LayerIds" => LayerIds,
"StackId" => StackId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_layer(name, shortname, stack_id, type)
create_layer(name, shortname, stack_id, type, params::Dict{String,<:Any})
Creates a layer. For more information, see How to Create a Layer. You should use
CreateLayer for noncustom layer types such as PHP App Server only if the stack does not
have an existing layer of that type. A stack can have at most one instance of each
noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can
have an arbitrary number of custom layers, so you can call CreateLayer as many times as you
like for that layer type. Required Permissions: To use this action, an IAM user must have
a Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `name`: The layer name, which is used by the console. Layer names can be a maximum of 32
characters.
- `shortname`: For custom layers only, use this parameter to specify the layer's short
name, which is used internally by OpsWorks Stacks and by Chef recipes. The short name is
also used as the name for the directory where your app files are installed. It can have a
maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and
'.'. Built-in layer short names are defined by OpsWorks Stacks. For more information, see
the Layer Reference.
- `stack_id`: The layer stack ID.
- `type`: The layer type. A stack cannot have more than one built-in layer of the same
type. It can have any number of custom layers. Built-in layers are not available in Chef 12
stacks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: One or more user-defined key-value pairs to be added to the stack
attributes. To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
- `"AutoAssignElasticIps"`: Whether to automatically assign an Elastic IP address to the
layer's instances. For more information, see How to Edit a Layer.
- `"AutoAssignPublicIps"`: For stacks that are running in a VPC, whether to automatically
assign a public IP address to the layer's instances. For more information, see How to Edit
a Layer.
- `"CloudWatchLogsConfiguration"`: Specifies CloudWatch Logs configuration options for the
layer. For more information, see CloudWatchLogsLogStream.
- `"CustomInstanceProfileArn"`: The ARN of an IAM profile to be used for the layer's EC2
instances. For more information about IAM ARNs, see Using Identifiers.
- `"CustomJson"`: A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's instances. For more information, see
Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI.
- `"CustomRecipes"`: A LayerCustomRecipes object that specifies the layer custom recipes.
- `"CustomSecurityGroupIds"`: An array containing the layer custom security group IDs.
- `"EnableAutoHealing"`: Whether to disable auto healing for the layer.
- `"InstallUpdatesOnBoot"`: Whether to install operating system and package updates when
the instance boots. The default value is true. To control when updates are installed, set
this value to false. You must then update your instances manually by using CreateDeployment
to run the update_dependencies stack command or by manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. To ensure that your instances have the latest security
updates, we strongly recommend using the default value of true.
- `"LifecycleEventConfiguration"`: A LifeCycleEventConfiguration object that you can use to
configure the Shutdown event to specify an execution timeout and enable or disable Elastic
Load Balancer connection draining.
- `"Packages"`: An array of Package objects that describes the layer packages.
- `"UseEbsOptimizedInstances"`: Whether to use Amazon EBS-optimized instances.
- `"VolumeConfigurations"`: A VolumeConfigurations object that describes the layer's Amazon
EBS volumes.
"""
function create_layer(
Name, Shortname, StackId, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"CreateLayer",
Dict{String,Any}(
"Name" => Name, "Shortname" => Shortname, "StackId" => StackId, "Type" => Type
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_layer(
Name,
Shortname,
StackId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateLayer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"Shortname" => Shortname,
"StackId" => StackId,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stack(default_instance_profile_arn, name, region, service_role_arn)
create_stack(default_instance_profile_arn, name, region, service_role_arn, params::Dict{String,<:Any})
Creates a new stack. For more information, see Create a New Stack. Required Permissions:
To use this action, an IAM user must have an attached policy that explicitly grants
permissions. For more information about user permissions, see Managing User Permissions.
# Arguments
- `default_instance_profile_arn`: The Amazon Resource Name (ARN) of an IAM profile that is
the default profile for all of the stack's EC2 instances. For more information about IAM
ARNs, see Using Identifiers.
- `name`: The stack name. Stack names can be a maximum of 64 characters.
- `region`: The stack's Amazon Web Services Region, such as ap-south-1. For more
information about Amazon Web Services Regions, see Regions and Endpoints. In the CLI, this
API maps to the --stack-region parameter. If the --stack-region parameter and the CLI
common parameter --region are set to the same value, the stack uses a regional endpoint. If
the --stack-region parameter is not set, but the CLI --region parameter is, this also
results in a stack with a regional endpoint. However, if the --region parameter is set to
us-east-1, and the --stack-region parameter is set to one of the following, then the stack
uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1,
ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API endpoint of
the stack is in us-east-1. Only the preceding regions are supported as classic regions in
the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint
that is closest to where you manage Amazon Web Services, we recommend that you use regional
endpoints for new stacks. The CLI common --region parameter always specifies a regional API
endpoint; it cannot be used to specify a classic OpsWorks Stacks region.
- `service_role_arn`: The stack's IAM role, which allows OpsWorks Stacks to work with
Amazon Web Services resources on your behalf. You must set this parameter to the Amazon
Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see
Using Identifiers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentVersion"`: The default OpsWorks Stacks agent version. You have the following
options: Auto-update - Set this parameter to LATEST. OpsWorks Stacks automatically
installs new agent versions on the stack's instances as soon as they are available. Fixed
version - Set this parameter to your preferred agent version. To update the agent version,
you must edit the stack configuration and specify a new version. OpsWorks Stacks installs
that version on the stack's instances. The default setting is the most recent release of
the agent. To specify an agent version, you must use the complete version number, not the
abbreviated number shown on the console. For a list of available agent version numbers,
call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. You can also specify
an agent version when you create or update an instance, which overrides the stack's default
setting.
- `"Attributes"`: One or more user-defined key-value pairs to be added to the stack
attributes.
- `"ChefConfiguration"`: A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create
a New Stack.
- `"ConfigurationManager"`: The configuration manager. When you create a stack we recommend
that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for
Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently
12.
- `"CustomCookbooksSource"`: Contains the information required to retrieve an app or
cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
- `"CustomJson"`: A string that contains user-defined, custom JSON. It can be used to
override the corresponding default stack configuration attribute values or to pass data to
recipes. The string should be in the following format: \"{\"key1\": \"value1\", \"key2\":
\"value2\",...}\" For more information about custom JSON, see Use Custom JSON to Modify
the Stack Configuration Attributes.
- `"DefaultAvailabilityZone"`: The stack's default Availability Zone, which must be in the
specified region. For more information, see Regions and Endpoints. If you also specify a
value for DefaultSubnetId, the subnet must be in the same zone. For more information, see
the VpcId parameter description.
- `"DefaultOs"`: The stack's default operating system, which is installed on every instance
unless you specify a different operating system when you create the instance. You can
specify one of the following. A supported Linux operating system: An Amazon Linux
version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux
2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux
2015.03. A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS,
Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2
with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. A
custom AMI: Custom. You specify the custom AMI you want to use when you create instances.
For more information, see Using Custom AMIs. The default option is the current Amazon
Linux version. Not all operating systems are supported with all versions of Chef. For more
information about supported operating systems, see OpsWorks Stacks Operating Systems.
- `"DefaultRootDeviceType"`: The default root device type. This value is the default for
all instances in the stack, but you can override it when you create an instance. The
default option is instance-store. For more information, see Storage for the Root Device.
- `"DefaultSshKeyName"`: A default Amazon EC2 key pair name. The default value is none. If
you specify a key pair name, OpsWorks installs the public key on the instance and you can
use the private key with an SSH client to log in to the instance. For more information, see
Using SSH to Communicate with an Instance and Managing SSH Access. You can override this
setting by specifying a different key pair, or no key pair, when you create an instance.
- `"DefaultSubnetId"`: The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId parameter. All instances are launched into this subnet unless
you specify otherwise when you create the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone. For information on default values
and when this parameter is required, see the VpcId parameter description.
- `"HostnameTheme"`: The stack's host name theme, with spaces replaced by underscores. The
theme is used to generate host names for the stack's instances. By default, HostnameTheme
is set to Layer_Dependent, which creates host names by appending integers to the layer's
short name. The other themes are: Baked_Goods Clouds Europe_Cities Fruits
Greek_Deities_and_Titans Legendary_creatures_from_Japan Planets_and_Moons
Roman_Deities Scottish_Islands US_Cities Wild_Cats To obtain a generated
host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
- `"UseCustomCookbooks"`: Whether the stack uses custom cookbooks.
- `"UseOpsworksSecurityGroups"`: Whether to associate the OpsWorks Stacks built-in security
groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in
security groups, one for each layer, which are associated with layers by default. With
UseOpsworksSecurityGroups you can instead provide your own custom security groups.
UseOpsworksSecurityGroups has the following settings: True - OpsWorks Stacks
automatically associates the appropriate built-in security group with each layer (default
setting). You can associate additional security groups with a layer after you create it,
but you cannot delete the built-in security group. False - OpsWorks Stacks does not
associate built-in security groups with layers. You must create appropriate EC2 security
groups and associate a security group with each layer that you create. However, you can
still manually associate a built-in security group with a layer on creation; custom
security groups are required only for those layers that need custom settings. For more
information, see Create a New Stack.
- `"VpcId"`: The ID of the VPC that the stack is to be launched into. The VPC must be in
the stack's region. All instances are launched into this VPC. You cannot change the ID
later. If your account supports EC2-Classic, the default value is no VPC. If your
account does not support EC2-Classic, the default value is the default VPC for the
specified region. If the VPC ID corresponds to a default VPC and you have specified
either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, OpsWorks Stacks
infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks
sets these parameters to the first valid Availability Zone for the specified region and the
corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note
the following: It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId. For more information about how to use
OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about
default VPC and EC2-Classic, see Supported Platforms.
"""
function create_stack(
DefaultInstanceProfileArn,
Name,
Region,
ServiceRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateStack",
Dict{String,Any}(
"DefaultInstanceProfileArn" => DefaultInstanceProfileArn,
"Name" => Name,
"Region" => Region,
"ServiceRoleArn" => ServiceRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_stack(
DefaultInstanceProfileArn,
Name,
Region,
ServiceRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateStack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultInstanceProfileArn" => DefaultInstanceProfileArn,
"Name" => Name,
"Region" => Region,
"ServiceRoleArn" => ServiceRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_profile(iam_user_arn)
create_user_profile(iam_user_arn, params::Dict{String,<:Any})
Creates a new user profile. Required Permissions: To use this action, an IAM user must
have an attached policy that explicitly grants permissions. For more information about user
permissions, see Managing User Permissions.
# Arguments
- `iam_user_arn`: The user's IAM ARN; this can also be a federated user's ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowSelfManagement"`: Whether users can specify their own SSH public key through the
My Settings page. For more information, see Setting an IAM User's Public SSH Key.
- `"SshPublicKey"`: The user's public SSH key.
- `"SshUsername"`: The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other punctuation marks, OpsWorks
Stacks removes them. For example, my.name is changed to myname. If you do not specify an
SSH user name, OpsWorks Stacks generates one from the IAM user name.
"""
function create_user_profile(IamUserArn; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"CreateUserProfile",
Dict{String,Any}("IamUserArn" => IamUserArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_profile(
IamUserArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"CreateUserProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IamUserArn" => IamUserArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app(app_id)
delete_app(app_id, params::Dict{String,<:Any})
Deletes a specified app. Required Permissions: To use this action, an IAM user must have a
Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `app_id`: The app ID.
"""
function delete_app(AppId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeleteApp",
Dict{String,Any}("AppId" => AppId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app(
AppId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DeleteApp",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("AppId" => AppId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance(instance_id)
delete_instance(instance_id, params::Dict{String,<:Any})
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must
stop an instance before you can delete it. For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level
for the stack, or an attached policy that explicitly grants permissions. For more
information on user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteElasticIp"`: Whether to delete the instance Elastic IP address.
- `"DeleteVolumes"`: Whether to delete the instance's Amazon EBS volumes.
"""
function delete_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeleteInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeleteInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_layer(layer_id)
delete_layer(layer_id, params::Dict{String,<:Any})
Deletes a specified layer. You must first stop and then delete all associated instances or
unassign registered instances. For more information, see How to Delete a Layer. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `layer_id`: The layer ID.
"""
function delete_layer(LayerId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeleteLayer",
Dict{String,Any}("LayerId" => LayerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_layer(
LayerId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DeleteLayer",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("LayerId" => LayerId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stack(stack_id)
delete_stack(stack_id, params::Dict{String,<:Any})
Deletes a specified stack. You must first delete all instances, layers, and apps or
deregister registered instances. For more information, see Shut Down a Stack. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
"""
function delete_stack(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeleteStack",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stack(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DeleteStack",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_profile(iam_user_arn)
delete_user_profile(iam_user_arn, params::Dict{String,<:Any})
Deletes a user profile. Required Permissions: To use this action, an IAM user must have an
attached policy that explicitly grants permissions. For more information about user
permissions, see Managing User Permissions.
# Arguments
- `iam_user_arn`: The user's IAM ARN. This can also be a federated user's ARN.
"""
function delete_user_profile(IamUserArn; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeleteUserProfile",
Dict{String,Any}("IamUserArn" => IamUserArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_profile(
IamUserArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeleteUserProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IamUserArn" => IamUserArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_ecs_cluster(ecs_cluster_arn)
deregister_ecs_cluster(ecs_cluster_arn, params::Dict{String,<:Any})
Deregisters a specified Amazon ECS cluster from a stack. For more information, see
Resource Management. Required Permissions: To use this action, an IAM user must have a
Manage permissions level for the stack or an attached policy that explicitly grants
permissions. For more information on user permissions, see
https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
# Arguments
- `ecs_cluster_arn`: The cluster's Amazon Resource Number (ARN).
"""
function deregister_ecs_cluster(
EcsClusterArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DeregisterEcsCluster",
Dict{String,Any}("EcsClusterArn" => EcsClusterArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_ecs_cluster(
EcsClusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeregisterEcsCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EcsClusterArn" => EcsClusterArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_elastic_ip(elastic_ip)
deregister_elastic_ip(elastic_ip, params::Dict{String,<:Any})
Deregisters a specified Elastic IP address. The address can be registered by another stack
after it is deregistered. For more information, see Resource Management. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `elastic_ip`: The Elastic IP address.
"""
function deregister_elastic_ip(ElasticIp; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeregisterElasticIp",
Dict{String,Any}("ElasticIp" => ElasticIp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_elastic_ip(
ElasticIp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeregisterElasticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ElasticIp" => ElasticIp), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_instance(instance_id)
deregister_instance(instance_id, params::Dict{String,<:Any})
Deregister an instance from OpsWorks Stacks. The instance can be a registered instance
(Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the
instance from the stack and returns it to your control. Required Permissions: To use this
action, an IAM user must have a Manage permissions level for the stack or an attached
policy that explicitly grants permissions. For more information on user permissions, see
Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
"""
function deregister_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeregisterInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeregisterInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_rds_db_instance(rds_db_instance_arn)
deregister_rds_db_instance(rds_db_instance_arn, params::Dict{String,<:Any})
Deregisters an Amazon RDS instance. Required Permissions: To use this action, an IAM user
must have a Manage permissions level for the stack, or an attached policy that explicitly
grants permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `rds_db_instance_arn`: The Amazon RDS instance's ARN.
"""
function deregister_rds_db_instance(
RdsDbInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DeregisterRdsDbInstance",
Dict{String,Any}("RdsDbInstanceArn" => RdsDbInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_rds_db_instance(
RdsDbInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeregisterRdsDbInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RdsDbInstanceArn" => RdsDbInstanceArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_volume(volume_id)
deregister_volume(volume_id, params::Dict{String,<:Any})
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For
more information, see Resource Management. Required Permissions: To use this action, an
IAM user must have a Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information on user permissions, see Managing User
Permissions.
# Arguments
- `volume_id`: The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks
assigned to the instance when you registered the volume with the stack, not the Amazon EC2
volume ID.
"""
function deregister_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DeregisterVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DeregisterVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_agent_versions()
describe_agent_versions(params::Dict{String,<:Any})
Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a
configuration manager. DescribeAgentVersions returns a list of available agent versions for
the specified stack or configuration manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationManager"`: The configuration manager.
- `"StackId"`: The stack ID.
"""
function describe_agent_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeAgentVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_agent_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeAgentVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_apps()
describe_apps(params::Dict{String,<:Any})
Requests a description of a specified set of apps. This call accepts only one
resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppIds"`: An array of app IDs for the apps to be described. If you use this parameter,
DescribeApps returns a description of the specified apps. Otherwise, it returns a
description of every app.
- `"StackId"`: The app stack ID. If you use this parameter, DescribeApps returns a
description of the apps in the specified stack.
"""
function describe_apps(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks("DescribeApps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_apps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeApps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_commands()
describe_commands(params::Dict{String,<:Any})
Describes the results of specified commands. This call accepts only one
resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommandIds"`: An array of command IDs. If you include this parameter, DescribeCommands
returns a description of the specified commands. Otherwise, it returns a description of
every command.
- `"DeploymentId"`: The deployment ID. If you include this parameter, DescribeCommands
returns a description of the commands associated with the specified deployment.
- `"InstanceId"`: The instance ID. If you include this parameter, DescribeCommands returns
a description of the commands associated with the specified instance.
"""
function describe_commands(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeCommands"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_commands(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeCommands", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_deployments()
describe_deployments(params::Dict{String,<:Any})
Requests a description of a specified set of deployments. This call accepts only one
resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppId"`: The app ID. If you include this parameter, the command returns a description
of the commands associated with the specified app.
- `"DeploymentIds"`: An array of deployment IDs to be described. If you include this
parameter, the command returns a description of the specified deployments. Otherwise, it
returns a description of every deployment.
- `"StackId"`: The stack ID. If you include this parameter, the command returns a
description of the commands associated with the specified stack.
"""
function describe_deployments(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeDeployments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_deployments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeDeployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ecs_clusters()
describe_ecs_clusters(params::Dict{String,<:Any})
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack
ID, you can use the MaxResults and NextToken parameters to paginate the response. However,
OpsWorks Stacks currently supports only one cluster per layer, so the result set has a
maximum of one element. Required Permissions: To use this action, an IAM user must have a
Show, Deploy, or Manage permissions level for the stack or an attached policy that
explicitly grants permission. For more information about user permissions, see Managing
User Permissions. This call accepts only one resource-identifying parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EcsClusterArns"`: A list of ARNs, one for each cluster to be described.
- `"MaxResults"`: To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the number of available
results exceeds this maximum, the response includes a NextToken value that you can assign
to the NextToken request parameter to get the next set of results.
- `"NextToken"`: If the previous paginated request did not return all of the remaining
results, the response object'sNextToken parameter value is set to a token. To retrieve the
next set of results, call DescribeEcsClusters again and assign that token to the request
object's NextToken parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
- `"StackId"`: A stack ID. DescribeEcsClusters returns a description of the cluster that is
registered with the stack.
"""
function describe_ecs_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeEcsClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_ecs_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeEcsClusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_elastic_ips()
describe_elastic_ips(params::Dict{String,<:Any})
Describes Elastic IP addresses. This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage
permissions level for the stack, or an attached policy that explicitly grants permissions.
For more information about user permissions, see Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The instance ID. If you include this parameter, DescribeElasticIps
returns a description of the Elastic IP addresses associated with the specified instance.
- `"Ips"`: An array of Elastic IP addresses to be described. If you include this parameter,
DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise,
it returns a description of every Elastic IP address.
- `"StackId"`: A stack ID. If you include this parameter, DescribeElasticIps returns a
description of the Elastic IP addresses that are registered with the specified stack.
"""
function describe_elastic_ips(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeElasticIps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_elastic_ips(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeElasticIps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_elastic_load_balancers()
describe_elastic_load_balancers(params::Dict{String,<:Any})
Describes a stack's Elastic Load Balancing instances. This call accepts only one
resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LayerIds"`: A list of layer IDs. The action describes the Elastic Load Balancing
instances for the specified layers.
- `"StackId"`: A stack ID. The action describes the stack's Elastic Load Balancing
instances.
"""
function describe_elastic_load_balancers(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeElasticLoadBalancers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_elastic_load_balancers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeElasticLoadBalancers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instances()
describe_instances(params::Dict{String,<:Any})
Requests a description of a set of instances. This call accepts only one
resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceIds"`: An array of instance IDs to be described. If you use this parameter,
DescribeInstances returns a description of the specified instances. Otherwise, it returns a
description of every instance.
- `"LayerId"`: A layer ID. If you use this parameter, DescribeInstances returns
descriptions of the instances associated with the specified layer.
- `"StackId"`: A stack ID. If you use this parameter, DescribeInstances returns
descriptions of the instances associated with the specified stack.
"""
function describe_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeInstances", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_layers()
describe_layers(params::Dict{String,<:Any})
Requests a description of one or more layers in a specified stack. This call accepts only
one resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LayerIds"`: An array of layer IDs that specify the layers to be described. If you omit
this parameter, DescribeLayers returns a description of every layer in the specified stack.
- `"StackId"`: The stack ID.
"""
function describe_layers(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeLayers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_layers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeLayers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_load_based_auto_scaling(layer_ids)
describe_load_based_auto_scaling(layer_ids, params::Dict{String,<:Any})
Describes load-based auto scaling configurations for specified layers. You must specify at
least one of the parameters. Required Permissions: To use this action, an IAM user must
have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information about user permissions, see Managing
User Permissions.
# Arguments
- `layer_ids`: An array of layer IDs.
"""
function describe_load_based_auto_scaling(
LayerIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeLoadBasedAutoScaling",
Dict{String,Any}("LayerIds" => LayerIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_load_based_auto_scaling(
LayerIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DescribeLoadBasedAutoScaling",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LayerIds" => LayerIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_my_user_profile()
describe_my_user_profile(params::Dict{String,<:Any})
Describes a user's SSH information. Required Permissions: To use this action, an IAM user
must have self-management enabled or an attached policy that explicitly grants permissions.
For more information about user permissions, see Managing User Permissions.
"""
function describe_my_user_profile(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeMyUserProfile"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_my_user_profile(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeMyUserProfile",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_operating_systems()
describe_operating_systems(params::Dict{String,<:Any})
Describes the operating systems that are supported by OpsWorks Stacks.
"""
function describe_operating_systems(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeOperatingSystems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_operating_systems(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeOperatingSystems",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_permissions()
describe_permissions(params::Dict{String,<:Any})
Describes the permissions for a specified stack. Required Permissions: To use this action,
an IAM user must have a Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information on user permissions, see Managing User
Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IamUserArn"`: The user's IAM ARN. This can also be a federated user's ARN. For more
information about IAM ARNs, see Using Identifiers.
- `"StackId"`: The stack ID.
"""
function describe_permissions(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribePermissions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_permissions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribePermissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_raid_arrays()
describe_raid_arrays(params::Dict{String,<:Any})
Describe an instance's RAID arrays. This call accepts only one resource-identifying
parameter. Required Permissions: To use this action, an IAM user must have a Show,
Deploy, or Manage permissions level for the stack, or an attached policy that explicitly
grants permissions. For more information about user permissions, see Managing User
Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The instance ID. If you use this parameter, DescribeRaidArrays returns
descriptions of the RAID arrays associated with the specified instance.
- `"RaidArrayIds"`: An array of RAID array IDs. If you use this parameter,
DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a
description of every array.
- `"StackId"`: The stack ID.
"""
function describe_raid_arrays(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeRaidArrays"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_raid_arrays(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeRaidArrays", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_rds_db_instances(stack_id)
describe_rds_db_instances(stack_id, params::Dict{String,<:Any})
Describes Amazon RDS instances. Required Permissions: To use this action, an IAM user must
have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information about user permissions, see Managing
User Permissions. This call accepts only one resource-identifying parameter.
# Arguments
- `stack_id`: The ID of the stack with which the instances are registered. The operation
returns descriptions of all registered Amazon RDS instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RdsDbInstanceArns"`: An array containing the ARNs of the instances to be described.
"""
function describe_rds_db_instances(
StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeRdsDbInstances",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_rds_db_instances(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeRdsDbInstances",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_service_errors()
describe_service_errors(params::Dict{String,<:Any})
Describes OpsWorks Stacks service errors. Required Permissions: To use this action, an IAM
user must have a Show, Deploy, or Manage permissions level for the stack, or an attached
policy that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions. This call accepts only one resource-identifying parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The instance ID. If you use this parameter, DescribeServiceErrors returns
descriptions of the errors associated with the specified instance.
- `"ServiceErrorIds"`: An array of service error IDs. If you use this parameter,
DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a
description of every error.
- `"StackId"`: The stack ID. If you use this parameter, DescribeServiceErrors returns
descriptions of the errors associated with the specified stack.
"""
function describe_service_errors(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeServiceErrors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_service_errors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeServiceErrors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stack_provisioning_parameters(stack_id)
describe_stack_provisioning_parameters(stack_id, params::Dict{String,<:Any})
Requests a description of a stack's provisioning parameters. Required Permissions: To use
this action, an IAM user must have a Show, Deploy, or Manage permissions level for the
stack or an attached policy that explicitly grants permissions. For more information about
user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
"""
function describe_stack_provisioning_parameters(
StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeStackProvisioningParameters",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_stack_provisioning_parameters(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeStackProvisioningParameters",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stack_summary(stack_id)
describe_stack_summary(stack_id, params::Dict{String,<:Any})
Describes the number of layers and apps in a specified stack, and the number of instances
in each state, such as running_setup or online. Required Permissions: To use this action,
an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an
attached policy that explicitly grants permissions. For more information about user
permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
"""
function describe_stack_summary(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeStackSummary",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_stack_summary(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeStackSummary",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stacks()
describe_stacks(params::Dict{String,<:Any})
Requests a description of one or more stacks. Required Permissions: To use this action, an
IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an
attached policy that explicitly grants permissions. For more information about user
permissions, see Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StackIds"`: An array of stack IDs that specify the stacks to be described. If you omit
this parameter, and have permissions to get information about all stacks, DescribeStacks
returns a description of every stack. If the IAM policy that is attached to an IAM user
limits the DescribeStacks action to specific stack ARNs, this parameter is required, and
the user must specify a stack ARN that is allowed by the policy. Otherwise, DescribeStacks
returns an AccessDenied error.
"""
function describe_stacks(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeStacks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_stacks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeStacks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_time_based_auto_scaling(instance_ids)
describe_time_based_auto_scaling(instance_ids, params::Dict{String,<:Any})
Describes time-based auto scaling configurations for specified instances. You must specify
at least one of the parameters. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Arguments
- `instance_ids`: An array of instance IDs.
"""
function describe_time_based_auto_scaling(
InstanceIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeTimeBasedAutoScaling",
Dict{String,Any}("InstanceIds" => InstanceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_time_based_auto_scaling(
InstanceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DescribeTimeBasedAutoScaling",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceIds" => InstanceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_profiles()
describe_user_profiles(params::Dict{String,<:Any})
Describe specified users. Required Permissions: To use this action, an IAM user must have
an attached policy that explicitly grants permissions. For more information about user
permissions, see Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IamUserArns"`: An array of IAM or federated user ARNs that identify the users to be
described.
"""
function describe_user_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeUserProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_user_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeUserProfiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_volumes()
describe_volumes(params::Dict{String,<:Any})
Describes an instance's Amazon EBS volumes. This call accepts only one
resource-identifying parameter. Required Permissions: To use this action, an IAM user
must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy
that explicitly grants permissions. For more information about user permissions, see
Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The instance ID. If you use this parameter, DescribeVolumes returns
descriptions of the volumes associated with the specified instance.
- `"RaidArrayId"`: The RAID array ID. If you use this parameter, DescribeVolumes returns
descriptions of the volumes associated with the specified RAID array.
- `"StackId"`: A stack ID. The action describes the stack's registered Amazon EBS volumes.
- `"VolumeIds"`: Am array of volume IDs. If you use this parameter, DescribeVolumes returns
descriptions of the specified volumes. Otherwise, it returns a description of every volume.
"""
function describe_volumes(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"DescribeVolumes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_volumes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DescribeVolumes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
detach_elastic_load_balancer(elastic_load_balancer_name, layer_id)
detach_elastic_load_balancer(elastic_load_balancer_name, layer_id, params::Dict{String,<:Any})
Detaches a specified Elastic Load Balancing instance from its layer. Required Permissions:
To use this action, an IAM user must have a Manage permissions level for the stack, or an
attached policy that explicitly grants permissions. For more information on user
permissions, see Managing User Permissions.
# Arguments
- `elastic_load_balancer_name`: The Elastic Load Balancing instance's name.
- `layer_id`: The ID of the layer that the Elastic Load Balancing instance is attached to.
"""
function detach_elastic_load_balancer(
ElasticLoadBalancerName, LayerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DetachElasticLoadBalancer",
Dict{String,Any}(
"ElasticLoadBalancerName" => ElasticLoadBalancerName, "LayerId" => LayerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_elastic_load_balancer(
ElasticLoadBalancerName,
LayerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DetachElasticLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ElasticLoadBalancerName" => ElasticLoadBalancerName,
"LayerId" => LayerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_elastic_ip(elastic_ip)
disassociate_elastic_ip(elastic_ip, params::Dict{String,<:Any})
Disassociates an Elastic IP address from its instance. The address remains registered with
the stack. For more information, see Resource Management. Required Permissions: To use
this action, an IAM user must have a Manage permissions level for the stack, or an attached
policy that explicitly grants permissions. For more information on user permissions, see
Managing User Permissions.
# Arguments
- `elastic_ip`: The Elastic IP address.
"""
function disassociate_elastic_ip(
ElasticIp; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"DisassociateElasticIp",
Dict{String,Any}("ElasticIp" => ElasticIp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_elastic_ip(
ElasticIp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"DisassociateElasticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ElasticIp" => ElasticIp), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_hostname_suggestion(layer_id)
get_hostname_suggestion(layer_id, params::Dict{String,<:Any})
Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level
for the stack, or an attached policy that explicitly grants permissions. For more
information on user permissions, see Managing User Permissions.
# Arguments
- `layer_id`: The layer ID.
"""
function get_hostname_suggestion(LayerId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"GetHostnameSuggestion",
Dict{String,Any}("LayerId" => LayerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_hostname_suggestion(
LayerId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"GetHostnameSuggestion",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("LayerId" => LayerId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
grant_access(instance_id)
grant_access(instance_id, params::Dict{String,<:Any})
This action can be used only with Windows stacks. Grants RDP access to a Windows instance
for a specified time period.
# Arguments
- `instance_id`: The instance's OpsWorks Stacks ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ValidForInMinutes"`: The length of time (in minutes) that the grant is valid. When the
grant expires at the end of this period, the user will no longer be able to use the
credentials to log in. If the user is logged in at the time, they are logged out.
"""
function grant_access(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"GrantAccess",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function grant_access(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"GrantAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(resource_arn)
list_tags(resource_arn, params::Dict{String,<:Any})
Returns a list of tags that are applied to the specified stack or layer.
# Arguments
- `resource_arn`: The stack or layer's Amazon Resource Number (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Do not use. A validation exception occurs if you add a MaxResults
parameter to a ListTagsRequest call.
- `"NextToken"`: Do not use. A validation exception occurs if you add a NextToken parameter
to a ListTagsRequest call.
"""
function list_tags(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"ListTags",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"ListTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_instance(instance_id)
reboot_instance(instance_id, params::Dict{String,<:Any})
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting
Instances. Required Permissions: To use this action, an IAM user must have a Manage
permissions level for the stack, or an attached policy that explicitly grants permissions.
For more information on user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
"""
function reboot_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"RebootInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"RebootInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_ecs_cluster(ecs_cluster_arn, stack_id)
register_ecs_cluster(ecs_cluster_arn, stack_id, params::Dict{String,<:Any})
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster
with a stack. A cluster can be registered with only one stack. For more information, see
Resource Management. Required Permissions: To use this action, an IAM user must have a
Manage permissions level for the stack or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `ecs_cluster_arn`: The cluster's ARN.
- `stack_id`: The stack ID.
"""
function register_ecs_cluster(
EcsClusterArn, StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"RegisterEcsCluster",
Dict{String,Any}("EcsClusterArn" => EcsClusterArn, "StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_ecs_cluster(
EcsClusterArn,
StackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"RegisterEcsCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EcsClusterArn" => EcsClusterArn, "StackId" => StackId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_elastic_ip(elastic_ip, stack_id)
register_elastic_ip(elastic_ip, stack_id, params::Dict{String,<:Any})
Registers an Elastic IP address with a specified stack. An address can be registered with
only one stack at a time. If the address is already registered, you must first deregister
it by calling DeregisterElasticIp. For more information, see Resource Management. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `elastic_ip`: The Elastic IP address.
- `stack_id`: The stack ID.
"""
function register_elastic_ip(
ElasticIp, StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"RegisterElasticIp",
Dict{String,Any}("ElasticIp" => ElasticIp, "StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_elastic_ip(
ElasticIp,
StackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"RegisterElasticIp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ElasticIp" => ElasticIp, "StackId" => StackId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_instance(stack_id)
register_instance(stack_id, params::Dict{String,<:Any})
Registers instances that were created outside of OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration
operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and
registering the instance with the stack. RegisterInstance handles only the second step. You
should instead use the CLI register command, which performs the entire registration
operation. For more information, see Registering an Instance with an OpsWorks Stacks
Stack. Registered instances have the same requirements as instances that are created by
using the CreateInstance API. For example, registered instances must be running a supported
Linux-based operating system, and they must have a supported instance type. For more
information about requirements for instances that you want to register, see Preparing the
Instance. Required Permissions: To use this action, an IAM user must have a Manage
permissions level for the stack or an attached policy that explicitly grants permissions.
For more information on user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The ID of the stack that the instance is to be registered with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Hostname"`: The instance's host name. The following are character limits for instance
host names. Linux-based instances: 63 characters Windows-based instances: 15 characters
- `"InstanceIdentity"`: An InstanceIdentity object that contains the instance's identity.
- `"PrivateIp"`: The instance's private IP address.
- `"PublicIp"`: The instance's public IP address.
- `"RsaPublicKey"`: The instances public RSA key. This key is used to encrypt communication
between the instance and the service.
- `"RsaPublicKeyFingerprint"`: The instances public RSA key fingerprint.
"""
function register_instance(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"RegisterInstance",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_instance(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"RegisterInstance",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_rds_db_instance(db_password, db_user, rds_db_instance_arn, stack_id)
register_rds_db_instance(db_password, db_user, rds_db_instance_arn, stack_id, params::Dict{String,<:Any})
Registers an Amazon RDS instance with a stack. Required Permissions: To use this action,
an IAM user must have a Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information on user permissions, see Managing User
Permissions.
# Arguments
- `db_password`: The database password.
- `db_user`: The database's master user name.
- `rds_db_instance_arn`: The Amazon RDS instance's ARN.
- `stack_id`: The stack ID.
"""
function register_rds_db_instance(
DbPassword,
DbUser,
RdsDbInstanceArn,
StackId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"RegisterRdsDbInstance",
Dict{String,Any}(
"DbPassword" => DbPassword,
"DbUser" => DbUser,
"RdsDbInstanceArn" => RdsDbInstanceArn,
"StackId" => StackId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_rds_db_instance(
DbPassword,
DbUser,
RdsDbInstanceArn,
StackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"RegisterRdsDbInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DbPassword" => DbPassword,
"DbUser" => DbUser,
"RdsDbInstanceArn" => RdsDbInstanceArn,
"StackId" => StackId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_volume(stack_id)
register_volume(stack_id, params::Dict{String,<:Any})
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only
one stack at a time. If the volume is already registered, you must first deregister it by
calling DeregisterVolume. For more information, see Resource Management. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ec2VolumeId"`: The Amazon EBS volume ID.
"""
function register_volume(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"RegisterVolume",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_volume(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"RegisterVolume",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_load_based_auto_scaling(layer_id)
set_load_based_auto_scaling(layer_id, params::Dict{String,<:Any})
Specify the load-based auto scaling configuration for a specified layer. For more
information, see Managing Load with Time-based and Load-based Instances. To use load-based
auto scaling, you must create a set of load-based auto scaling instances. Load-based auto
scaling operates only on the instances from that set, so you must ensure that you have
created enough instances to handle the maximum anticipated load. Required Permissions: To
use this action, an IAM user must have a Manage permissions level for the stack, or an
attached policy that explicitly grants permissions. For more information on user
permissions, see Managing User Permissions.
# Arguments
- `layer_id`: The layer ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DownScaling"`: An AutoScalingThresholds object with the downscaling threshold
configuration. If the load falls below these thresholds for a specified amount of time,
OpsWorks Stacks stops a specified number of instances.
- `"Enable"`: Enables load-based auto scaling for the layer.
- `"UpScaling"`: An AutoScalingThresholds object with the upscaling threshold
configuration. If the load exceeds these thresholds for a specified amount of time,
OpsWorks Stacks starts a specified number of instances.
"""
function set_load_based_auto_scaling(
LayerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"SetLoadBasedAutoScaling",
Dict{String,Any}("LayerId" => LayerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_load_based_auto_scaling(
LayerId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"SetLoadBasedAutoScaling",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("LayerId" => LayerId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_permission(iam_user_arn, stack_id)
set_permission(iam_user_arn, stack_id, params::Dict{String,<:Any})
Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level
for the stack, or an attached policy that explicitly grants permissions. For more
information on user permissions, see Managing User Permissions.
# Arguments
- `iam_user_arn`: The user's IAM ARN. This can also be a federated user's ARN.
- `stack_id`: The stack ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowSsh"`: The user is allowed to use SSH to communicate with the instance.
- `"AllowSudo"`: The user is allowed to use sudo to elevate privileges.
- `"Level"`: The user's permission level, which must be set to one of the following
strings. You cannot set your own permissions level. deny show deploy manage
iam_only For more information about the permissions associated with these levels, see
Managing User Permissions.
"""
function set_permission(
IamUserArn, StackId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"SetPermission",
Dict{String,Any}("IamUserArn" => IamUserArn, "StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_permission(
IamUserArn,
StackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"SetPermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IamUserArn" => IamUserArn, "StackId" => StackId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_time_based_auto_scaling(instance_id)
set_time_based_auto_scaling(instance_id, params::Dict{String,<:Any})
Specify the time-based auto scaling configuration for a specified instance. For more
information, see Managing Load with Time-based and Load-based Instances. Required
Permissions: To use this action, an IAM user must have a Manage permissions level for the
stack, or an attached policy that explicitly grants permissions. For more information on
user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoScalingSchedule"`: An AutoScalingSchedule with the instance schedule.
"""
function set_time_based_auto_scaling(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"SetTimeBasedAutoScaling",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_time_based_auto_scaling(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"SetTimeBasedAutoScaling",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_instance(instance_id)
start_instance(instance_id, params::Dict{String,<:Any})
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting
Instances. Required Permissions: To use this action, an IAM user must have a Manage
permissions level for the stack, or an attached policy that explicitly grants permissions.
For more information on user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
"""
function start_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"StartInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"StartInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_stack(stack_id)
start_stack(stack_id, params::Dict{String,<:Any})
Starts a stack's instances. Required Permissions: To use this action, an IAM user must
have a Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
"""
function start_stack(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"StartStack",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_stack(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"StartStack",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_instance(instance_id)
stop_instance(instance_id, params::Dict{String,<:Any})
Stops a specified instance. When you stop a standard instance, the data disappears and must
be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance
without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level
for the stack, or an attached policy that explicitly grants permissions. For more
information on user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: Specifies whether to force an instance to stop. If the instance's root device
type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call
disassociates the OpsWorks Stacks instance from EC2, and forces deletion of only the
OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2
after troubleshooting and replacing the OpsWorks Stacks instance with a new one.
"""
function stop_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"StopInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"StopInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_stack(stack_id)
stop_stack(stack_id, params::Dict{String,<:Any})
Stops a specified stack. Required Permissions: To use this action, an IAM user must have a
Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
"""
function stop_stack(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"StopStack",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_stack(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"StopStack",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more
information about how tagging works, see Tags in the OpsWorks User Guide.
# Arguments
- `resource_arn`: The stack or layer's Amazon Resource Number (ARN).
- `tags`: A map that contains tag keys and tag values that are attached to a stack or
layer. The key cannot be empty. The key can be a maximum of 127 characters, and can
contain only Unicode letters, numbers, or separators, or the following special characters:
+ - = . _ : / The value can be a maximum 255 characters, and contain only Unicode
letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value. A maximum of
40 tags is allowed for any resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unassign_instance(instance_id)
unassign_instance(instance_id, params::Dict{String,<:Any})
Unassigns a registered instance from all layers that are using the instance. The instance
remains in the stack as an unassigned instance, and can be assigned to another layer as
needed. You cannot use this action with instances that were created with OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level
for the stack or an attached policy that explicitly grants permissions. For more
information about user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
"""
function unassign_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UnassignInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unassign_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UnassignInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unassign_volume(volume_id)
unassign_volume(volume_id, params::Dict{String,<:Any})
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For
more information, see Resource Management. Required Permissions: To use this action, an
IAM user must have a Manage permissions level for the stack, or an attached policy that
explicitly grants permissions. For more information on user permissions, see Managing User
Permissions.
# Arguments
- `volume_id`: The volume ID.
"""
function unassign_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UnassignVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unassign_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UnassignVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a specified stack or layer.
# Arguments
- `resource_arn`: The stack or layer's Amazon Resource Number (ARN).
- `tag_keys`: A list of the keys of tags to be removed from a stack or layer.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_app(app_id)
update_app(app_id, params::Dict{String,<:Any})
Updates a specified app. Required Permissions: To use this action, an IAM user must have a
Deploy or Manage permissions level for the stack, or an attached policy that explicitly
grants permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `app_id`: The app ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppSource"`: A Source object that specifies the app repository.
- `"Attributes"`: One or more user-defined key/value pairs to be added to the stack
attributes.
- `"DataSources"`: The app's data sources.
- `"Description"`: A description of the app.
- `"Domains"`: The app's virtual host settings, with multiple domains separated by commas.
For example: 'www.example.com, example.com'
- `"EnableSsl"`: Whether SSL is enabled for the app.
- `"Environment"`: An array of EnvironmentVariable objects that specify environment
variables to be associated with the app. After you deploy the app, these variables are
defined on the associated app server instances.For more information, see Environment
Variables. There is no specific limit on the number of environment variables. However, the
size of the associated data structure - which includes the variables' names, values, and
protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all
use cases. Exceeding it will cause an exception with the message, \"Environment: is too
large (maximum is 20 KB).\" If you have specified one or more environment variables, you
cannot modify the stack's Chef version.
- `"Name"`: The app name.
- `"SslConfiguration"`: An SslConfiguration object with the SSL configuration.
- `"Type"`: The app type.
"""
function update_app(AppId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateApp",
Dict{String,Any}("AppId" => AppId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app(
AppId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"UpdateApp",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("AppId" => AppId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_elastic_ip(elastic_ip)
update_elastic_ip(elastic_ip, params::Dict{String,<:Any})
Updates a registered Elastic IP address's name. For more information, see Resource
Management. Required Permissions: To use this action, an IAM user must have a Manage
permissions level for the stack, or an attached policy that explicitly grants permissions.
For more information on user permissions, see Managing User Permissions.
# Arguments
- `elastic_ip`: The IP address for which you want to update the name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The new name, which can be a maximum of 32 characters.
"""
function update_elastic_ip(ElasticIp; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateElasticIp",
Dict{String,Any}("ElasticIp" => ElasticIp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_elastic_ip(
ElasticIp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UpdateElasticIp",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ElasticIp" => ElasticIp), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance(instance_id)
update_instance(instance_id, params::Dict{String,<:Any})
Updates a specified instance. Required Permissions: To use this action, an IAM user must
have a Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `instance_id`: The instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentVersion"`: The default OpsWorks Stacks agent version. You have the following
options: INHERIT - Use the stack's default agent version setting. version_number -
Use the specified agent version. This value overrides the stack's default setting. To
update the agent version, you must edit the instance configuration and specify a new
version. OpsWorks Stacks installs that version on the instance. The default setting is
INHERIT. To specify an agent version, you must use the complete version number, not the
abbreviated number shown on the console. For a list of available agent version numbers,
call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
- `"AmiId"`: The ID of the AMI that was used to create the instance. The value of this
parameter must be the same AMI ID that the instance is already using. You cannot apply a
new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances
that are using custom AMIs.
- `"Architecture"`: The instance architecture. Instance types do not necessarily support
both architectures. For a list of the architectures that are supported by the different
instance types, see Instance Families and Types.
- `"AutoScalingType"`: For load-based or time-based instances, the type. Windows stacks can
use only time-based instances.
- `"EbsOptimized"`: This property cannot be updated.
- `"Hostname"`: The instance host name. The following are character limits for instance
host names. Linux-based instances: 63 characters Windows-based instances: 15 characters
- `"InstallUpdatesOnBoot"`: Whether to install operating system and package updates when
the instance boots. The default value is true. To control when updates are installed, set
this value to false. You must then update your instances manually by using CreateDeployment
to run the update_dependencies stack command or by manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true,
to ensure that your instances have the latest security updates.
- `"InstanceType"`: The instance type, such as t2.micro. For a list of supported instance
types, open the stack in the console, choose Instances, and choose + Instance. The Size
list contains the currently supported types. For more information, see Instance Families
and Types. The parameter values that you use to specify the various types are in the API
Name column of the Available Instance Types table.
- `"LayerIds"`: The instance's layer IDs.
- `"Os"`: The instance's operating system, which must be set to one of the following. You
cannot update an instance that is using a custom AMI. A supported Linux operating system:
An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux
2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux
2015.09, or Amazon Linux 2015.03. A supported Ubuntu operating system, such as Ubuntu
18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7
Red Hat Enterprise Linux 7 A supported Windows operating system, such as Microsoft
Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express,
Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012
R2 with SQL Server Web. Not all operating systems are supported with all versions of
Chef. For more information about supported operating systems, see OpsWorks Stacks Operating
Systems. The default option is the current Amazon Linux version. If you set this parameter
to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use.
For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.
You can specify a different Linux operating system for the updated stack, but you cannot
change from Linux to Windows or Windows to Linux.
- `"SshKeyName"`: The instance's Amazon EC2 key name.
"""
function update_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UpdateInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_layer(layer_id)
update_layer(layer_id, params::Dict{String,<:Any})
Updates a specified layer. Required Permissions: To use this action, an IAM user must have
a Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `layer_id`: The layer ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: One or more user-defined key/value pairs to be added to the stack
attributes.
- `"AutoAssignElasticIps"`: Whether to automatically assign an Elastic IP address to the
layer's instances. For more information, see How to Edit a Layer.
- `"AutoAssignPublicIps"`: For stacks that are running in a VPC, whether to automatically
assign a public IP address to the layer's instances. For more information, see How to Edit
a Layer.
- `"CloudWatchLogsConfiguration"`: Specifies CloudWatch Logs configuration options for the
layer. For more information, see CloudWatchLogsLogStream.
- `"CustomInstanceProfileArn"`: The ARN of an IAM profile to be used for all of the layer's
EC2 instances. For more information about IAM ARNs, see Using Identifiers.
- `"CustomJson"`: A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's instances. For more information, see
Using Custom JSON.
- `"CustomRecipes"`: A LayerCustomRecipes object that specifies the layer's custom recipes.
- `"CustomSecurityGroupIds"`: An array containing the layer's custom security group IDs.
- `"EnableAutoHealing"`: Whether to disable auto healing for the layer.
- `"InstallUpdatesOnBoot"`: Whether to install operating system and package updates when
the instance boots. The default value is true. To control when updates are installed, set
this value to false. You must then update your instances manually by using CreateDeployment
to run the update_dependencies stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true,
to ensure that your instances have the latest security updates.
- `"LifecycleEventConfiguration"`:
- `"Name"`: The layer name, which is used by the console. Layer names can be a maximum of
32 characters.
- `"Packages"`: An array of Package objects that describe the layer's packages.
- `"Shortname"`: For custom layers only, use this parameter to specify the layer's short
name, which is used internally by OpsWorks Stacks and by Chef. The short name is also used
as the name for the directory where your app files are installed. It can have a maximum of
32 characters and must be in the following format: /A[a-z0-9-_.]+Z/. Built-in layer short
names are defined by OpsWorks Stacks. For more information, see the Layer reference in the
OpsWorks User Guide.
- `"UseEbsOptimizedInstances"`: Whether to use Amazon EBS-optimized instances.
- `"VolumeConfigurations"`: A VolumeConfigurations object that describes the layer's Amazon
EBS volumes.
"""
function update_layer(LayerId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateLayer",
Dict{String,Any}("LayerId" => LayerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_layer(
LayerId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"UpdateLayer",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("LayerId" => LayerId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_my_user_profile()
update_my_user_profile(params::Dict{String,<:Any})
Updates a user's SSH public key. Required Permissions: To use this action, an IAM user
must have self-management enabled or an attached policy that explicitly grants permissions.
For more information about user permissions, see Managing User Permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SshPublicKey"`: The user's SSH public key.
"""
function update_my_user_profile(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateMyUserProfile"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_my_user_profile(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"UpdateMyUserProfile",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rds_db_instance(rds_db_instance_arn)
update_rds_db_instance(rds_db_instance_arn, params::Dict{String,<:Any})
Updates an Amazon RDS instance. Required Permissions: To use this action, an IAM user must
have a Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `rds_db_instance_arn`: The Amazon RDS instance's ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DbPassword"`: The database password.
- `"DbUser"`: The master user name.
"""
function update_rds_db_instance(
RdsDbInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"UpdateRdsDbInstance",
Dict{String,Any}("RdsDbInstanceArn" => RdsDbInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rds_db_instance(
RdsDbInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UpdateRdsDbInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RdsDbInstanceArn" => RdsDbInstanceArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_stack(stack_id)
update_stack(stack_id, params::Dict{String,<:Any})
Updates a specified stack. Required Permissions: To use this action, an IAM user must have
a Manage permissions level for the stack, or an attached policy that explicitly grants
permissions. For more information on user permissions, see Managing User Permissions.
# Arguments
- `stack_id`: The stack ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentVersion"`: The default OpsWorks Stacks agent version. You have the following
options: Auto-update - Set this parameter to LATEST. OpsWorks Stacks automatically
installs new agent versions on the stack's instances as soon as they are available. Fixed
version - Set this parameter to your preferred agent version. To update the agent version,
you must edit the stack configuration and specify a new version. OpsWorks Stacks installs
that version on the stack's instances. The default setting is LATEST. To specify an agent
version, you must use the complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call DescribeAgentVersions.
AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you
create or update an instance, which overrides the stack's default setting.
- `"Attributes"`: One or more user-defined key-value pairs to be added to the stack
attributes.
- `"ChefConfiguration"`: A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create
a New Stack.
- `"ConfigurationManager"`: The configuration manager. When you update a stack, we
recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or
11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is
currently 12.
- `"CustomCookbooksSource"`: Contains the information required to retrieve an app or
cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
- `"CustomJson"`: A string that contains user-defined, custom JSON. It can be used to
override the corresponding default stack configuration JSON values or to pass data to
recipes. The string should be in the following format: \"{\"key1\": \"value1\", \"key2\":
\"value2\",...}\" For more information about custom JSON, see Use Custom JSON to Modify
the Stack Configuration Attributes.
- `"DefaultAvailabilityZone"`: The stack's default Availability Zone, which must be in the
stack's region. For more information, see Regions and Endpoints. If you also specify a
value for DefaultSubnetId, the subnet must be in the same zone. For more information, see
CreateStack.
- `"DefaultInstanceProfileArn"`: The ARN of an IAM profile that is the default profile for
all of the stack's EC2 instances. For more information about IAM ARNs, see Using
Identifiers.
- `"DefaultOs"`: The stack's operating system, which must be set to one of the following:
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon
Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon
Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu
operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu
12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 A supported Windows
operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server
2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard,
or Microsoft Windows Server 2012 R2 with SQL Server Web. A custom AMI: Custom. You
specify the custom AMI you want to use when you create instances. For more information
about how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is
the stack's current operating system. Not all operating systems are supported with all
versions of Chef. For more information about supported operating systems, see OpsWorks
Stacks Operating Systems.
- `"DefaultRootDeviceType"`: The default root device type. This value is used by default
for all instances in the stack, but you can override it when you create an instance. For
more information, see Storage for the Root Device.
- `"DefaultSshKeyName"`: A default Amazon EC2 key-pair name. The default value is none. If
you specify a key-pair name, OpsWorks Stacks installs the public key on the instance and
you can use the private key with an SSH client to log in to the instance. For more
information, see Using SSH to Communicate with an Instance and Managing SSH Access. You
can override this setting by specifying a different key pair, or no key pair, when you
create an instance.
- `"DefaultSubnetId"`: The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId parameter. All instances are launched into this subnet unless
you specify otherwise when you create the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone. For information on default values
and when this parameter is required, see the VpcId parameter description.
- `"HostnameTheme"`: The stack's new host name theme, with spaces replaced by underscores.
The theme is used to generate host names for the stack's instances. By default,
HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to
the layer's short name. The other themes are: Baked_Goods Clouds Europe_Cities
Fruits Greek_Deities_and_Titans Legendary_creatures_from_Japan
Planets_and_Moons Roman_Deities Scottish_Islands US_Cities Wild_Cats To
obtain a generated host name, call GetHostNameSuggestion, which returns a host name based
on the current theme.
- `"Name"`: The stack's new name. Stack names can be a maximum of 64 characters.
- `"ServiceRoleArn"`: Do not use this parameter. You cannot update a stack's service role.
- `"UseCustomCookbooks"`: Whether the stack uses custom cookbooks.
- `"UseOpsworksSecurityGroups"`: Whether to associate the OpsWorks Stacks built-in security
groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in
security groups, one for each layer, which are associated with layers by default.
UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of
using the built-in groups. UseOpsworksSecurityGroups has the following settings: True -
OpsWorks Stacks automatically associates the appropriate built-in security group with each
layer (default setting). You can associate additional security groups with a layer after
you create it, but you cannot delete the built-in security group. False - OpsWorks Stacks
does not associate built-in security groups with layers. You must create appropriate EC2
security groups and associate a security group with each layer that you create. However,
you can still manually associate a built-in security group with a layer on. Custom security
groups are required only for those layers that need custom settings. For more
information, see Create a New Stack.
"""
function update_stack(StackId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateStack",
Dict{String,Any}("StackId" => StackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_stack(
StackId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworks(
"UpdateStack",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("StackId" => StackId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_profile(iam_user_arn)
update_user_profile(iam_user_arn, params::Dict{String,<:Any})
Updates a specified user profile. Required Permissions: To use this action, an IAM user
must have an attached policy that explicitly grants permissions. For more information about
user permissions, see Managing User Permissions.
# Arguments
- `iam_user_arn`: The user IAM ARN. This can also be a federated user's ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowSelfManagement"`: Whether users can specify their own SSH public key through the
My Settings page. For more information, see Managing User Permissions.
- `"SshPublicKey"`: The user's new SSH public key.
- `"SshUsername"`: The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other punctuation marks, OpsWorks
Stacks removes them. For example, my.name will be changed to myname. If you do not specify
an SSH user name, OpsWorks Stacks generates one from the IAM user name.
"""
function update_user_profile(IamUserArn; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateUserProfile",
Dict{String,Any}("IamUserArn" => IamUserArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_profile(
IamUserArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UpdateUserProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IamUserArn" => IamUserArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_volume(volume_id)
update_volume(volume_id, params::Dict{String,<:Any})
Updates an Amazon EBS volume's name or mount point. For more information, see Resource
Management. Required Permissions: To use this action, an IAM user must have a Manage
permissions level for the stack, or an attached policy that explicitly grants permissions.
For more information on user permissions, see Managing User Permissions.
# Arguments
- `volume_id`: The volume ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MountPoint"`: The new mount point.
- `"Name"`: The new name. Volume names can be a maximum of 128 characters.
"""
function update_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworks(
"UpdateVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworks(
"UpdateVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 45347 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: opsworkscm
using AWS.Compat
using AWS.UUIDs
"""
associate_node(engine_attributes, node_name, server_name)
associate_node(engine_attributes, node_name, server_name, params::Dict{String,<:Any})
Associates a new node with the server. For more information about how to disassociate a
node, see DisassociateNode. On a Chef server: This command is an alternative to knife
bootstrap. Example (Chef): aws opsworks-cm associate-node --server-name MyServer
--node-name MyManagedNode --engine-attributes \"Name=CHEF_ORGANIZATION,Value=default\"
\"Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem\" On a Puppet server, this command is an
alternative to the puppet cert sign command that signs a Puppet node CSR. Example
(Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode
--engine-attributes \"Name=PUPPET_NODE_CSR,Value=csr-pem\" A node can can only be
associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is
thrown. A ResourceNotFoundException is thrown when the server does not exist. A
ValidationException is raised when parameters of the request are not valid. The
AssociateNode API call can be integrated into Auto Scaling configurations, AWS
Cloudformation templates, or the user data of a server's instance.
# Arguments
- `engine_attributes`: Engine attributes used for associating the node. Attributes
accepted in a AssociateNode request for Chef CHEF_ORGANIZATION: The Chef organization
with which the node is associated. By default only one organization named default can
exist. CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the
chef-client agent to access the Chef API. Attributes accepted in a AssociateNode
request for Puppet PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR)
that is created by the node.
- `node_name`: The name of the node.
- `server_name`: The name of the server with which to associate the node.
"""
function associate_node(
EngineAttributes,
NodeName,
ServerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"AssociateNode",
Dict{String,Any}(
"EngineAttributes" => EngineAttributes,
"NodeName" => NodeName,
"ServerName" => ServerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_node(
EngineAttributes,
NodeName,
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"AssociateNode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EngineAttributes" => EngineAttributes,
"NodeName" => NodeName,
"ServerName" => ServerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_backup(server_name)
create_backup(server_name, params::Dict{String,<:Any})
Creates an application-level backup of a server. While the server is in the BACKING_UP
state, the server cannot be changed, and no additional backup can be created. Backups can
be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can
create a maximum of 50 manual backups. This operation is asynchronous. A
LimitExceededException is thrown when the maximum number of manual backups is reached. An
InvalidStateException is thrown when the server is not in any of the following states:
RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is
not found. A ValidationException is thrown when parameters of the request are not valid.
# Arguments
- `server_name`: The name of the server that you want to back up.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A user-defined description of the backup.
- `"Tags"`: A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM
server backup. The key cannot be empty. The key can be a maximum of 127 characters, and
can contain only Unicode letters, numbers, or separators, or the following special
characters: + - = . _ : / The value can be a maximum 255 characters, and contain only
Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value. A maximum
of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
"""
function create_backup(ServerName; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"CreateBackup",
Dict{String,Any}("ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_backup(
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"CreateBackup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerName" => ServerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_server(engine, instance_profile_arn, instance_type, server_name, service_role_arn)
create_server(engine, instance_profile_arn, instance_type, server_name, service_role_arn, params::Dict{String,<:Any})
Creates and immedately starts a new server. The server is ready to use when it is in the
HEALTHY state. By default, you can create a maximum of 10 servers. This operation is
asynchronous. A LimitExceededException is thrown when you have created the maximum number
of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same
name already exists in the account. A ResourceNotFoundException is thrown when you specify
a backup ID that is not valid or is for a backup that does not exist. A ValidationException
is thrown when parameters of the request are not valid. If you do not specify a security
group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.
Chef Automate: The default security group opens the Chef server to the world on TCP port
443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the
world on TCP port 22. Puppet Enterprise: The default security group opens TCP ports 22,
443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH
access. SSH is also open to the world on TCP port 22. By default, your server is
accessible from any IP address. We recommend that you update your security group rules to
allow access from known IP addresses and address ranges only. To edit security group rules,
open Security Groups in the navigation pane of the EC2 management console. To specify your
own domain for a server, and provide your own self-signed or CA-signed certificate and
private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.
# Arguments
- `engine`: The configuration management engine to use. Valid values include ChefAutomate
and Puppet.
- `instance_profile_arn`: The ARN of the instance profile that your Amazon EC2 instances
use. Although the AWS OpsWorks console typically creates the instance profile for you, if
you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation
template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.ya
ml. This template creates a CloudFormation stack that includes the instance profile you
need.
- `instance_type`: The Amazon EC2 instance type to use. For example, m5.large.
- `server_name`: The name of the server. The server name must be unique within your AWS
account, within each region. Server names must start with a letter; then letters, numbers,
or hyphens (-) are allowed, up to a maximum of 40 characters.
- `service_role_arn`: The service role that the AWS OpsWorks CM service backend uses to
work with your account. Although the AWS OpsWorks management console typically creates the
service role for you, if you are using the AWS CLI or API commands, run the
service-role-creation.yaml AWS CloudFormation template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.ya
ml. This template creates a CloudFormation stack that includes the service role and
instance profile that you need.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociatePublicIpAddress"`: Associate a public IP address with a server that you are
launching. Valid values are true or false. The default value is true.
- `"BackupId"`: If you specify this field, AWS OpsWorks CM creates the server by using the
backup represented by BackupId.
- `"BackupRetentionCount"`: The number of automated backups that you want to keep.
Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number
is exceeded. The default value is 1.
- `"CustomCertificate"`: A PEM-formatted HTTPS certificate. The value can be be a single,
self-signed certificate, or a certificate chain. If you specify a custom certificate, you
must also specify values for CustomDomain and CustomPrivateKey. The following are
requirements for the CustomCertificate value: You can provide either a self-signed,
custom certificate, or the full certificate chain. The certificate must be a valid X509
certificate, or a certificate chain in PEM format. The certificate must be valid at the
time of upload. A certificate can't be used before its validity period begins (the
certificate's NotBefore date), or after it expires (the certificate's NotAfter date). The
certificate’s common name or subject alternative names (SANs), if present, must match the
value of CustomDomain. The certificate must match the value of CustomPrivateKey.
- `"CustomDomain"`: An optional public endpoint of a server, such as
https://aws.my-company.com. To access the server, create a CNAME DNS record in your
preferred DNS service that points the custom domain to the endpoint that is generated when
the server is created (the value of the CreateServer Endpoint attribute). You cannot access
the server by using the generated Endpoint value if the server is using a custom domain. If
you specify a custom domain, you must also specify values for CustomCertificate and
CustomPrivateKey.
- `"CustomPrivateKey"`: A private key in PEM format for connecting to the server by using
HTTPS. The private key must not be encrypted; it cannot be protected by a password or
passphrase. If you specify a custom private key, you must also specify values for
CustomDomain and CustomCertificate.
- `"DisableAutomatedBackup"`: Enable or disable scheduled backups. Valid values are true
or false. The default value is true.
- `"EngineAttributes"`: Optional engine attributes on a specified server. Attributes
accepted in a Chef createServer request: CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded
RSA public key. The corresponding private key is required to access the Chef API. When no
CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef
Automate web-based dashboard. The password length is a minimum of eight characters, and a
maximum of 32. The password can contain letters, numbers, and special characters
(!/@#%^&+=_). The password must contain at least one lower case letter, one upper case
letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set,
one is generated and returned in the response. Attributes accepted in a Puppet
createServer request: PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise
console, a password must use ASCII characters. PUPPET_R10K_REMOTE: The r10k remote is
the URL of your control repository (for example,
ssh://[email protected]:user/control-repo.git). Specifying an r10k remote opens TCP
port 8170. PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add
PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
- `"EngineModel"`: The engine model of the server. Valid values in this release include
Monolithic for Puppet and Single for Chef.
- `"EngineVersion"`: The major release version of the engine that you want to use. For a
Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, valid
values are 2019 or 2017.
- `"KeyPair"`: The Amazon EC2 key pair to set for the instance. This parameter is
optional; if desired, you may specify this parameter to connect to your instances by using
SSH.
- `"PreferredBackupWindow"`: The start time for a one-hour period during which AWS
OpsWorks CM backs up application-level data on your server if automated backups are
enabled. Valid values must be specified in one of the following formats: HH:MM for
daily backups DDD:HH:MM for weekly backups MM must be specified as 00. The specified
time is in coordinated universal time (UTC). The default value is a random, daily start
time. Example: 08:00, which represents a daily start time of 08:00 UTC. Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
- `"PreferredMaintenanceWindow"`: The start time for a one-hour period each week during
which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified
in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in
coordinated universal time (UTC). The default value is a random one-hour period on Tuesday,
Wednesday, or Friday. See TimeWindowDefinition for more information. Example: Mon:08:00,
which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
- `"SecurityGroupIds"`: A list of security group IDs to attach to the Amazon EC2 instance.
If you add this parameter, the specified security groups must be within the VPC that is
specified by SubnetIds. If you do not specify this parameter, AWS OpsWorks CM creates one
new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
- `"SubnetIds"`: The IDs of subnets in which to launch the server EC2 instance. Amazon
EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC
must have \"Auto Assign Public IP\" enabled. EC2-VPC customers: This field is optional.
If you do not specify subnet IDs, your EC2 instances are created in a default subnet that
is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign
Public IP\" enabled. For more information about supported Amazon EC2 platforms, see
Supported Platforms.
- `"Tags"`: A map that contains tag keys and tag values to attach to an AWS OpsWorks for
Chef Automate or AWS OpsWorks for Puppet Enterprise server. The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers,
or separators, or the following special characters: + - = . _ : / @ The value can be a
maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @ Leading and trailing white spaces are
trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for any
AWS OpsWorks-CM server.
"""
function create_server(
Engine,
InstanceProfileArn,
InstanceType,
ServerName,
ServiceRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"CreateServer",
Dict{String,Any}(
"Engine" => Engine,
"InstanceProfileArn" => InstanceProfileArn,
"InstanceType" => InstanceType,
"ServerName" => ServerName,
"ServiceRoleArn" => ServiceRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_server(
Engine,
InstanceProfileArn,
InstanceType,
ServerName,
ServiceRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"CreateServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Engine" => Engine,
"InstanceProfileArn" => InstanceProfileArn,
"InstanceType" => InstanceType,
"ServerName" => ServerName,
"ServiceRoleArn" => ServiceRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_backup(backup_id)
delete_backup(backup_id, params::Dict{String,<:Any})
Deletes a backup. You can delete both manual and automated backups. This operation is
asynchronous. An InvalidStateException is thrown when a backup deletion is already in
progress. A ResourceNotFoundException is thrown when the backup does not exist. A
ValidationException is thrown when parameters of the request are not valid.
# Arguments
- `backup_id`: The ID of the backup to delete. Run the DescribeBackups command to get a
list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.
"""
function delete_backup(BackupId; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"DeleteBackup",
Dict{String,Any}("BackupId" => BackupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_backup(
BackupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"DeleteBackup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BackupId" => BackupId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_server(server_name)
delete_server(server_name, params::Dict{String,<:Any})
Deletes the server and the underlying AWS CloudFormation stacks (including the server's
EC2 instance). When you run this command, the server state is updated to DELETING. After
the server is deleted, it is no longer returned by DescribeServer requests. If the AWS
CloudFormation stack cannot be deleted, the server cannot be deleted. This operation is
asynchronous. An InvalidStateException is thrown when a server deletion is already in
progress. A ResourceNotFoundException is thrown when the server does not exist. A
ValidationException is raised when parameters of the request are not valid.
# Arguments
- `server_name`: The ID of the server to delete.
"""
function delete_server(ServerName; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"DeleteServer",
Dict{String,Any}("ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_server(
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"DeleteServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerName" => ServerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_attributes()
describe_account_attributes(params::Dict{String,<:Any})
Describes your OpsWorks-CM account attributes. This operation is synchronous.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"DescribeAccountAttributes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_account_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_backups()
describe_backups(params::Dict{String,<:Any})
Describes backups. The results are ordered by time, with newest backups first. If you do
not specify a BackupId or ServerName, the command returns all backups. This operation is
synchronous. A ResourceNotFoundException is thrown when the backup does not exist. A
ValidationException is raised when parameters of the request are not valid.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BackupId"`: Describes a single backup.
- `"MaxResults"`: This is not currently implemented for DescribeBackups requests.
- `"NextToken"`: This is not currently implemented for DescribeBackups requests.
- `"ServerName"`: Returns backups for the server with the specified ServerName.
"""
function describe_backups(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"DescribeBackups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_backups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"DescribeBackups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_events(server_name)
describe_events(server_name, params::Dict{String,<:Any})
Describes events for a specified server. Results are ordered by time, with newest events
first. This operation is synchronous. A ResourceNotFoundException is thrown when the
server does not exist. A ValidationException is raised when parameters of the request are
not valid.
# Arguments
- `server_name`: The name of the server for which you want to view events.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the number of available
results exceeds this maximum, the response includes a NextToken value that you can assign
to the NextToken request parameter to get the next set of results.
- `"NextToken"`: NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run at least one more
request to get remaining items. To get remaining results, call DescribeEvents again, and
assign the token from the previous results as the value of the nextToken parameter. If
there are no more results, the response object's nextToken parameter value is null. Setting
a nextToken value that was not returned in your previous results causes an
InvalidNextTokenException to occur.
"""
function describe_events(ServerName; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"DescribeEvents",
Dict{String,Any}("ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_events(
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"DescribeEvents",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerName" => ServerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_node_association_status(node_association_status_token, server_name)
describe_node_association_status(node_association_status_token, server_name, params::Dict{String,<:Any})
Returns the current status of an existing association or disassociation request. A
ResourceNotFoundException is thrown when no recent association or disassociation request
with the specified token is found, or when the server does not exist. A ValidationException
is raised when parameters of the request are not valid.
# Arguments
- `node_association_status_token`: The token returned in either the AssociateNodeResponse
or the DisassociateNodeResponse.
- `server_name`: The name of the server from which to disassociate the node.
"""
function describe_node_association_status(
NodeAssociationStatusToken,
ServerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"DescribeNodeAssociationStatus",
Dict{String,Any}(
"NodeAssociationStatusToken" => NodeAssociationStatusToken,
"ServerName" => ServerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_node_association_status(
NodeAssociationStatusToken,
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"DescribeNodeAssociationStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NodeAssociationStatusToken" => NodeAssociationStatusToken,
"ServerName" => ServerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_servers()
describe_servers(params::Dict{String,<:Any})
Lists all configuration management servers that are identified with your account. Only the
stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other
services. This operation is synchronous. A ResourceNotFoundException is thrown when the
server does not exist. A ValidationException is raised when parameters of the request are
not valid.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: This is not currently implemented for DescribeServers requests.
- `"NextToken"`: This is not currently implemented for DescribeServers requests.
- `"ServerName"`: Describes the server with the specified ServerName.
"""
function describe_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"DescribeServers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"DescribeServers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
disassociate_node(node_name, server_name)
disassociate_node(node_name, server_name, params::Dict{String,<:Any})
Disassociates a node from an AWS OpsWorks CM server, and removes the node from the
server's managed nodes. After a node is disassociated, the node key pair is no longer valid
for accessing the configuration manager's API. For more information about how to associate
a node, see AssociateNode. A node can can only be disassociated from a server that is in a
HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException
is thrown when the server does not exist. A ValidationException is raised when parameters
of the request are not valid.
# Arguments
- `node_name`: The name of the client node.
- `server_name`: The name of the server from which to disassociate the node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EngineAttributes"`: Engine attributes that are used for disassociating the node. No
attributes are required for Puppet. Attributes required in a DisassociateNode request for
Chef CHEF_ORGANIZATION: The Chef organization with which the node was associated. By
default only one organization named default can exist.
"""
function disassociate_node(
NodeName, ServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"DisassociateNode",
Dict{String,Any}("NodeName" => NodeName, "ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_node(
NodeName,
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"DisassociateNode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NodeName" => NodeName, "ServerName" => ServerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_server_engine_attribute(export_attribute_name, server_name)
export_server_engine_attribute(export_attribute_name, server_name, params::Dict{String,<:Any})
Exports a specified server engine attribute as a base64-encoded string. For example, you
can export user data that you can use in EC2 to associate nodes with a server. This
operation is synchronous. A ValidationException is raised when parameters of the request
are not valid. A ResourceNotFoundException is thrown when the server does not exist. An
InvalidStateException is thrown when the server is in any of the following states:
CREATING, TERMINATED, FAILED or DELETING.
# Arguments
- `export_attribute_name`: The name of the export attribute. Currently, the supported
export attribute is Userdata. This exports a user data script that includes parameters and
values provided in the InputAttributes list.
- `server_name`: The name of the server from which you are exporting the attribute.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InputAttributes"`: The list of engine attributes. The list type is EngineAttribute. An
EngineAttribute list item is a pair that includes an attribute name and its value. For the
Userdata ExportAttributeName, the following are supported engine attribute names.
RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet,
this parameter is ignored. OrganizationName In Chef, an organization name. AWS OpsWorks
for Chef Automate always creates the organization default. In Puppet, this parameter is
ignored. NodeEnvironment In Chef, a node environment (for example, development, staging,
or one-box). In Puppet, this parameter is ignored. NodeClientVersion In Chef, the
version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this
attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet,
this parameter is ignored.
"""
function export_server_engine_attribute(
ExportAttributeName, ServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"ExportServerEngineAttribute",
Dict{String,Any}(
"ExportAttributeName" => ExportAttributeName, "ServerName" => ServerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_server_engine_attribute(
ExportAttributeName,
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"ExportServerEngineAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExportAttributeName" => ExportAttributeName, "ServerName" => ServerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or
AWS OpsWorks for Puppet Enterprise servers or backups.
# Arguments
- `resource_arn`: The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or
AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For
example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1
a2bEXAMPLE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the number of available
results exceeds this maximum, the response includes a NextToken value that you can assign
to the NextToken request parameter to get the next set of results.
- `"NextToken"`: NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run at least one more
request to get remaining items. To get remaining results, call ListTagsForResource again,
and assign the token from the previous results as the value of the nextToken parameter. If
there are no more results, the response object's nextToken parameter value is null. Setting
a nextToken value that was not returned in your previous results causes an
InvalidNextTokenException to occur.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_server(backup_id, server_name)
restore_server(backup_id, server_name, params::Dict{String,<:Any})
Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY,
or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and
a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so
configuration management of the server's client devices (nodes) should continue to work.
Restoring from a backup is performed by creating a new EC2 instance. If restoration is
successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to
the new instance. After restoration is finished, the old EC2 instance is maintained in a
Running or Stopped state, but is eventually terminated. This operation is asynchronous.
An InvalidStateException is thrown when the server is not in a valid state. A
ResourceNotFoundException is thrown when the server does not exist. A ValidationException
is raised when parameters of the request are not valid.
# Arguments
- `backup_id`: The ID of the backup that you want to use to restore a server.
- `server_name`: The name of the server that you want to restore.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceType"`: The type of instance to restore. Valid values must be specified in the
following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large,
r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the
instance type from the specified backup.
- `"KeyPair"`: The name of the key pair to set on the new EC2 instance. This can be
helpful if the administrator no longer has the SSH key.
"""
function restore_server(
BackupId, ServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"RestoreServer",
Dict{String,Any}("BackupId" => BackupId, "ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_server(
BackupId,
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"RestoreServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BackupId" => BackupId, "ServerName" => ServerName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_maintenance(server_name)
start_maintenance(server_name, params::Dict{String,<:Any})
Manually starts server maintenance. This command can be useful if an earlier maintenance
attempt failed, and the underlying cause of maintenance failure has been resolved. The
server is in an UNDER_MAINTENANCE state while maintenance is in progress. Maintenance can
only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an
InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does
not exist. A ValidationException is raised when parameters of the request are not valid.
# Arguments
- `server_name`: The name of the server on which to run maintenance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EngineAttributes"`: Engine attributes that are specific to the server on which you want
to run maintenance. Attributes accepted in a StartMaintenance request for Chef
CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2,
add this engine attribute to a StartMaintenance request and set the value to true to
upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks
for Chef Automate Server to Chef Automate 2.
"""
function start_maintenance(ServerName; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"StartMaintenance",
Dict{String,Any}("ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_maintenance(
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"StartMaintenance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerName" => ServerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise
server, or to server backups.
# Arguments
- `resource_arn`: The Amazon Resource Number (ARN) of a resource to which you want to apply
tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1
a2bEXAMPLE.
- `tags`: A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers
or backups. The key cannot be empty. The key can be a maximum of 127 characters, and
can contain only Unicode letters, numbers, or separators, or the following special
characters: + - = . _ : / The value can be a maximum 255 characters, and contain only
Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value. A maximum
of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes specified tags from an AWS OpsWorks-CM server or backup.
# Arguments
- `resource_arn`: The Amazon Resource Number (ARN) of a resource from which you want to
remove tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1
a2bEXAMPLE.
- `tag_keys`: The keys of tags that you want to remove.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_server(server_name)
update_server(server_name, params::Dict{String,<:Any})
Updates settings for a server. This operation is synchronous.
# Arguments
- `server_name`: The name of the server to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BackupRetentionCount"`: Sets the number of automated backups that you want to keep.
- `"DisableAutomatedBackup"`: Setting DisableAutomatedBackup to true disables automated or
scheduled backups. Automated backups are enabled by default.
- `"PreferredBackupWindow"`:
- `"PreferredMaintenanceWindow"`:
"""
function update_server(ServerName; aws_config::AbstractAWSConfig=global_aws_config())
return opsworkscm(
"UpdateServer",
Dict{String,Any}("ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_server(
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"UpdateServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerName" => ServerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_server_engine_attributes(attribute_name, server_name)
update_server_engine_attributes(attribute_name, server_name, params::Dict{String,<:Any})
Updates engine-specific attributes on a specified server. The server enters the MODIFYING
state when this operation is in progress. Only one update can occur at a time. You can use
this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's
admin password (PUPPET_ADMIN_PASSWORD). This operation is asynchronous. This operation
can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an
InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does
not exist. A ValidationException is raised when parameters of the request are not valid.
# Arguments
- `attribute_name`: The name of the engine attribute to update.
- `server_name`: The name of the server to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeValue"`: The value to set for the attribute.
"""
function update_server_engine_attributes(
AttributeName, ServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return opsworkscm(
"UpdateServerEngineAttributes",
Dict{String,Any}("AttributeName" => AttributeName, "ServerName" => ServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_server_engine_attributes(
AttributeName,
ServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return opsworkscm(
"UpdateServerEngineAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeName" => AttributeName, "ServerName" => ServerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 139876 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: organizations
using AWS.Compat
using AWS.UUIDs
"""
accept_handshake(handshake_id)
accept_handshake(handshake_id, params::Dict{String,<:Any})
Sends a response to the originator of a handshake agreeing to the action proposed by the
handshake request. You can only call this operation by the following principals when they
also have the relevant IAM permissions: Invitation to join or Approve all features
request handshakes: only a principal from the member account. The user who calls the API
for an invitation to join must have the organizations:AcceptHandshake permission. If you
enabled all features in the organization, the user must also have the
iam:CreateServiceLinkedRole permission so that Organizations can create the required
service-linked role named AWSServiceRoleForOrganizations. For more information, see
Organizations and service-linked roles in the Organizations User Guide. Enable all
features final confirmation handshake: only a principal from the management account. For
more information about invitations, see Inviting an Amazon Web Services account to join
your organization in the Organizations User Guide. For more information about requests to
enable all features in the organization, see Enabling all features in your organization in
the Organizations User Guide. After you accept a handshake, it continues to appear in the
results of relevant APIs for only 30 days. After that, it's deleted.
# Arguments
- `handshake_id`: The unique identifier (ID) of the handshake that you want to accept. The
regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase
letters or digits.
"""
function accept_handshake(HandshakeId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"AcceptHandshake",
Dict{String,Any}("HandshakeId" => HandshakeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_handshake(
HandshakeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"AcceptHandshake",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HandshakeId" => HandshakeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_policy(policy_id, target_id)
attach_policy(policy_id, target_id, params::Dict{String,<:Any})
Attaches a policy to a root, an organizational unit (OU), or an individual account. How the
policy affects accounts depends on the type of policy. Refer to the Organizations User
Guide for information about each policy type: AISERVICES_OPT_OUT_POLICY
BACKUP_POLICY SERVICE_CONTROL_POLICY TAG_POLICY This operation can be called
only from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Arguments
- `policy_id`: The unique identifier (ID) of the policy that you want to attach to the
target. You can get the ID for the policy by calling the ListPolicies operation. The regex
pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or
uppercase letters, digits, or the underscore character (_).
- `target_id`: The unique identifier (ID) of the root, OU, or account that you want to
attach the policy to. You can get the ID by calling the ListRoots,
ListOrganizationalUnitsForParent, or ListAccounts operations. The regex pattern for a
target ID string requires one of the following: Root - A string that begins with \"r-\"
followed by from 4 to 32 lowercase letters or digits. Account - A string that consists
of exactly 12 digits. Organizational unit (OU) - A string that begins with \"ou-\"
followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is
in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase
letters or digits.
"""
function attach_policy(
PolicyId, TargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"AttachPolicy",
Dict{String,Any}("PolicyId" => PolicyId, "TargetId" => TargetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_policy(
PolicyId,
TargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"AttachPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyId" => PolicyId, "TargetId" => TargetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_handshake(handshake_id)
cancel_handshake(handshake_id, params::Dict{String,<:Any})
Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED. This
operation can be called only from the account that originated the handshake. The recipient
of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake
is canceled, the recipient can no longer respond to that handshake. After you cancel a
handshake, it continues to appear in the results of relevant APIs for only 30 days. After
that, it's deleted.
# Arguments
- `handshake_id`: The unique identifier (ID) of the handshake that you want to cancel. You
can get the ID from the ListHandshakesForOrganization operation. The regex pattern for
handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
"""
function cancel_handshake(HandshakeId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"CancelHandshake",
Dict{String,Any}("HandshakeId" => HandshakeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_handshake(
HandshakeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"CancelHandshake",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HandshakeId" => HandshakeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
close_account(account_id)
close_account(account_id, params::Dict{String,<:Any})
Closes an Amazon Web Services member account within an organization. You can close an
account when all features are enabled . You can't close the management account with this
API. This is an asynchronous request that Amazon Web Services performs in the background.
Because CloseAccount operates asynchronously, it can return a successful completion message
even though account closure might still be in progress. You need to wait a few minutes
before the account is fully closed. To check the status of the request, do one of the
following: Use the AccountId that you sent in the CloseAccount request to provide as a
parameter to the DescribeAccount operation. While the close account request is in
progress, Account status will indicate PENDING_CLOSURE. When the close account request
completes, the status will change to SUSPENDED. Check the CloudTrail log for the
CloseAccountResult event that gets published after the account closes successfully. For
information on using CloudTrail with Organizations, see Logging and monitoring in
Organizations in the Organizations User Guide. You can close only 10% of member
accounts, between 10 and 1000, within a rolling 30 day period. This quota is not bound by a
calendar month, but starts when you close an account. After you reach this limit, you can
close additional accounts. For more information, see Closing a member account in your
organization and Quotas for Organizationsin the Organizations User Guide. To reinstate a
closed account, contact Amazon Web Services Support within the 90-day grace period while
the account is in SUSPENDED status. If the Amazon Web Services account you attempt to
close is linked to an Amazon Web Services GovCloud (US) account, the CloseAccount request
will close both accounts. To learn important pre-closure details, see Closing an Amazon
Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide.
# Arguments
- `account_id`: Retrieves the Amazon Web Services account Id for the current CloseAccount
API request.
"""
function close_account(AccountId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"CloseAccount",
Dict{String,Any}("AccountId" => AccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function close_account(
AccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"CloseAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountId" => AccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_account(account_name, email)
create_account(account_name, email, params::Dict{String,<:Any})
Creates an Amazon Web Services account that is automatically a member of the organization
whose credentials made the request. This is an asynchronous request that Amazon Web
Services performs in the background. Because CreateAccount operates asynchronously, it can
return a successful completion message even though account initialization might still be in
progress. You might need to wait a few minutes before you can successfully access the
account. To check the status of the request, do one of the following: Use the Id value of
the CreateAccountStatus response element from this operation to provide as a parameter to
the DescribeCreateAccountStatus operation. Check the CloudTrail log for the
CreateAccountResult event. For information on using CloudTrail with Organizations, see
Logging and monitoring in Organizations in the Organizations User Guide. The user who
calls the API to create an account must have the organizations:CreateAccount permission. If
you enabled all features in the organization, Organizations creates the required
service-linked role named AWSServiceRoleForOrganizations. For more information, see
Organizations and service-linked roles in the Organizations User Guide. If the request
includes tags, then the requester must have the organizations:TagResource permission.
Organizations preconfigures the new member account with a role (named
OrganizationAccountAccessRole by default) that grants users in the management account
administrator permissions in the new member account. Principals in the management account
can assume the role. Organizations clones the company name and address information for the
new account from the organization's management account. This operation can be called only
from the organization's management account. For more information about creating accounts,
see Creating a member account in your organization in the Organizations User Guide. When
you create an account in an organization using the Organizations console, API, or CLI
commands, the information required for the account to operate as a standalone account, such
as a payment method and signing the end user license agreement (EULA) is not automatically
collected. If you must remove an account from your organization later, you can do so only
after you provide the missing information. For more information, see Considerations before
removing an account from an organization in the Organizations User Guide. If you get an
exception that indicates that you exceeded your account limits for the organization,
contact Amazon Web Services Support. If you get an exception that indicates that the
operation failed because your organization is still initializing, wait one hour and then
try again. If the error persists, contact Amazon Web Services Support. Using
CreateAccount to create multiple temporary accounts isn't recommended. You can only close
an account from the Billing and Cost Management console, and you must be signed in as the
root user. For information on the requirements and process for closing an account, see
Closing a member account in your organization in the Organizations User Guide. When you
create a member account with this operation, you can choose whether to create the account
with the IAM User and Role Access to Billing Information switch enabled. If you enable it,
IAM users and roles that have appropriate permissions can view billing information for the
account. If you disable it, only the account root user can access billing information. For
information about how to disable this switch for an account, see Granting access to your
billing information and tools.
# Arguments
- `account_name`: The friendly name of the member account.
- `email`: The email address of the owner to assign to the new member account. This email
address must not already be associated with another Amazon Web Services account. You must
use a valid email address to complete account creation. The rules for a valid email
address: The address must be a minimum of 6 and a maximum of 64 characters long. All
characters must be 7-bit ASCII characters. There must be one and only one @ symbol, which
separates the local name from the domain name. The local name can't contain any of the
following characters: whitespace, \" ' ( ) < > [ ] : ; , | % & The local name
can't begin with a dot (.) The domain name can consist of only the characters
[a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name can't begin or end with a
hyphen (-) or dot (.) The domain name must contain at least one dot You can't access
the root user of the account or remove an account that was created with an invalid email
address.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IamUserAccessToBilling"`: If set to ALLOW, the new account enables IAM users to access
account billing information if they have the required permissions. If set to DENY, only the
root user of the new account can access account billing information. For more information,
see About IAM access to the Billing and Cost Management console in the Amazon Web Services
Billing and Cost Management User Guide. If you don't specify this parameter, the value
defaults to ALLOW, and IAM users and roles with the required permissions can access billing
information for the new account.
- `"RoleName"`: The name of an IAM role that Organizations automatically preconfigures in
the new member account. This role trusts the management account, allowing users in the
management account to assume the role, as permitted by the management account
administrator. The role has administrator permissions in the new member account. If you
don't specify this parameter, the role name defaults to OrganizationAccountAccessRole. For
more information about how to use this role to access the member account, see the following
links: Creating the OrganizationAccountAccessRole in an invited member account in the
Organizations User Guide Steps 2 and 3 in IAM Tutorial: Delegate access across Amazon
Web Services accounts using IAM roles in the IAM User Guide The regex pattern that is
used to validate this parameter. The pattern can include uppercase letters, lowercase
letters, digits with no spaces, and any of the following characters: =,.@-
- `"Tags"`: A list of tags that you want to attach to the newly created account. For each
tag in the list, you must specify both a tag key and a value. You can set the value to an
empty string, but you can't set it to null. For more information about tagging, see Tagging
Organizations resources in the Organizations User Guide. If any one of the tags is not
valid or if you exceed the maximum allowed number of tags for an account, then the entire
request fails and the account is not created.
"""
function create_account(
AccountName, Email; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"CreateAccount",
Dict{String,Any}("AccountName" => AccountName, "Email" => Email);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_account(
AccountName,
Email,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"CreateAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountName" => AccountName, "Email" => Email),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_gov_cloud_account(account_name, email)
create_gov_cloud_account(account_name, email, params::Dict{String,<:Any})
This action is available if all of the following are true: You're authorized to create
accounts in the Amazon Web Services GovCloud (US) Region. For more information on the
Amazon Web Services GovCloud (US) Region, see the Amazon Web Services GovCloud User Guide.
You already have an account in the Amazon Web Services GovCloud (US) Region that is
paired with a management account of an organization in the commercial Region. You call
this action from the management account of your organization in the commercial Region.
You have the organizations:CreateGovCloudAccount permission. Organizations automatically
creates the required service-linked role named AWSServiceRoleForOrganizations. For more
information, see Organizations and service-linked roles in the Organizations User Guide.
Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US)
accounts, but you should also do the following: Verify that CloudTrail is enabled to
store logs. Create an Amazon S3 bucket for CloudTrail log storage. For more information,
see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide. If
the request includes tags, then the requester must have the organizations:TagResource
permission. The tags are attached to the commercial account associated with the GovCloud
account, rather than the GovCloud account itself. To add tags to the GovCloud account, call
the TagResource operation in the GovCloud Region after the new GovCloud account exists. You
call this action from the management account of your organization in the commercial Region
to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US)
Region. After the account is created, the management account of an organization in the
Amazon Web Services GovCloud (US) Region can invite it to that organization. For more
information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to
join an organization, see Organizations in the Amazon Web Services GovCloud User Guide.
Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services performs
in the background. Because CreateGovCloudAccount operates asynchronously, it can return a
successful completion message even though account initialization might still be in
progress. You might need to wait a few minutes before you can successfully access the
account. To check the status of the request, do one of the following: Use the OperationId
response element from this operation to provide as a parameter to the
DescribeCreateAccountStatus operation. Check the CloudTrail log for the
CreateAccountResult event. For information on using CloudTrail with Organizations, see
Logging and monitoring in Organizations in the Organizations User Guide. When you call
the CreateGovCloudAccount action, you create two accounts: a standalone account in the
Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region
for billing and support purposes. The account in the commercial Region is automatically a
member of the organization whose credentials made the request. Both accounts are associated
with the same email address. A role is created in the new account in the commercial Region
that allows the management account in the organization in the commercial Region to assume
it. An Amazon Web Services GovCloud (US) account is then created and associated with the
commercial account that you just created. A role is also created in the new Amazon Web
Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US)
account that is associated with the management account of the commercial organization. For
more information and to view a diagram that explains how account access works, see
Organizations in the Amazon Web Services GovCloud User Guide. For more information about
creating accounts, see Creating a member account in your organization in the Organizations
User Guide. When you create an account in an organization using the Organizations
console, API, or CLI commands, the information required for the account to operate as a
standalone account is not automatically collected. This includes a payment method and
signing the end user license agreement (EULA). If you must remove an account from your
organization later, you can do so only after you provide the missing information. For more
information, see Considerations before removing an account from an organization in the
Organizations User Guide. If you get an exception that indicates that you exceeded your
account limits for the organization, contact Amazon Web Services Support. If you get an
exception that indicates that the operation failed because your organization is still
initializing, wait one hour and then try again. If the error persists, contact Amazon Web
Services Support. Using CreateGovCloudAccount to create multiple temporary accounts isn't
recommended. You can only close an account from the Amazon Web Services Billing and Cost
Management console, and you must be signed in as the root user. For information on the
requirements and process for closing an account, see Closing a member account in your
organization in the Organizations User Guide. When you create a member account with
this operation, you can choose whether to create the account with the IAM User and Role
Access to Billing Information switch enabled. If you enable it, IAM users and roles that
have appropriate permissions can view billing information for the account. If you disable
it, only the account root user can access billing information. For information about how to
disable this switch for an account, see Granting access to your billing information and
tools.
# Arguments
- `account_name`: The friendly name of the member account. The account name can consist of
only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters
with a dash (–).
- `email`: Specifies the email address of the owner to assign to the new member account in
the commercial Region. This email address must not already be associated with another
Amazon Web Services account. You must use a valid email address to complete account
creation. The rules for a valid email address: The address must be a minimum of 6 and a
maximum of 64 characters long. All characters must be 7-bit ASCII characters. There
must be one and only one @ symbol, which separates the local name from the domain name.
The local name can't contain any of the following characters: whitespace, \" ' ( ) <
> [ ] : ; , | % & The local name can't begin with a dot (.) The domain name can
consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name
can't begin or end with a hyphen (-) or dot (.) The domain name must contain at least one
dot You can't access the root user of the account or remove an account that was created
with an invalid email address. Like all request parameters for CreateGovCloudAccount, the
request for the email address for the Amazon Web Services GovCloud (US) account originates
from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IamUserAccessToBilling"`: If set to ALLOW, the new linked account in the commercial
Region enables IAM users to access account billing information if they have the required
permissions. If set to DENY, only the root user of the new account can access account
billing information. For more information, see About IAM access to the Billing and Cost
Management console in the Amazon Web Services Billing and Cost Management User Guide. If
you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with
the required permissions can access billing information for the new account.
- `"RoleName"`: (Optional) The name of an IAM role that Organizations automatically
preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US)
Region and in the commercial Region. This role trusts the management account, allowing
users in the management account to assume the role, as permitted by the management account
administrator. The role has administrator permissions in the new member account. If you
don't specify this parameter, the role name defaults to OrganizationAccountAccessRole. For
more information about how to use this role to access the member account, see the following
links: Creating the OrganizationAccountAccessRole in an invited member account in the
Organizations User Guide Steps 2 and 3 in IAM Tutorial: Delegate access across Amazon
Web Services accounts using IAM roles in the IAM User Guide The regex pattern that is
used to validate this parameter. The pattern can include uppercase letters, lowercase
letters, digits with no spaces, and any of the following characters: =,.@-
- `"Tags"`: A list of tags that you want to attach to the newly created account. These tags
are attached to the commercial account associated with the GovCloud account, and not to the
GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource
operation in the GovCloud region after the new GovCloud account exists. For each tag in the
list, you must specify both a tag key and a value. You can set the value to an empty
string, but you can't set it to null. For more information about tagging, see Tagging
Organizations resources in the Organizations User Guide. If any one of the tags is not
valid or if you exceed the maximum allowed number of tags for an account, then the entire
request fails and the account is not created.
"""
function create_gov_cloud_account(
AccountName, Email; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"CreateGovCloudAccount",
Dict{String,Any}("AccountName" => AccountName, "Email" => Email);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_gov_cloud_account(
AccountName,
Email,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"CreateGovCloudAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountName" => AccountName, "Email" => Email),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_organization()
create_organization(params::Dict{String,<:Any})
Creates an Amazon Web Services organization. The account whose user is calling the
CreateOrganization operation automatically becomes the management account of the new
organization. This operation must be called using credentials from the account that is to
become the new organization's management account. The principal must also have the relevant
IAM permissions. By default (or if you set the FeatureSet parameter to ALL), the new
organization is created with all features enabled and service control policies
automatically enabled in the root. If you instead choose to create the organization
supporting only the consolidated billing features by setting the FeatureSet parameter to
CONSOLIDATED_BILLING, no policy types are enabled by default and you can't use organization
policies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureSet"`: Specifies the feature set supported by the new organization. Each feature
set supports different levels of functionality. CONSOLIDATED_BILLING: All member
accounts have their bills consolidated to and paid by the management account. For more
information, see Consolidated billing in the Organizations User Guide. The consolidated
billing feature subset isn't available for organizations in the Amazon Web Services
GovCloud (US) Region. ALL: In addition to all the features supported by the consolidated
billing feature set, the management account can also apply any policy type to any member
account in the organization. For more information, see All features in the Organizations
User Guide.
"""
function create_organization(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"CreateOrganization"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"CreateOrganization", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_organizational_unit(name, parent_id)
create_organizational_unit(name, parent_id, params::Dict{String,<:Any})
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for
accounts that enables you to organize your accounts to apply policies according to your
business requirements. The number of levels deep that you can nest OUs is dependent upon
the policy types enabled for that root. For service control policies, the limit is five.
For more information about OUs, see Managing organizational units (OUs) in the
Organizations User Guide. If the request includes tags, then the requester must have the
organizations:TagResource permission. This operation can be called only from the
organization's management account.
# Arguments
- `name`: The friendly name to assign to the new OU.
- `parent_id`: The unique identifier (ID) of the parent root or OU that you want to create
the new OU in. The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or
digits. Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4
to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is
followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tags that you want to attach to the newly created OU. For each tag in
the list, you must specify both a tag key and a value. You can set the value to an empty
string, but you can't set it to null. For more information about tagging, see Tagging
Organizations resources in the Organizations User Guide. If any one of the tags is not
valid or if you exceed the allowed number of tags for an OU, then the entire request fails
and the OU is not created.
"""
function create_organizational_unit(
Name, ParentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"CreateOrganizationalUnit",
Dict{String,Any}("Name" => Name, "ParentId" => ParentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_organizational_unit(
Name,
ParentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"CreateOrganizationalUnit",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Name" => Name, "ParentId" => ParentId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy(content, description, name, type)
create_policy(content, description, name, type, params::Dict{String,<:Any})
Creates a policy of a specified type that you can attach to a root, an organizational unit
(OU), or an individual Amazon Web Services account. For more information about policies and
their use, see Managing Organizations policies. If the request includes tags, then the
requester must have the organizations:TagResource permission. This operation can be called
only from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Arguments
- `content`: The policy text content to add to the new policy. The text that you supply
must adhere to the rules of the policy type you specify in the Type parameter. The maximum
size of a policy document depends on the policy's type. For more information, see Maximum
and minimum values in the Organizations User Guide.
- `description`: An optional description to assign to the policy.
- `name`: The friendly name to assign to the policy. The regex pattern that is used to
validate this parameter is a string of any of the characters in the ASCII character range.
- `type`: The type of policy to create. You can specify one of the following values:
AISERVICES_OPT_OUT_POLICY BACKUP_POLICY SERVICE_CONTROL_POLICY TAG_POLICY
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tags that you want to attach to the newly created policy. For each
tag in the list, you must specify both a tag key and a value. You can set the value to an
empty string, but you can't set it to null. For more information about tagging, see Tagging
Organizations resources in the Organizations User Guide. If any one of the tags is not
valid or if you exceed the allowed number of tags for a policy, then the entire request
fails and the policy is not created.
"""
function create_policy(
Content, Description, Name, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"CreatePolicy",
Dict{String,Any}(
"Content" => Content,
"Description" => Description,
"Name" => Name,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy(
Content,
Description,
Name,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"CreatePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content,
"Description" => Description,
"Name" => Name,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decline_handshake(handshake_id)
decline_handshake(handshake_id, params::Dict{String,<:Any})
Declines a handshake request. This sets the handshake state to DECLINED and effectively
deactivates the request. This operation can be called only from the account that received
the handshake. The originator of the handshake can use CancelHandshake instead. The
originator can't reactivate a declined request, but can reinitiate the process with a new
handshake request. After you decline a handshake, it continues to appear in the results of
relevant APIs for only 30 days. After that, it's deleted.
# Arguments
- `handshake_id`: The unique identifier (ID) of the handshake that you want to decline. You
can get the ID from the ListHandshakesForAccount operation. The regex pattern for handshake
ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
"""
function decline_handshake(HandshakeId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DeclineHandshake",
Dict{String,Any}("HandshakeId" => HandshakeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decline_handshake(
HandshakeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DeclineHandshake",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HandshakeId" => HandshakeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_organization()
delete_organization(params::Dict{String,<:Any})
Deletes the organization. You can delete an organization only by using credentials from the
management account. The organization must be empty of member accounts.
"""
function delete_organization(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DeleteOrganization"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DeleteOrganization", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_organizational_unit(organizational_unit_id)
delete_organizational_unit(organizational_unit_id, params::Dict{String,<:Any})
Deletes an organizational unit (OU) from a root or another OU. You must first remove all
accounts and child OUs from the OU that you want to delete. This operation can be called
only from the organization's management account.
# Arguments
- `organizational_unit_id`: The unique identifier (ID) of the organizational unit that you
want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation. The
regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to
32 lowercase letters or digits (the ID of the root that contains the OU). This string is
followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
"""
function delete_organizational_unit(
OrganizationalUnitId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DeleteOrganizationalUnit",
Dict{String,Any}("OrganizationalUnitId" => OrganizationalUnitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_organizational_unit(
OrganizationalUnitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DeleteOrganizationalUnit",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OrganizationalUnitId" => OrganizationalUnitId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy(policy_id)
delete_policy(policy_id, params::Dict{String,<:Any})
Deletes the specified policy from your organization. Before you perform this operation, you
must first detach the policy from all organizational units (OUs), roots, and accounts. This
operation can be called only from the organization's management account or by a member
account that is a delegated administrator for an Amazon Web Services service.
# Arguments
- `policy_id`: The unique identifier (ID) of the policy that you want to delete. You can
get the ID from the ListPolicies or ListPoliciesForTarget operations. The regex pattern for
a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase
letters, digits, or the underscore character (_).
"""
function delete_policy(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DeletePolicy",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DeletePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy()
delete_resource_policy(params::Dict{String,<:Any})
Deletes the resource policy from your organization. You can only call this operation from
the organization's management account.
"""
function delete_resource_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DeleteResourcePolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_resource_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DeleteResourcePolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_delegated_administrator(account_id, service_principal)
deregister_delegated_administrator(account_id, service_principal, params::Dict{String,<:Any})
Removes the specified member Amazon Web Services account as a delegated administrator for
the specified Amazon Web Services service. Deregistering a delegated administrator can
have unintended impacts on the functionality of the enabled Amazon Web Services service.
See the documentation for the enabled service before you deregister a delegated
administrator so that you understand any potential impacts. You can run this action only
for Amazon Web Services services that support this feature. For a current list of services
that support it, see the column Supports Delegated Administrator in the table at Amazon Web
Services Services that you can use with Organizations in the Organizations User Guide.
This operation can be called only from the organization's management account.
# Arguments
- `account_id`: The account ID number of the member account in the organization that you
want to deregister as a delegated administrator.
- `service_principal`: The service principal name of an Amazon Web Services service for
which the account is a delegated administrator. Delegated administrator privileges are
revoked for only the specified Amazon Web Services service from the member account. If the
specified service is the only service for which the member account is a delegated
administrator, the operation also revokes Organizations read action permissions.
"""
function deregister_delegated_administrator(
AccountId, ServicePrincipal; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DeregisterDelegatedAdministrator",
Dict{String,Any}("AccountId" => AccountId, "ServicePrincipal" => ServicePrincipal);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_delegated_administrator(
AccountId,
ServicePrincipal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DeregisterDelegatedAdministrator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId, "ServicePrincipal" => ServicePrincipal
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account(account_id)
describe_account(account_id, params::Dict{String,<:Any})
Retrieves Organizations-related information about the specified account. This operation can
be called only from the organization's management account or by a member account that is a
delegated administrator for an Amazon Web Services service.
# Arguments
- `account_id`: The unique identifier (ID) of the Amazon Web Services account that you want
information about. You can get the ID from the ListAccounts or ListAccountsForParent
operations. The regex pattern for an account ID string requires exactly 12 digits.
"""
function describe_account(AccountId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DescribeAccount",
Dict{String,Any}("AccountId" => AccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account(
AccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DescribeAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountId" => AccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_create_account_status(create_account_request_id)
describe_create_account_status(create_account_request_id, params::Dict{String,<:Any})
Retrieves the current status of an asynchronous request to create an account. This
operation can be called only from the organization's management account or by a member
account that is a delegated administrator for an Amazon Web Services service.
# Arguments
- `create_account_request_id`: Specifies the Id value that uniquely identifies the
CreateAccount request. You can get the value from the CreateAccountStatus.Id response in an
earlier CreateAccount request, or from the ListCreateAccountStatus operation. The regex
pattern for a create account request ID string requires \"car-\" followed by from 8 to 32
lowercase letters or digits.
"""
function describe_create_account_status(
CreateAccountRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DescribeCreateAccountStatus",
Dict{String,Any}("CreateAccountRequestId" => CreateAccountRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_create_account_status(
CreateAccountRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DescribeCreateAccountStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CreateAccountRequestId" => CreateAccountRequestId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_effective_policy(policy_type)
describe_effective_policy(policy_type, params::Dict{String,<:Any})
Returns the contents of the effective policy for specified policy type and account. The
effective policy is the aggregation of any policies of the specified type that the account
inherits, plus any policy of that type that is directly attached to the account. This
operation applies only to policy types other than service control policies (SCPs). For more
information about policy inheritance, see Understanding management policy inheritance in
the Organizations User Guide. This operation can be called from any account in the
organization.
# Arguments
- `policy_type`: The type of policy that you want information about. You can specify one of
the following values: AISERVICES_OPT_OUT_POLICY BACKUP_POLICY TAG_POLICY
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetId"`: When you're signed in as the management account, specify the ID of the
account that you want details about. Specifying an organization root or organizational unit
(OU) as the target is not supported.
"""
function describe_effective_policy(
PolicyType; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DescribeEffectivePolicy",
Dict{String,Any}("PolicyType" => PolicyType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_effective_policy(
PolicyType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DescribeEffectivePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyType" => PolicyType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_handshake(handshake_id)
describe_handshake(handshake_id, params::Dict{String,<:Any})
Retrieves information about a previously requested handshake. The handshake ID comes from
the response to the original InviteAccountToOrganization operation that generated the
handshake. You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30
days after they change to that state. They're then deleted and no longer accessible. This
operation can be called from any account in the organization.
# Arguments
- `handshake_id`: The unique identifier (ID) of the handshake that you want information
about. You can get the ID from the original call to InviteAccountToOrganization, or from a
call to ListHandshakesForAccount or ListHandshakesForOrganization. The regex pattern for
handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
"""
function describe_handshake(HandshakeId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DescribeHandshake",
Dict{String,Any}("HandshakeId" => HandshakeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_handshake(
HandshakeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DescribeHandshake",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HandshakeId" => HandshakeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization()
describe_organization(params::Dict{String,<:Any})
Retrieves information about the organization that the user's account belongs to. This
operation can be called from any account in the organization. Even if a policy type is
shown as available in the organization, you can disable it separately at the root level
with DisablePolicyType. Use ListRoots to see the status of policy types for a specified
root.
"""
function describe_organization(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DescribeOrganization"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DescribeOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organizational_unit(organizational_unit_id)
describe_organizational_unit(organizational_unit_id, params::Dict{String,<:Any})
Retrieves information about an organizational unit (OU). This operation can be called only
from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Arguments
- `organizational_unit_id`: The unique identifier (ID) of the organizational unit that you
want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4
to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is
followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
"""
function describe_organizational_unit(
OrganizationalUnitId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DescribeOrganizationalUnit",
Dict{String,Any}("OrganizationalUnitId" => OrganizationalUnitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organizational_unit(
OrganizationalUnitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DescribeOrganizationalUnit",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OrganizationalUnitId" => OrganizationalUnitId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_policy(policy_id)
describe_policy(policy_id, params::Dict{String,<:Any})
Retrieves information about a policy. This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service.
# Arguments
- `policy_id`: The unique identifier (ID) of the policy that you want details about. You
can get the ID from the ListPolicies or ListPoliciesForTarget operations. The regex pattern
for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase
letters, digits, or the underscore character (_).
"""
function describe_policy(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DescribePolicy",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_policy(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DescribePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_policy()
describe_resource_policy(params::Dict{String,<:Any})
Retrieves information about a resource policy. This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service.
"""
function describe_resource_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"DescribeResourcePolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_resource_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DescribeResourcePolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_policy(policy_id, target_id)
detach_policy(policy_id, target_id, params::Dict{String,<:Any})
Detaches a policy from a target root, organizational unit (OU), or account. If the policy
being detached is a service control policy (SCP), the changes to permissions for Identity
and Access Management (IAM) users and roles in affected accounts are immediate. Every
root, OU, and account must have at least one SCP attached. If you want to replace the
default FullAWSAccess policy with an SCP that limits the permissions that can be delegated,
you must attach the replacement SCP before you can remove the default SCP. This is the
authorization strategy of an \"allow list\". If you instead attach a second SCP and leave
the FullAWSAccess SCP still attached, and specify \"Effect\": \"Deny\" in the second SCP to
override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP),
you're using the authorization strategy of a \"deny list\". This operation can be called
only from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Arguments
- `policy_id`: The unique identifier (ID) of the policy you want to detach. You can get the
ID from the ListPolicies or ListPoliciesForTarget operations. The regex pattern for a
policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters,
digits, or the underscore character (_).
- `target_id`: The unique identifier (ID) of the root, OU, or account that you want to
detach the policy from. You can get the ID from the ListRoots,
ListOrganizationalUnitsForParent, or ListAccounts operations. The regex pattern for a
target ID string requires one of the following: Root - A string that begins with \"r-\"
followed by from 4 to 32 lowercase letters or digits. Account - A string that consists
of exactly 12 digits. Organizational unit (OU) - A string that begins with \"ou-\"
followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is
in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase
letters or digits.
"""
function detach_policy(
PolicyId, TargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DetachPolicy",
Dict{String,Any}("PolicyId" => PolicyId, "TargetId" => TargetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_policy(
PolicyId,
TargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DetachPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyId" => PolicyId, "TargetId" => TargetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_awsservice_access(service_principal)
disable_awsservice_access(service_principal, params::Dict{String,<:Any})
Disables the integration of an Amazon Web Services service (the service that is specified
by ServicePrincipal) with Organizations. When you disable integration, the specified
service no longer can create a service-linked role in new accounts in your organization.
This means the service can't perform operations on your behalf on any new accounts in your
organization. The service can still perform operations in older accounts until the service
completes its clean-up from Organizations. We strongly recommend that you don't use this
command to disable integration between Organizations and the specified Amazon Web Services
service. Instead, use the console or commands that are provided by the specified service.
This lets the trusted service perform any required initialization when enabling trusted
access, such as creating any required resources and any required clean up of resources when
disabling trusted access. For information about how to disable trusted service access to
your organization using the trusted service, see the Learn more link under the Supports
Trusted Access column at Amazon Web Services services that you can use with Organizations.
on this page. If you disable access by using this command, it causes the following actions
to occur: The service can no longer create a service-linked role in the accounts in your
organization. This means that the service can't perform operations on your behalf on any
new accounts in your organization. The service can still perform operations in older
accounts until the service completes its clean-up from Organizations. The service can no
longer perform tasks in the member accounts in the organization, unless those operations
are explicitly permitted by the IAM policies that are attached to your roles. This includes
any data aggregation from the member accounts to the management account, or to a delegated
administrator account, where relevant. Some services detect this and clean up any
remaining data or resources related to the integration, while other services stop accessing
the organization but leave any historical data and configuration in place to support a
possible re-enabling of the integration. Using the other service's console or commands to
disable the integration ensures that the other service is aware that it can clean up any
resources that are required only for the integration. How the service cleans up its
resources in the organization's accounts depends on that service. For more information, see
the documentation for the other Amazon Web Services service. After you perform the
DisableAWSServiceAccess operation, the specified service can no longer perform operations
in your organization's accounts For more information about integrating other services with
Organizations, including the list of services that work with Organizations, see Using
Organizations with other Amazon Web Services services in the Organizations User Guide. This
operation can be called only from the organization's management account.
# Arguments
- `service_principal`: The service principal name of the Amazon Web Services service for
which you want to disable integration with your organization. This is typically in the form
of a URL, such as service-abbreviation.amazonaws.com.
"""
function disable_awsservice_access(
ServicePrincipal; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DisableAWSServiceAccess",
Dict{String,Any}("ServicePrincipal" => ServicePrincipal);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_awsservice_access(
ServicePrincipal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DisableAWSServiceAccess",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ServicePrincipal" => ServicePrincipal), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_policy_type(policy_type, root_id)
disable_policy_type(policy_type, root_id, params::Dict{String,<:Any})
Disables an organizational policy type in a root. A policy of a certain type can be
attached to entities in a root only if that type is enabled in the root. After you perform
this operation, you no longer can attach policies of the specified type to that root or to
any organizational unit (OU) or account in that root. You can undo this by using the
EnablePolicyType operation. This is an asynchronous request that Amazon Web Services
performs in the background. If you disable a policy type for a root, it still appears
enabled for the organization if all features are enabled for the organization. Amazon Web
Services recommends that you first use ListRoots to see the status of policy types for a
specified root, and then use this operation. This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service. To view the status of available policy types in the
organization, use DescribeOrganization.
# Arguments
- `policy_type`: The policy type that you want to disable in this root. You can specify one
of the following values: AISERVICES_OPT_OUT_POLICY BACKUP_POLICY
SERVICE_CONTROL_POLICY TAG_POLICY
- `root_id`: The unique identifier (ID) of the root in which you want to disable a policy
type. You can get the ID from the ListRoots operation. The regex pattern for a root ID
string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
"""
function disable_policy_type(
PolicyType, RootId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"DisablePolicyType",
Dict{String,Any}("PolicyType" => PolicyType, "RootId" => RootId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_policy_type(
PolicyType,
RootId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"DisablePolicyType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyType" => PolicyType, "RootId" => RootId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_all_features()
enable_all_features(params::Dict{String,<:Any})
Enables all features in an organization. This enables the use of organization policies that
can restrict the services and actions that can be called in each account. Until you enable
all features, you have access only to consolidated billing, and you can't use any of the
advanced account administration features that Organizations supports. For more information,
see Enabling all features in your organization in the Organizations User Guide. This
operation is required only for organizations that were created explicitly with only the
consolidated billing features enabled. Calling this operation sends a handshake to every
invited account in the organization. The feature set change can be finalized and the
additional features enabled only after all administrators in the invited accounts approve
the change by accepting the handshake. After you enable all features, you can separately
enable or disable individual policy types in a root using EnablePolicyType and
DisablePolicyType. To see the status of policy types in a root, use ListRoots. After all
invited member accounts accept the handshake, you finalize the feature set change by
accepting the handshake that contains \"Action\": \"ENABLE_ALL_FEATURES\". This completes
the change. After you enable all features in your organization, the management account in
the organization can apply policies on all member accounts. These policies can restrict
what users and even administrators in those accounts can do. The management account can
apply policies that prevent accounts from leaving the organization. Ensure that your
account administrators are aware of this. This operation can be called only from the
organization's management account.
"""
function enable_all_features(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"EnableAllFeatures"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function enable_all_features(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"EnableAllFeatures", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
enable_awsservice_access(service_principal)
enable_awsservice_access(service_principal, params::Dict{String,<:Any})
Enables the integration of an Amazon Web Services service (the service that is specified by
ServicePrincipal) with Organizations. When you enable integration, you allow the specified
service to create a service-linked role in all the accounts in your organization. This
allows the service to perform operations on your behalf in your organization and its
accounts. We recommend that you enable integration between Organizations and the specified
Amazon Web Services service by using the console or commands that are provided by the
specified service. Doing so ensures that the service is aware that it can create the
resources that are required for the integration. How the service creates those resources in
the organization's accounts depends on that service. For more information, see the
documentation for the other Amazon Web Services service. For more information about
enabling services to integrate with Organizations, see Using Organizations with other
Amazon Web Services services in the Organizations User Guide. You can only call this
operation from the organization's management account and only if the organization has
enabled all features.
# Arguments
- `service_principal`: The service principal name of the Amazon Web Services service for
which you want to enable integration with your organization. This is typically in the form
of a URL, such as service-abbreviation.amazonaws.com.
"""
function enable_awsservice_access(
ServicePrincipal; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"EnableAWSServiceAccess",
Dict{String,Any}("ServicePrincipal" => ServicePrincipal);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_awsservice_access(
ServicePrincipal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"EnableAWSServiceAccess",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ServicePrincipal" => ServicePrincipal), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_policy_type(policy_type, root_id)
enable_policy_type(policy_type, root_id, params::Dict{String,<:Any})
Enables a policy type in a root. After you enable a policy type in a root, you can attach
policies of that type to the root, any organizational unit (OU), or account in that root.
You can undo this by using the DisablePolicyType operation. This is an asynchronous request
that Amazon Web Services performs in the background. Amazon Web Services recommends that
you first use ListRoots to see the status of policy types for a specified root, and then
use this operation. This operation can be called only from the organization's management
account or by a member account that is a delegated administrator for an Amazon Web Services
service. You can enable a policy type in a root only if that policy type is available in
the organization. To view the status of available policy types in the organization, use
DescribeOrganization.
# Arguments
- `policy_type`: The policy type that you want to enable. You can specify one of the
following values: AISERVICES_OPT_OUT_POLICY BACKUP_POLICY SERVICE_CONTROL_POLICY
TAG_POLICY
- `root_id`: The unique identifier (ID) of the root in which you want to enable a policy
type. You can get the ID from the ListRoots operation. The regex pattern for a root ID
string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
"""
function enable_policy_type(
PolicyType, RootId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"EnablePolicyType",
Dict{String,Any}("PolicyType" => PolicyType, "RootId" => RootId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_policy_type(
PolicyType,
RootId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"EnablePolicyType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyType" => PolicyType, "RootId" => RootId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invite_account_to_organization(target)
invite_account_to_organization(target, params::Dict{String,<:Any})
Sends an invitation to another account to join your organization as a member account.
Organizations sends email on your behalf to the email address that is associated with the
other account's owner. The invitation is implemented as a Handshake whose details are in
the response. You can invite Amazon Web Services accounts only from the same seller as
the management account. For example, if your organization's management account was created
by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you
can invite only other AISPL accounts to your organization. You can't combine accounts from
AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more
information, see Consolidated billing in India. If you receive an exception that
indicates that you exceeded your account limits for the organization or that the operation
failed because your organization is still initializing, wait one hour and then try again.
If the error persists after an hour, contact Amazon Web Services Support. If the request
includes tags, then the requester must have the organizations:TagResource permission. This
operation can be called only from the organization's management account.
# Arguments
- `target`: The identifier (ID) of the Amazon Web Services account that you want to invite
to join your organization. This is a JSON object that contains the following elements: {
\"Type\": \"ACCOUNT\", \"Id\": \"< account id number >\" } If you use the CLI, you
can submit this as a single string, similar to the following example: --target
Id=123456789012,Type=ACCOUNT If you specify \"Type\": \"ACCOUNT\", you must provide the
Amazon Web Services account ID number as the Id. If you specify \"Type\": \"EMAIL\", you
must specify the email address that is associated with the account. --target
[email protected],Type=EMAIL
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Notes"`: Additional information that you want to include in the generated email to the
recipient account owner.
- `"Tags"`: A list of tags that you want to attach to the account when it becomes a member
of the organization. For each tag in the list, you must specify both a tag key and a value.
You can set the value to an empty string, but you can't set it to null. For more
information about tagging, see Tagging Organizations resources in the Organizations User
Guide. Any tags in the request are checked for compliance with any applicable tag policies
when the request is made. The request is rejected if the tags in the request don't match
the requirements of the policy at that time. Tag policy compliance is not checked again
when the invitation is accepted and the tags are actually attached to the account. That
means that if the tag policy changes between the invitation and the acceptance, then that
tags could potentially be non-compliant. If any one of the tags is not valid or if you
exceed the allowed number of tags for an account, then the entire request fails and
invitations are not sent.
"""
function invite_account_to_organization(
Target; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"InviteAccountToOrganization",
Dict{String,Any}("Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invite_account_to_organization(
Target, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"InviteAccountToOrganization",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Target" => Target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
leave_organization()
leave_organization(params::Dict{String,<:Any})
Removes a member account from its parent organization. This version of the operation is
performed by the account that wants to leave. To remove a member account as a user in the
management account, use RemoveAccountFromOrganization instead. This operation can be called
only from a member account in the organization. The management account in an
organization with all features enabled can set service control policies (SCPs) that can
restrict what administrators of member accounts can do. This includes preventing them from
successfully calling LeaveOrganization and leaving the organization. You can leave an
organization as a member account only if the account is configured with the information
required to operate as a standalone account. When you create an account in an organization
using the Organizations console, API, or CLI commands, the information required of
standalone accounts is not automatically collected. For each account that you want to make
standalone, you must perform the following steps. If any of the steps are already completed
for this account, that step doesn't appear. Choose a support plan Provide and verify
the required contact information Provide a current payment method Amazon Web Services
uses the payment method to charge for any billable (not free tier) Amazon Web Services
activity that occurs while the account isn't attached to an organization. For more
information, see Considerations before removing an account from an organization in the
Organizations User Guide. The account that you want to leave must not be a delegated
administrator account for any Amazon Web Services service enabled for your organization. If
the account is a delegated administrator, you must first change the delegated administrator
account to another account that is remaining in the organization. You can leave an
organization only after you enable IAM user access to billing in your account. For more
information, see About IAM access to the Billing and Cost Management console in the Amazon
Web Services Billing and Cost Management User Guide. After the account leaves the
organization, all tags that were attached to the account object in the organization are
deleted. Amazon Web Services accounts outside of an organization do not support tags. A
newly created account has a waiting period before it can be removed from its organization.
If you get an error that indicates that a wait period is required, then try again in a few
days. If you are using an organization principal to call LeaveOrganization across
multiple accounts, you can only do this up to 5 accounts per second in a single
organization.
"""
function leave_organization(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"LeaveOrganization"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function leave_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"LeaveOrganization", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_accounts()
list_accounts(params::Dict{String,<:Any})
Lists all the accounts in the organization. To request only the accounts in a specified
root or organizational unit (OU), use the ListAccountsForParent operation instead. Always
check the NextToken response parameter for a null value when calling a List* operation.
These operations can occasionally return an empty set of results even when there are more
results available. The NextToken response parameter value is null only when there are no
more results to display. This operation can be called only from the organization's
management account or by a member account that is a delegated administrator for an Amazon
Web Services service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_accounts(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListAccounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListAccounts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_accounts_for_parent(parent_id)
list_accounts_for_parent(parent_id, params::Dict{String,<:Any})
Lists the accounts in an organization that are contained by the specified target root or
organizational unit (OU). If you specify the root, you get a list of all the accounts that
aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU
and not in any child OUs. To get a list of all accounts in the organization, use the
ListAccounts operation. Always check the NextToken response parameter for a null value
when calling a List* operation. These operations can occasionally return an empty set of
results even when there are more results available. The NextToken response parameter value
is null only when there are no more results to display. This operation can be called only
from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Arguments
- `parent_id`: The unique identifier (ID) for the parent root or organization unit (OU)
whose accounts you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_accounts_for_parent(
ParentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListAccountsForParent",
Dict{String,Any}("ParentId" => ParentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_accounts_for_parent(
ParentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListAccountsForParent",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ParentId" => ParentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_awsservice_access_for_organization()
list_awsservice_access_for_organization(params::Dict{String,<:Any})
Returns a list of the Amazon Web Services services that you enabled to integrate with your
organization. After a service on this list creates the resources that it requires for the
integration, it can perform operations on your organization and its accounts. For more
information about integrating other services with Organizations, including the list of
services that currently work with Organizations, see Using Organizations with other Amazon
Web Services services in the Organizations User Guide. This operation can be called only
from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_awsservice_access_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListAWSServiceAccessForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_awsservice_access_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListAWSServiceAccessForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_children(child_type, parent_id)
list_children(child_type, parent_id, params::Dict{String,<:Any})
Lists all of the organizational units (OUs) or accounts that are contained in the specified
parent OU or root. This operation, along with ListParents enables you to traverse the tree
structure that makes up this root. Always check the NextToken response parameter for a
null value when calling a List* operation. These operations can occasionally return an
empty set of results even when there are more results available. The NextToken response
parameter value is null only when there are no more results to display. This operation can
be called only from the organization's management account or by a member account that is a
delegated administrator for an Amazon Web Services service.
# Arguments
- `child_type`: Filters the output to include only the specified child type.
- `parent_id`: The unique identifier (ID) for the parent root or OU whose children you want
to list. The regex pattern for a parent ID string requires one of the following: Root -
A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32
lowercase letters or digits (the ID of the root that the OU is in). This string is followed
by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_children(
ChildType, ParentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListChildren",
Dict{String,Any}("ChildType" => ChildType, "ParentId" => ParentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_children(
ChildType,
ParentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListChildren",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChildType" => ChildType, "ParentId" => ParentId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_create_account_status()
list_create_account_status(params::Dict{String,<:Any})
Lists the account creation requests that match the specified status that is currently being
tracked for the organization. Always check the NextToken response parameter for a null
value when calling a List* operation. These operations can occasionally return an empty set
of results even when there are more results available. The NextToken response parameter
value is null only when there are no more results to display. This operation can be called
only from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
- `"States"`: A list of one or more states that you want included in the response. If this
parameter isn't present, all requests are included in the response.
"""
function list_create_account_status(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListCreateAccountStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_create_account_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListCreateAccountStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_delegated_administrators()
list_delegated_administrators(params::Dict{String,<:Any})
Lists the Amazon Web Services accounts that are designated as delegated administrators in
this organization. This operation can be called only from the organization's management
account or by a member account that is a delegated administrator for an Amazon Web Services
service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
- `"ServicePrincipal"`: Specifies a service principal name. If specified, then the
operation lists the delegated administrators only for the specified service. If you don't
specify a service principal, the operation lists all delegated administrators for all
services in your organization.
"""
function list_delegated_administrators(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListDelegatedAdministrators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_delegated_administrators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListDelegatedAdministrators",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_delegated_services_for_account(account_id)
list_delegated_services_for_account(account_id, params::Dict{String,<:Any})
List the Amazon Web Services services for which the specified account is a delegated
administrator. This operation can be called only from the organization's management account
or by a member account that is a delegated administrator for an Amazon Web Services service.
# Arguments
- `account_id`: The account ID number of a delegated administrator account in the
organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_delegated_services_for_account(
AccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListDelegatedServicesForAccount",
Dict{String,Any}("AccountId" => AccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_delegated_services_for_account(
AccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListDelegatedServicesForAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountId" => AccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_handshakes_for_account()
list_handshakes_for_account(params::Dict{String,<:Any})
Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED, DECLINED, CANCELED, or EXPIRED appear in the results of this
API for only 30 days after changing to that state. After that, they're deleted and no
longer accessible. Always check the NextToken response parameter for a null value when
calling a List* operation. These operations can occasionally return an empty set of results
even when there are more results available. The NextToken response parameter value is null
only when there are no more results to display. This operation can be called from any
account in the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the handshakes that you want included in the response. The default is
all types. Use the ActionType element to limit the output to only a specified type, such as
INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the
ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member
account, you can specify ParentHandshakeId to see only the handshakes that were generated
by that parent request.
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_handshakes_for_account(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListHandshakesForAccount"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_handshakes_for_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListHandshakesForAccount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_handshakes_for_organization()
list_handshakes_for_organization(params::Dict{String,<:Any})
Lists the handshakes that are associated with the organization that the requesting user is
part of. The ListHandshakesForOrganization operation returns a list of handshake
structures. Each structure contains details and status about a handshake. Handshakes that
are ACCEPTED, DECLINED, CANCELED, or EXPIRED appear in the results of this API for only 30
days after changing to that state. After that, they're deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List*
operation. These operations can occasionally return an empty set of results even when there
are more results available. The NextToken response parameter value is null only when there
are no more results to display. This operation can be called only from the organization's
management account or by a member account that is a delegated administrator for an Amazon
Web Services service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: A filter of the handshakes that you want included in the response. The
default is all types. Use the ActionType element to limit the output to only a specified
type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the
ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member
account, you can specify the ParentHandshakeId to see only the handshakes that were
generated by that parent request.
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_handshakes_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListHandshakesForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_handshakes_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListHandshakesForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organizational_units_for_parent(parent_id)
list_organizational_units_for_parent(parent_id, params::Dict{String,<:Any})
Lists the organizational units (OUs) in a parent organizational unit or root. Always check
the NextToken response parameter for a null value when calling a List* operation. These
operations can occasionally return an empty set of results even when there are more results
available. The NextToken response parameter value is null only when there are no more
results to display. This operation can be called only from the organization's management
account or by a member account that is a delegated administrator for an Amazon Web Services
service.
# Arguments
- `parent_id`: The unique identifier (ID) of the root or OU whose child OUs you want to
list. The regex pattern for a parent ID string requires one of the following: Root - A
string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32
lowercase letters or digits (the ID of the root that the OU is in). This string is followed
by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_organizational_units_for_parent(
ParentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListOrganizationalUnitsForParent",
Dict{String,Any}("ParentId" => ParentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organizational_units_for_parent(
ParentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListOrganizationalUnitsForParent",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ParentId" => ParentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_parents(child_id)
list_parents(child_id, params::Dict{String,<:Any})
Lists the root or organizational units (OUs) that serve as the immediate parent of the
specified child OU or account. This operation, along with ListChildren enables you to
traverse the tree structure that makes up this root. Always check the NextToken response
parameter for a null value when calling a List* operation. These operations can
occasionally return an empty set of results even when there are more results available. The
NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member
account that is a delegated administrator for an Amazon Web Services service. In the
current release, a child can have only a single parent.
# Arguments
- `child_id`: The unique identifier (ID) of the OU or account whose parent containers you
want to list. Don't specify a root. The regex pattern for a child ID string requires one of
the following: Account - A string that consists of exactly 12 digits. Organizational
unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or
digits (the ID of the root that contains the OU). This string is followed by a second \"-\"
dash and from 8 to 32 additional lowercase letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_parents(ChildId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListParents",
Dict{String,Any}("ChildId" => ChildId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_parents(
ChildId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListParents",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ChildId" => ChildId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policies(filter)
list_policies(filter, params::Dict{String,<:Any})
Retrieves the list of all policies in an organization of a specified type. Always check
the NextToken response parameter for a null value when calling a List* operation. These
operations can occasionally return an empty set of results even when there are more results
available. The NextToken response parameter value is null only when there are no more
results to display. This operation can be called only from the organization's management
account or by a member account that is a delegated administrator for an Amazon Web Services
service.
# Arguments
- `filter`: Specifies the type of policy that you want to include in the response. You must
specify one of the following values: AISERVICES_OPT_OUT_POLICY BACKUP_POLICY
SERVICE_CONTROL_POLICY TAG_POLICY
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_policies(Filter; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListPolicies",
Dict{String,Any}("Filter" => Filter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policies(
Filter, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListPolicies",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filter" => Filter), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policies_for_target(filter, target_id)
list_policies_for_target(filter, target_id, params::Dict{String,<:Any})
Lists the policies that are directly attached to the specified target root, organizational
unit (OU), or account. You must specify the policy type that you want included in the
returned list. Always check the NextToken response parameter for a null value when calling
a List* operation. These operations can occasionally return an empty set of results even
when there are more results available. The NextToken response parameter value is null only
when there are no more results to display. This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service.
# Arguments
- `filter`: The type of policy that you want to include in the returned list. You must
specify one of the following values: AISERVICES_OPT_OUT_POLICY BACKUP_POLICY
SERVICE_CONTROL_POLICY TAG_POLICY
- `target_id`: The unique identifier (ID) of the root, organizational unit, or account
whose policies you want to list. The regex pattern for a target ID string requires one of
the following: Root - A string that begins with \"r-\" followed by from 4 to 32
lowercase letters or digits. Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32
lowercase letters or digits (the ID of the root that the OU is in). This string is followed
by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_policies_for_target(
Filter, TargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListPoliciesForTarget",
Dict{String,Any}("Filter" => Filter, "TargetId" => TargetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policies_for_target(
Filter,
TargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListPoliciesForTarget",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Filter" => Filter, "TargetId" => TargetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_roots()
list_roots(params::Dict{String,<:Any})
Lists the roots that are defined in the current organization. Always check the NextToken
response parameter for a null value when calling a List* operation. These operations can
occasionally return an empty set of results even when there are more results available. The
NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's management account or by a member
account that is a delegated administrator for an Amazon Web Services service. Policy types
can be enabled and disabled in roots. This is distinct from whether they're available in
the organization. When you enable all features, you make policy types available for use in
that organization. Individual policy types can then be enabled and disabled in a root. To
see the availability of a policy type in an organization, use DescribeOrganization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_roots(; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"ListRoots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_roots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListRoots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_id)
list_tags_for_resource(resource_id, params::Dict{String,<:Any})
Lists tags that are attached to the specified resource. You can attach tags to the
following resources in Organizations. Amazon Web Services account Organization root
Organizational unit (OU) Policy (any type) This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service.
# Arguments
- `resource_id`: The ID of the resource with the tags to list. You can specify any of the
following taggable resources. Amazon Web Services account – specify the account ID
number. Organizational unit – specify the OU ID that begins with ou- and looks similar
to: ou-1a2b-34uvwxyz Root – specify the root ID that begins with r- and looks similar
to: r-1a2b Policy – specify the policy ID that begins with p- andlooks similar to:
p-12abcdefg3
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_tags_for_resource(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListTagsForResource",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targets_for_policy(policy_id)
list_targets_for_policy(policy_id, params::Dict{String,<:Any})
Lists all the roots, organizational units (OUs), and accounts that the specified policy is
attached to. Always check the NextToken response parameter for a null value when calling a
List* operation. These operations can occasionally return an empty set of results even when
there are more results available. The NextToken response parameter value is null only when
there are no more results to display. This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service.
# Arguments
- `policy_id`: The unique identifier (ID) of the policy whose attachments you want to know.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128
lowercase or uppercase letters, digits, or the underscore character (_).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Organizations might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_targets_for_policy(
PolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"ListTargetsForPolicy",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_targets_for_policy(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"ListTargetsForPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
move_account(account_id, destination_parent_id, source_parent_id)
move_account(account_id, destination_parent_id, source_parent_id, params::Dict{String,<:Any})
Moves an account from its current source parent root or organizational unit (OU) to the
specified destination parent root or OU. This operation can be called only from the
organization's management account.
# Arguments
- `account_id`: The unique identifier (ID) of the account that you want to move. The regex
pattern for an account ID string requires exactly 12 digits.
- `destination_parent_id`: The unique identifier (ID) of the root or organizational unit
that you want to move the account to. The regex pattern for a parent ID string requires one
of the following: Root - A string that begins with \"r-\" followed by from 4 to 32
lowercase letters or digits. Organizational unit (OU) - A string that begins with
\"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the
OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional
lowercase letters or digits.
- `source_parent_id`: The unique identifier (ID) of the root or organizational unit that
you want to move the account from. The regex pattern for a parent ID string requires one of
the following: Root - A string that begins with \"r-\" followed by from 4 to 32
lowercase letters or digits. Organizational unit (OU) - A string that begins with
\"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the
OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional
lowercase letters or digits.
"""
function move_account(
AccountId,
DestinationParentId,
SourceParentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"MoveAccount",
Dict{String,Any}(
"AccountId" => AccountId,
"DestinationParentId" => DestinationParentId,
"SourceParentId" => SourceParentId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function move_account(
AccountId,
DestinationParentId,
SourceParentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"MoveAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId,
"DestinationParentId" => DestinationParentId,
"SourceParentId" => SourceParentId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(content)
put_resource_policy(content, params::Dict{String,<:Any})
Creates or updates a resource policy. You can only call this operation from the
organization's management account.
# Arguments
- `content`: If provided, the new content for the resource policy. The text must be
correctly formatted JSON that complies with the syntax for the resource policy's type. For
more information, see SCP syntax in the Organizations User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tags that you want to attach to the newly created resource policy.
For each tag in the list, you must specify both a tag key and a value. You can set the
value to an empty string, but you can't set it to null. For more information about tagging,
see Tagging Organizations resources in the Organizations User Guide. Calls with tags apply
to the initial creation of the resource policy, otherwise an exception is thrown. If any
one of the tags is not valid or if you exceed the allowed number of tags for the resource
policy, then the entire request fails and the resource policy is not created.
"""
function put_resource_policy(Content; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"PutResourcePolicy",
Dict{String,Any}("Content" => Content);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
Content, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"PutResourcePolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Content" => Content), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_delegated_administrator(account_id, service_principal)
register_delegated_administrator(account_id, service_principal, params::Dict{String,<:Any})
Enables the specified member account to administer the Organizations features of the
specified Amazon Web Services service. It grants read-only access to Organizations service
data. The account still requires IAM permissions to access and administer the Amazon Web
Services service. You can run this action only for Amazon Web Services services that
support this feature. For a current list of services that support it, see the column
Supports Delegated Administrator in the table at Amazon Web Services Services that you can
use with Organizations in the Organizations User Guide. This operation can be called only
from the organization's management account.
# Arguments
- `account_id`: The account ID number of the member account in the organization to register
as a delegated administrator.
- `service_principal`: The service principal of the Amazon Web Services service for which
you want to make the member account a delegated administrator.
"""
function register_delegated_administrator(
AccountId, ServicePrincipal; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"RegisterDelegatedAdministrator",
Dict{String,Any}("AccountId" => AccountId, "ServicePrincipal" => ServicePrincipal);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_delegated_administrator(
AccountId,
ServicePrincipal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"RegisterDelegatedAdministrator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId, "ServicePrincipal" => ServicePrincipal
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_account_from_organization(account_id)
remove_account_from_organization(account_id, params::Dict{String,<:Any})
Removes the specified account from the organization. The removed account becomes a
standalone account that isn't a member of any organization. It's no longer subject to any
policies and is responsible for its own bill payments. The organization's management
account is no longer charged for any expenses accrued by the member account after it's
removed from the organization. This operation can be called only from the organization's
management account. Member accounts can remove themselves with LeaveOrganization instead.
You can remove an account from your organization only if the account is configured with
the information required to operate as a standalone account. When you create an account in
an organization using the Organizations console, API, or CLI commands, the information
required of standalone accounts is not automatically collected. For more information, see
Considerations before removing an account from an organization in the Organizations User
Guide. The account that you want to leave must not be a delegated administrator account
for any Amazon Web Services service enabled for your organization. If the account is a
delegated administrator, you must first change the delegated administrator account to
another account that is remaining in the organization. After the account leaves the
organization, all tags that were attached to the account object in the organization are
deleted. Amazon Web Services accounts outside of an organization do not support tags.
# Arguments
- `account_id`: The unique identifier (ID) of the member account that you want to remove
from the organization. The regex pattern for an account ID string requires exactly 12
digits.
"""
function remove_account_from_organization(
AccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"RemoveAccountFromOrganization",
Dict{String,Any}("AccountId" => AccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_account_from_organization(
AccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"RemoveAccountFromOrganization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountId" => AccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_id, tags)
tag_resource(resource_id, tags, params::Dict{String,<:Any})
Adds one or more tags to the specified resource. Currently, you can attach tags to the
following resources in Organizations. Amazon Web Services account Organization root
Organizational unit (OU) Policy (any type) This operation can be called only from the
organization's management account or by a member account that is a delegated administrator
for an Amazon Web Services service.
# Arguments
- `resource_id`: The ID of the resource to add a tag to. You can specify any of the
following taggable resources. Amazon Web Services account – specify the account ID
number. Organizational unit – specify the OU ID that begins with ou- and looks similar
to: ou-1a2b-34uvwxyz Root – specify the root ID that begins with r- and looks similar
to: r-1a2b Policy – specify the policy ID that begins with p- andlooks similar to:
p-12abcdefg3
- `tags`: A list of tags to add to the specified resource. For each tag in the list, you
must specify both a tag key and a value. The value can be an empty string, but you can't
set it to null. If any one of the tags is not valid or if you exceed the maximum allowed
number of tags for a resource, then the entire request fails.
"""
function tag_resource(ResourceId, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"TagResource",
Dict{String,Any}("ResourceId" => ResourceId, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"TagResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResourceId" => ResourceId, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_id, tag_keys)
untag_resource(resource_id, tag_keys, params::Dict{String,<:Any})
Removes any tags with the specified keys from the specified resource. You can attach tags
to the following resources in Organizations. Amazon Web Services account Organization
root Organizational unit (OU) Policy (any type) This operation can be called only
from the organization's management account or by a member account that is a delegated
administrator for an Amazon Web Services service.
# Arguments
- `resource_id`: The ID of the resource to remove a tag from. You can specify any of the
following taggable resources. Amazon Web Services account – specify the account ID
number. Organizational unit – specify the OU ID that begins with ou- and looks similar
to: ou-1a2b-34uvwxyz Root – specify the root ID that begins with r- and looks similar
to: r-1a2b Policy – specify the policy ID that begins with p- andlooks similar to:
p-12abcdefg3
- `tag_keys`: The list of keys for tags to remove from the specified resource.
"""
function untag_resource(
ResourceId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"UntagResource",
Dict{String,Any}("ResourceId" => ResourceId, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceId" => ResourceId, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_organizational_unit(organizational_unit_id)
update_organizational_unit(organizational_unit_id, params::Dict{String,<:Any})
Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs
and accounts remain in place, and any attached policies of the OU remain attached. This
operation can be called only from the organization's management account.
# Arguments
- `organizational_unit_id`: The unique identifier (ID) of the OU that you want to rename.
You can get the ID from the ListOrganizationalUnitsForParent operation. The regex pattern
for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase
letters or digits (the ID of the root that contains the OU). This string is followed by a
second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The new name that you want to assign to the OU. The regex pattern that is used
to validate this parameter is a string of any of the characters in the ASCII character
range.
"""
function update_organizational_unit(
OrganizationalUnitId; aws_config::AbstractAWSConfig=global_aws_config()
)
return organizations(
"UpdateOrganizationalUnit",
Dict{String,Any}("OrganizationalUnitId" => OrganizationalUnitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_organizational_unit(
OrganizationalUnitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"UpdateOrganizationalUnit",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OrganizationalUnitId" => OrganizationalUnitId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_policy(policy_id)
update_policy(policy_id, params::Dict{String,<:Any})
Updates an existing policy with a new name, description, or content. If you don't supply
any parameter, that value remains unchanged. You can't change a policy's type. This
operation can be called only from the organization's management account or by a member
account that is a delegated administrator for an Amazon Web Services service.
# Arguments
- `policy_id`: The unique identifier (ID) of the policy that you want to update. The regex
pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or
uppercase letters, digits, or the underscore character (_).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content"`: If provided, the new content for the policy. The text must be correctly
formatted JSON that complies with the syntax for the policy's type. For more information,
see SCP syntax in the Organizations User Guide. The maximum size of a policy document
depends on the policy's type. For more information, see Maximum and minimum values in the
Organizations User Guide.
- `"Description"`: If provided, the new description for the policy.
- `"Name"`: If provided, the new name for the policy. The regex pattern that is used to
validate this parameter is a string of any of the characters in the ASCII character range.
"""
function update_policy(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return organizations(
"UpdatePolicy",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_policy(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return organizations(
"UpdatePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 16997 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: osis
using AWS.Compat
using AWS.UUIDs
"""
create_pipeline(max_units, min_units, pipeline_configuration_body, pipeline_name)
create_pipeline(max_units, min_units, pipeline_configuration_body, pipeline_name, params::Dict{String,<:Any})
Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon
OpenSearch Ingestion pipelines.
# Arguments
- `max_units`: The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
- `min_units`: The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
- `pipeline_configuration_body`: The pipeline configuration in YAML format. The command
accepts the pipeline configuration as a string or within a .yaml file. If you provide the
configuration as a string, each new line must be escaped with n.
- `pipeline_name`: The name of the OpenSearch Ingestion pipeline to create. Pipeline names
are unique across the pipelines owned by an account within an Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BufferOptions"`: Key-value pairs to configure persistent buffering for the pipeline.
- `"EncryptionAtRestOptions"`: Key-value pairs to configure encryption for data that is
written to a persistent buffer.
- `"LogPublishingOptions"`: Key-value pairs to configure log publishing.
- `"Tags"`: List of tags to add to the pipeline upon creation.
- `"VpcOptions"`: Container for the values required to configure VPC access for the
pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with
a public endpoint.
"""
function create_pipeline(
MaxUnits,
MinUnits,
PipelineConfigurationBody,
PipelineName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"POST",
"/2022-01-01/osis/createPipeline",
Dict{String,Any}(
"MaxUnits" => MaxUnits,
"MinUnits" => MinUnits,
"PipelineConfigurationBody" => PipelineConfigurationBody,
"PipelineName" => PipelineName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pipeline(
MaxUnits,
MinUnits,
PipelineConfigurationBody,
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"POST",
"/2022-01-01/osis/createPipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MaxUnits" => MaxUnits,
"MinUnits" => MinUnits,
"PipelineConfigurationBody" => PipelineConfigurationBody,
"PipelineName" => PipelineName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pipeline(pipeline_name)
delete_pipeline(pipeline_name, params::Dict{String,<:Any})
Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon
OpenSearch Ingestion pipelines.
# Arguments
- `pipeline_name`: The name of the pipeline to delete.
"""
function delete_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"DELETE",
"/2022-01-01/osis/deletePipeline/$(PipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pipeline(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"DELETE",
"/2022-01-01/osis/deletePipeline/$(PipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_pipeline(pipeline_name)
get_pipeline(pipeline_name, params::Dict{String,<:Any})
Retrieves information about an OpenSearch Ingestion pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline.
"""
function get_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"GET",
"/2022-01-01/osis/getPipeline/$(PipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_pipeline(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"GET",
"/2022-01-01/osis/getPipeline/$(PipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_pipeline_blueprint(blueprint_name)
get_pipeline_blueprint(blueprint_name, params::Dict{String,<:Any})
Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are
templates for the configuration needed for a CreatePipeline request. For more information,
see Using blueprints to create a pipeline.
# Arguments
- `blueprint_name`: The name of the blueprint to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"format"`: The format format of the blueprint to retrieve.
"""
function get_pipeline_blueprint(
BlueprintName; aws_config::AbstractAWSConfig=global_aws_config()
)
return osis(
"GET",
"/2022-01-01/osis/getPipelineBlueprint/$(BlueprintName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_pipeline_blueprint(
BlueprintName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"GET",
"/2022-01-01/osis/getPipelineBlueprint/$(BlueprintName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_pipeline_change_progress(pipeline_name)
get_pipeline_change_progress(pipeline_name, params::Dict{String,<:Any})
Returns progress information for the current change happening on an OpenSearch Ingestion
pipeline. Currently, this operation only returns information when a pipeline is being
created. For more information, see Tracking the status of pipeline creation.
# Arguments
- `pipeline_name`: The name of the pipeline.
"""
function get_pipeline_change_progress(
PipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return osis(
"GET",
"/2022-01-01/osis/getPipelineChangeProgress/$(PipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_pipeline_change_progress(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"GET",
"/2022-01-01/osis/getPipelineChangeProgress/$(PipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipeline_blueprints()
list_pipeline_blueprints(params::Dict{String,<:Any})
Retrieves a list of all available blueprints for Data Prepper. For more information, see
Using blueprints to create a pipeline.
"""
function list_pipeline_blueprints(; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"POST",
"/2022-01-01/osis/listPipelineBlueprints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pipeline_blueprints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return osis(
"POST",
"/2022-01-01/osis/listPipelineBlueprints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipelines()
list_pipelines(params::Dict{String,<:Any})
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and
Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results.
- `"nextToken"`: If your initial ListPipelines operation returns a nextToken, you can
include the returned nextToken in subsequent ListPipelines operations, which returns
results in the next page.
"""
function list_pipelines(; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"GET",
"/2022-01-01/osis/listPipelines";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pipelines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return osis(
"GET",
"/2022-01-01/osis/listPipelines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})
Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more
information, see Tagging Amazon OpenSearch Ingestion pipelines.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
"""
function list_tags_for_resource(arn; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"GET",
"/2022-01-01/osis/listTagsForResource/",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return osis(
"GET",
"/2022-01-01/osis/listTagsForResource/",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_pipeline(pipeline_name)
start_pipeline(pipeline_name, params::Dict{String,<:Any})
Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch
Ingestion pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline to start.
"""
function start_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"PUT",
"/2022-01-01/osis/startPipeline/$(PipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_pipeline(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"PUT",
"/2022-01-01/osis/startPipeline/$(PipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_pipeline(pipeline_name)
stop_pipeline(pipeline_name, params::Dict{String,<:Any})
Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch
Ingestion pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline to stop.
"""
function stop_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"PUT",
"/2022-01-01/osis/stopPipeline/$(PipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_pipeline(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"PUT",
"/2022-01-01/osis/stopPipeline/$(PipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags, arn)
tag_resource(tags, arn, params::Dict{String,<:Any})
Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch
Ingestion pipelines.
# Arguments
- `tags`: The list of key-value tags to add to the pipeline.
- `arn`: The Amazon Resource Name (ARN) of the pipeline to tag.
"""
function tag_resource(Tags, arn; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"POST",
"/2022-01-01/osis/tagResource/",
Dict{String,Any}("Tags" => Tags, "arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Tags,
arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"POST",
"/2022-01-01/osis/tagResource/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Tags" => Tags, "arn" => arn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(tag_keys, arn)
untag_resource(tag_keys, arn, params::Dict{String,<:Any})
Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see
Tagging Amazon OpenSearch Ingestion pipelines.
# Arguments
- `tag_keys`: The tag keys to remove.
- `arn`: The Amazon Resource Name (ARN) of the pipeline to remove tags from.
"""
function untag_resource(TagKeys, arn; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"POST",
"/2022-01-01/osis/untagResource/",
Dict{String,Any}("TagKeys" => TagKeys, "arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
TagKeys,
arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"POST",
"/2022-01-01/osis/untagResource/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TagKeys" => TagKeys, "arn" => arn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline(pipeline_name)
update_pipeline(pipeline_name, params::Dict{String,<:Any})
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon
OpenSearch Ingestion pipelines.
# Arguments
- `pipeline_name`: The name of the pipeline to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BufferOptions"`: Key-value pairs to configure persistent buffering for the pipeline.
- `"EncryptionAtRestOptions"`: Key-value pairs to configure encryption for data that is
written to a persistent buffer.
- `"LogPublishingOptions"`: Key-value pairs to configure log publishing.
- `"MaxUnits"`: The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
- `"MinUnits"`: The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
- `"PipelineConfigurationBody"`: The pipeline configuration in YAML format. The command
accepts the pipeline configuration as a string or within a .yaml file. If you provide the
configuration as a string, each new line must be escaped with n.
"""
function update_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return osis(
"PUT",
"/2022-01-01/osis/updatePipeline/$(PipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"PUT",
"/2022-01-01/osis/updatePipeline/$(PipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_pipeline(pipeline_configuration_body)
validate_pipeline(pipeline_configuration_body, params::Dict{String,<:Any})
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
For more information, see Creating Amazon OpenSearch Ingestion pipelines.
# Arguments
- `pipeline_configuration_body`: The pipeline configuration in YAML format. The command
accepts the pipeline configuration as a string or within a .yaml file. If you provide the
configuration as a string, each new line must be escaped with n.
"""
function validate_pipeline(
PipelineConfigurationBody; aws_config::AbstractAWSConfig=global_aws_config()
)
return osis(
"POST",
"/2022-01-01/osis/validatePipeline",
Dict{String,Any}("PipelineConfigurationBody" => PipelineConfigurationBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_pipeline(
PipelineConfigurationBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return osis(
"POST",
"/2022-01-01/osis/validatePipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PipelineConfigurationBody" => PipelineConfigurationBody),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 37130 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: outposts
using AWS.Compat
using AWS.UUIDs
"""
cancel_capacity_task(capacity_task_id, outpost_id)
cancel_capacity_task(capacity_task_id, outpost_id, params::Dict{String,<:Any})
Cancels the capacity task.
# Arguments
- `capacity_task_id`: ID of the capacity task that you want to cancel.
- `outpost_id`: ID or ARN of the Outpost associated with the capacity task that you want to
cancel.
"""
function cancel_capacity_task(
CapacityTaskId, OutpostId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"POST",
"/outposts/$(OutpostId)/capacity/$(CapacityTaskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_capacity_task(
CapacityTaskId,
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/outposts/$(OutpostId)/capacity/$(CapacityTaskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_order(order_id)
cancel_order(order_id, params::Dict{String,<:Any})
Cancels the specified order for an Outpost.
# Arguments
- `order_id`: The ID of the order.
"""
function cancel_order(OrderId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"POST",
"/orders/$(OrderId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_order(
OrderId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"POST",
"/orders/$(OrderId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_order(line_items, outpost_identifier, payment_option)
create_order(line_items, outpost_identifier, payment_option, params::Dict{String,<:Any})
Creates an order for an Outpost.
# Arguments
- `line_items`: The line items that make up the order.
- `outpost_identifier`: The ID or the Amazon Resource Name (ARN) of the Outpost.
- `payment_option`: The payment option.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PaymentTerm"`: The payment terms.
"""
function create_order(
LineItems,
OutpostIdentifier,
PaymentOption;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/orders",
Dict{String,Any}(
"LineItems" => LineItems,
"OutpostIdentifier" => OutpostIdentifier,
"PaymentOption" => PaymentOption,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_order(
LineItems,
OutpostIdentifier,
PaymentOption,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/orders",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LineItems" => LineItems,
"OutpostIdentifier" => OutpostIdentifier,
"PaymentOption" => PaymentOption,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_outpost(name, site_id)
create_outpost(name, site_id, params::Dict{String,<:Any})
Creates an Outpost. You can specify either an Availability one or an AZ ID.
# Arguments
- `name`:
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`:
- `"AvailabilityZoneId"`:
- `"Description"`:
- `"SupportedHardwareType"`: The type of hardware for this Outpost.
- `"Tags"`: The tags to apply to the Outpost.
"""
function create_outpost(Name, SiteId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"POST",
"/outposts",
Dict{String,Any}("Name" => Name, "SiteId" => SiteId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_outpost(
Name,
SiteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/outposts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "SiteId" => SiteId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_site(name)
create_site(name, params::Dict{String,<:Any})
Creates a site for an Outpost.
# Arguments
- `name`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`:
- `"Notes"`: Additional information that you provide about site access requirements,
electrician scheduling, personal protective equipment, or regulation of equipment materials
that could affect your installation process.
- `"OperatingAddress"`: The location to install and power on the hardware. This address
might be different from the shipping address.
- `"RackPhysicalProperties"`: Information about the physical and logistical details for
the rack at this site. For more information about hardware requirements for racks, see
Network readiness checklist in the Amazon Web Services Outposts User Guide.
- `"ShippingAddress"`: The location to ship the hardware. This address might be different
from the operating address.
- `"Tags"`: The tags to apply to a site.
"""
function create_site(Name; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"POST",
"/sites",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_site(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"POST",
"/sites",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_outpost(outpost_id)
delete_outpost(outpost_id, params::Dict{String,<:Any})
Deletes the specified Outpost.
# Arguments
- `outpost_id`: The ID or ARN of the Outpost.
"""
function delete_outpost(OutpostId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"DELETE",
"/outposts/$(OutpostId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_outpost(
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"DELETE",
"/outposts/$(OutpostId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_site(site_id)
delete_site(site_id, params::Dict{String,<:Any})
Deletes the specified site.
# Arguments
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
"""
function delete_site(SiteId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"DELETE", "/sites/$(SiteId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_site(
SiteId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"DELETE",
"/sites/$(SiteId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_capacity_task(capacity_task_id, outpost_id)
get_capacity_task(capacity_task_id, outpost_id, params::Dict{String,<:Any})
Gets details of the specified capacity task.
# Arguments
- `capacity_task_id`: ID of the capacity task.
- `outpost_id`: ID or ARN of the Outpost associated with the specified capacity task.
"""
function get_capacity_task(
CapacityTaskId, OutpostId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/outposts/$(OutpostId)/capacity/$(CapacityTaskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_capacity_task(
CapacityTaskId,
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/outposts/$(OutpostId)/capacity/$(CapacityTaskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_catalog_item(catalog_item_id)
get_catalog_item(catalog_item_id, params::Dict{String,<:Any})
Gets information about the specified catalog item.
# Arguments
- `catalog_item_id`: The ID of the catalog item.
"""
function get_catalog_item(CatalogItemId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET",
"/catalog/item/$(CatalogItemId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_catalog_item(
CatalogItemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/catalog/item/$(CatalogItemId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connection(connection_id)
get_connection(connection_id, params::Dict{String,<:Any})
Amazon Web Services uses this action to install Outpost servers. Gets information about
the specified connection. Use CloudTrail to monitor this action or Amazon Web Services
managed policy for Amazon Web Services Outposts to secure it. For more information, see
Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon
Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web
Services Outposts User Guide.
# Arguments
- `connection_id`: The ID of the connection.
"""
function get_connection(ConnectionId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET",
"/connections/$(ConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/connections/$(ConnectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_order(order_id)
get_order(order_id, params::Dict{String,<:Any})
Gets information about the specified order.
# Arguments
- `order_id`: The ID of the order.
"""
function get_order(OrderId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET", "/orders/$(OrderId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_order(
OrderId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/orders/$(OrderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_outpost(outpost_id)
get_outpost(outpost_id, params::Dict{String,<:Any})
Gets information about the specified Outpost.
# Arguments
- `outpost_id`: The ID or ARN of the Outpost.
"""
function get_outpost(OutpostId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET",
"/outposts/$(OutpostId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_outpost(
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/outposts/$(OutpostId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_outpost_instance_types(outpost_id)
get_outpost_instance_types(outpost_id, params::Dict{String,<:Any})
Gets the instance types for the specified Outpost.
# Arguments
- `outpost_id`: The ID or ARN of the Outpost.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function get_outpost_instance_types(
OutpostId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/outposts/$(OutpostId)/instanceTypes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_outpost_instance_types(
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/outposts/$(OutpostId)/instanceTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_outpost_supported_instance_types(order_id, outpost_id)
get_outpost_supported_instance_types(order_id, outpost_id, params::Dict{String,<:Any})
Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will
generally include instance types that are not currently configured and therefore cannot be
launched with the current Outpost capacity configuration.
# Arguments
- `order_id`: The ID for the Amazon Web Services Outposts order.
- `outpost_id`: The ID or ARN of the Outpost.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function get_outpost_supported_instance_types(
OrderId, OutpostId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/outposts/$(OutpostId)/supportedInstanceTypes",
Dict{String,Any}("OrderId" => OrderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_outpost_supported_instance_types(
OrderId,
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/outposts/$(OutpostId)/supportedInstanceTypes",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("OrderId" => OrderId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_site(site_id)
get_site(site_id, params::Dict{String,<:Any})
Gets information about the specified Outpost site.
# Arguments
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
"""
function get_site(SiteId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET", "/sites/$(SiteId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_site(
SiteId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/sites/$(SiteId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_site_address(address_type, site_id)
get_site_address(address_type, site_id, params::Dict{String,<:Any})
Gets the site address of the specified site.
# Arguments
- `address_type`: The type of the address you request.
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
"""
function get_site_address(
AddressType, SiteId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/sites/$(SiteId)/address",
Dict{String,Any}("AddressType" => AddressType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_site_address(
AddressType,
SiteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/sites/$(SiteId)/address",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AddressType" => AddressType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assets(outpost_id)
list_assets(outpost_id, params::Dict{String,<:Any})
Lists the hardware assets for the specified Outpost. Use filters to return specific
results. If you specify multiple filters, the results include only the resources that match
all of the specified filters. For a filter where you can specify multiple values, the
results include items that match any of the values that you specify for the filter.
# Arguments
- `outpost_id`: The ID or the Amazon Resource Name (ARN) of the Outpost.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HostIdFilter"`: Filters the results by the host ID of a Dedicated Host.
- `"MaxResults"`:
- `"NextToken"`:
- `"StatusFilter"`: Filters the results by state.
"""
function list_assets(OutpostId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET",
"/outposts/$(OutpostId)/assets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_assets(
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/outposts/$(OutpostId)/assets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_capacity_tasks()
list_capacity_tasks(params::Dict{String,<:Any})
Lists the capacity tasks for your Amazon Web Services account. Use filters to return
specific results. If you specify multiple filters, the results include only the resources
that match all of the specified filters. For a filter where you can specify multiple
values, the results include items that match any of the values that you specify for the
filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityTaskStatusFilter"`: A list of statuses. For example, REQUESTED or
WAITING_FOR_EVACUATION.
- `"MaxResults"`:
- `"NextToken"`:
- `"OutpostIdentifierFilter"`: Filters the results by an Outpost ID or an Outpost ARN.
"""
function list_capacity_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET", "/capacity/tasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_capacity_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/capacity/tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_catalog_items()
list_catalog_items(params::Dict{String,<:Any})
Lists the items in the catalog. Use filters to return specific results. If you specify
multiple filters, the results include only the resources that match all of the specified
filters. For a filter where you can specify multiple values, the results include items that
match any of the values that you specify for the filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EC2FamilyFilter"`: Filters the results by EC2 family (for example, M5).
- `"ItemClassFilter"`: Filters the results by item class.
- `"MaxResults"`:
- `"NextToken"`:
- `"SupportedStorageFilter"`: Filters the results by storage option.
"""
function list_catalog_items(; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET", "/catalog/items"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_catalog_items(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/catalog/items",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_orders()
list_orders(params::Dict{String,<:Any})
Lists the Outpost orders for your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
- `"OutpostIdentifierFilter"`: The ID or the Amazon Resource Name (ARN) of the Outpost.
"""
function list_orders(; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET", "/list-orders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_orders(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/list-orders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_outposts()
list_outposts(params::Dict{String,<:Any})
Lists the Outposts for your Amazon Web Services account. Use filters to return specific
results. If you specify multiple filters, the results include only the resources that match
all of the specified filters. For a filter where you can specify multiple values, the
results include items that match any of the values that you specify for the filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZoneFilter"`: Filters the results by Availability Zone (for example,
us-east-1a).
- `"AvailabilityZoneIdFilter"`: Filters the results by AZ ID (for example, use1-az1).
- `"LifeCycleStatusFilter"`: Filters the results by the lifecycle status.
- `"MaxResults"`:
- `"NextToken"`:
"""
function list_outposts(; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"GET", "/outposts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_outposts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET", "/outposts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_sites()
list_sites(params::Dict{String,<:Any})
Lists the Outpost sites for your Amazon Web Services account. Use filters to return
specific results. Use filters to return specific results. If you specify multiple filters,
the results include only the resources that match all of the specified filters. For a
filter where you can specify multiple values, the results include items that match any of
the values that you specify for the filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
- `"OperatingAddressCityFilter"`: Filters the results by city.
- `"OperatingAddressCountryCodeFilter"`: Filters the results by country code.
- `"OperatingAddressStateOrRegionFilter"`: Filters the results by state or region.
"""
function list_sites(; aws_config::AbstractAWSConfig=global_aws_config())
return outposts("GET", "/sites"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_sites(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET", "/sites", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_capacity_task(instance_pools, order_id, outpost_id)
start_capacity_task(instance_pools, order_id, outpost_id, params::Dict{String,<:Any})
Starts the specified capacity task. You can have one active capacity task for an order.
# Arguments
- `instance_pools`: The instance pools specified in the capacity task.
- `order_id`: The ID of the Amazon Web Services Outposts order associated with the
specified capacity task.
- `outpost_id`: The ID or ARN of the Outposts associated with the specified capacity task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: You can request a dry run to determine if the instance type and instance size
changes is above or below available instance capacity. Requesting a dry run does not make
any changes to your plan.
"""
function start_capacity_task(
InstancePools, OrderId, OutpostId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"POST",
"/outposts/$(OutpostId)/capacity",
Dict{String,Any}("InstancePools" => InstancePools, "OrderId" => OrderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_capacity_task(
InstancePools,
OrderId,
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/outposts/$(OutpostId)/capacity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstancePools" => InstancePools, "OrderId" => OrderId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_connection(asset_id, client_public_key, network_interface_device_index)
start_connection(asset_id, client_public_key, network_interface_device_index, params::Dict{String,<:Any})
Amazon Web Services uses this action to install Outpost servers. Starts the connection
required for Outpost server installation. Use CloudTrail to monitor this action or Amazon
Web Services managed policy for Amazon Web Services Outposts to secure it. For more
information, see Amazon Web Services managed policies for Amazon Web Services Outposts and
Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the
Amazon Web Services Outposts User Guide.
# Arguments
- `asset_id`: The ID of the Outpost server.
- `client_public_key`: The public key of the client.
- `network_interface_device_index`: The device index of the network interface on the
Outpost server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceSerialNumber"`: The serial number of the dongle.
"""
function start_connection(
AssetId,
ClientPublicKey,
NetworkInterfaceDeviceIndex;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/connections",
Dict{String,Any}(
"AssetId" => AssetId,
"ClientPublicKey" => ClientPublicKey,
"NetworkInterfaceDeviceIndex" => NetworkInterfaceDeviceIndex,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_connection(
AssetId,
ClientPublicKey,
NetworkInterfaceDeviceIndex,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/connections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssetId" => AssetId,
"ClientPublicKey" => ClientPublicKey,
"NetworkInterfaceDeviceIndex" => NetworkInterfaceDeviceIndex,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags to add to the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The tag keys.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_outpost(outpost_id)
update_outpost(outpost_id, params::Dict{String,<:Any})
Updates an Outpost.
# Arguments
- `outpost_id`: The ID or ARN of the Outpost.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`:
- `"Name"`:
- `"SupportedHardwareType"`: The type of hardware for this Outpost.
"""
function update_outpost(OutpostId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"PATCH",
"/outposts/$(OutpostId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_outpost(
OutpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"PATCH",
"/outposts/$(OutpostId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_site(site_id)
update_site(site_id, params::Dict{String,<:Any})
Updates the specified site.
# Arguments
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`:
- `"Name"`:
- `"Notes"`: Notes about a site.
"""
function update_site(SiteId; aws_config::AbstractAWSConfig=global_aws_config())
return outposts(
"PATCH", "/sites/$(SiteId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_site(
SiteId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"PATCH",
"/sites/$(SiteId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_site_address(address, address_type, site_id)
update_site_address(address, address_type, site_id, params::Dict{String,<:Any})
Updates the address of the specified site. You can't update a site address if there is an
order in progress. You must wait for the order to complete or cancel the order. You can
update the operating address before you place an order at the site, or after all Outposts
that belong to the site have been deactivated.
# Arguments
- `address`: The address for the site.
- `address_type`: The type of the address.
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
"""
function update_site_address(
Address, AddressType, SiteId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"PUT",
"/sites/$(SiteId)/address",
Dict{String,Any}("Address" => Address, "AddressType" => AddressType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_site_address(
Address,
AddressType,
SiteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return outposts(
"PUT",
"/sites/$(SiteId)/address",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Address" => Address, "AddressType" => AddressType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_site_rack_physical_properties(site_id)
update_site_rack_physical_properties(site_id, params::Dict{String,<:Any})
Update the physical and logistical details for a rack at a site. For more information about
hardware requirements for racks, see Network readiness checklist in the Amazon Web Services
Outposts User Guide. To update a rack at a site with an order of IN_PROGRESS, you must
wait for the order to complete or cancel the order.
# Arguments
- `site_id`: The ID or the Amazon Resource Name (ARN) of the site.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FiberOpticCableType"`: The type of fiber that you will use to attach the Outpost to
your network.
- `"MaximumSupportedWeightLbs"`: The maximum rack weight that this site can support.
NO_LIMIT is over 2000lbs.
- `"OpticalStandard"`: The type of optical standard that you will use to attach the Outpost
to your network. This field is dependent on uplink speed, fiber type, and distance to the
upstream device. For more information about networking requirements for racks, see Network
in the Amazon Web Services Outposts User Guide. OPTIC_10GBASE_SR: 10GBASE-SR
OPTIC_10GBASE_IR: 10GBASE-IR OPTIC_10GBASE_LR: 10GBASE-LR OPTIC_40GBASE_SR:
40GBASE-SR OPTIC_40GBASE_ESR: 40GBASE-ESR OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L)
OPTIC_40GBASE_LR4: 40GBASE-LR4 OPTIC_100GBASE_SR4: 100GBASE-SR4
OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4 OPTIC_100GBASE_LR4: 100GBASE-LR4
OPTIC_100G_PSM4_MSA: 100G PSM4 MSA OPTIC_1000BASE_LX: 1000Base-LX OPTIC_1000BASE_SX :
1000Base-SX
- `"PowerConnector"`: The power connector that Amazon Web Services should plan to provide
for connections to the hardware. Note the correlation between PowerPhase and
PowerConnector. Single-phase AC feed L6-30P – (common in US); 30A; single phase
IEC309 (blue) – P+N+E, 6hr; 32 A; single phase Three-phase AC feed AH530P7W (red)
– 3P+N+E, 7hr; 30A; three phase AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase
- `"PowerDrawKva"`: The power draw, in kVA, available at the hardware placement position
for the rack.
- `"PowerFeedDrop"`: Indicates whether the power feed comes above or below the rack.
- `"PowerPhase"`: The power option that you can provide for hardware. Single-phase AC
feed: 200 V to 277 V, 50 Hz or 60 Hz Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz
- `"UplinkCount"`: Racks come with two Outpost network devices. Depending on the supported
uplink speed at the site, the Outpost network devices provide a variable number of uplinks.
Specify the number of uplinks for each Outpost network device that you intend to use to
connect the rack to your network. Note the correlation between UplinkGbps and UplinkCount.
1Gbps - Uplinks available: 1, 2, 4, 6, 8 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16
40 and 100 Gbps- Uplinks available: 1, 2, 4
- `"UplinkGbps"`: The uplink speed the rack should support for the connection to the
Region.
"""
function update_site_rack_physical_properties(
SiteId; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"PATCH",
"/sites/$(SiteId)/rackPhysicalProperties";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_site_rack_physical_properties(
SiteId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return outposts(
"PATCH",
"/sites/$(SiteId)/rackPhysicalProperties",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 37423 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: panorama
using AWS.Compat
using AWS.UUIDs
"""
create_application_instance(default_runtime_context_device, manifest_payload)
create_application_instance(default_runtime_context_device, manifest_payload, params::Dict{String,<:Any})
Creates an application instance and deploys it to a device.
# Arguments
- `default_runtime_context_device`: A device's ID.
- `manifest_payload`: The application's manifest document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationInstanceIdToReplace"`: The ID of an application instance to replace with the
new instance.
- `"Description"`: A description for the application instance.
- `"ManifestOverridesPayload"`: Setting overrides for the application manifest.
- `"Name"`: A name for the application instance.
- `"RuntimeRoleArn"`: The ARN of a runtime role for the application instance.
- `"Tags"`: Tags for the application instance.
"""
function create_application_instance(
DefaultRuntimeContextDevice,
ManifestPayload;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/application-instances",
Dict{String,Any}(
"DefaultRuntimeContextDevice" => DefaultRuntimeContextDevice,
"ManifestPayload" => ManifestPayload,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application_instance(
DefaultRuntimeContextDevice,
ManifestPayload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/application-instances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultRuntimeContextDevice" => DefaultRuntimeContextDevice,
"ManifestPayload" => ManifestPayload,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job_for_devices(device_ids, job_type)
create_job_for_devices(device_ids, job_type, params::Dict{String,<:Any})
Creates a job to run on a device. A job can update a device's software or reboot it.
# Arguments
- `device_ids`: ID of target device.
- `job_type`: The type of job to run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceJobConfig"`: Configuration settings for a software update job.
"""
function create_job_for_devices(
DeviceIds, JobType; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"POST",
"/jobs",
Dict{String,Any}("DeviceIds" => DeviceIds, "JobType" => JobType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job_for_devices(
DeviceIds,
JobType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DeviceIds" => DeviceIds, "JobType" => JobType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_node_from_template_job(node_name, output_package_name, output_package_version, template_parameters, template_type)
create_node_from_template_job(node_name, output_package_name, output_package_version, template_parameters, template_type, params::Dict{String,<:Any})
Creates a camera stream node.
# Arguments
- `node_name`: A name for the node.
- `output_package_name`: An output package name for the node.
- `output_package_version`: An output package version for the node.
- `template_parameters`: Template parameters for the node.
- `template_type`: The type of node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobTags"`: Tags for the job.
- `"NodeDescription"`: A description for the node.
"""
function create_node_from_template_job(
NodeName,
OutputPackageName,
OutputPackageVersion,
TemplateParameters,
TemplateType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/packages/template-job",
Dict{String,Any}(
"NodeName" => NodeName,
"OutputPackageName" => OutputPackageName,
"OutputPackageVersion" => OutputPackageVersion,
"TemplateParameters" => TemplateParameters,
"TemplateType" => TemplateType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_node_from_template_job(
NodeName,
OutputPackageName,
OutputPackageVersion,
TemplateParameters,
TemplateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/packages/template-job",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NodeName" => NodeName,
"OutputPackageName" => OutputPackageName,
"OutputPackageVersion" => OutputPackageVersion,
"TemplateParameters" => TemplateParameters,
"TemplateType" => TemplateType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_package(package_name)
create_package(package_name, params::Dict{String,<:Any})
Creates a package and storage location in an Amazon S3 access point.
# Arguments
- `package_name`: A name for the package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags for the package.
"""
function create_package(PackageName; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"POST",
"/packages",
Dict{String,Any}("PackageName" => PackageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_package(
PackageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/packages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PackageName" => PackageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_package_import_job(client_token, input_config, job_type, output_config)
create_package_import_job(client_token, input_config, job_type, output_config, params::Dict{String,<:Any})
Imports a node package.
# Arguments
- `client_token`: A client token for the package import job.
- `input_config`: An input config for the package import job.
- `job_type`: A job type for the package import job.
- `output_config`: An output config for the package import job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobTags"`: Tags for the package import job.
"""
function create_package_import_job(
ClientToken,
InputConfig,
JobType,
OutputConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/packages/import-jobs",
Dict{String,Any}(
"ClientToken" => ClientToken,
"InputConfig" => InputConfig,
"JobType" => JobType,
"OutputConfig" => OutputConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_package_import_job(
ClientToken,
InputConfig,
JobType,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/packages/import-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"InputConfig" => InputConfig,
"JobType" => JobType,
"OutputConfig" => OutputConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device(device_id)
delete_device(device_id, params::Dict{String,<:Any})
Deletes a device.
# Arguments
- `device_id`: The device's ID.
"""
function delete_device(DeviceId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"DELETE",
"/devices/$(DeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device(
DeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"DELETE",
"/devices/$(DeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_package(package_id)
delete_package(package_id, params::Dict{String,<:Any})
Deletes a package. To delete a package, you need permission to call s3:DeleteObject in
addition to permissions for the AWS Panorama API.
# Arguments
- `package_id`: The package's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceDelete"`: Delete the package even if it has artifacts stored in its access point.
Deletes the package's artifacts from Amazon S3.
"""
function delete_package(PackageId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"DELETE",
"/packages/$(PackageId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_package(
PackageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"DELETE",
"/packages/$(PackageId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_package_version(package_id, package_version, patch_version)
deregister_package_version(package_id, package_version, patch_version, params::Dict{String,<:Any})
Deregisters a package version.
# Arguments
- `package_id`: A package ID.
- `package_version`: A package version.
- `patch_version`: A patch version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OwnerAccount"`: An owner account.
- `"UpdatedLatestPatchVersion"`: If the version was marked latest, the new version to maker
as latest.
"""
function deregister_package_version(
PackageId,
PackageVersion,
PatchVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"DELETE",
"/packages/$(PackageId)/versions/$(PackageVersion)/patch/$(PatchVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_package_version(
PackageId,
PackageVersion,
PatchVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"DELETE",
"/packages/$(PackageId)/versions/$(PackageVersion)/patch/$(PatchVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_instance(application_instance_id)
describe_application_instance(application_instance_id, params::Dict{String,<:Any})
Returns information about an application instance on a device.
# Arguments
- `application_instance_id`: The application instance's ID.
"""
function describe_application_instance(
ApplicationInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_instance(
ApplicationInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_instance_details(application_instance_id)
describe_application_instance_details(application_instance_id, params::Dict{String,<:Any})
Returns information about an application instance's configuration manifest.
# Arguments
- `application_instance_id`: The application instance's ID.
"""
function describe_application_instance_details(
ApplicationInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)/details";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_instance_details(
ApplicationInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)/details",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device(device_id)
describe_device(device_id, params::Dict{String,<:Any})
Returns information about a device.
# Arguments
- `device_id`: The device's ID.
"""
function describe_device(DeviceId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET",
"/devices/$(DeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_device(
DeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/devices/$(DeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device_job(job_id)
describe_device_job(job_id, params::Dict{String,<:Any})
Returns information about a device job.
# Arguments
- `job_id`: The job's ID.
"""
function describe_device_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET", "/jobs/$(JobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_device_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_node(node_id)
describe_node(node_id, params::Dict{String,<:Any})
Returns information about a node.
# Arguments
- `node_id`: The node's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OwnerAccount"`: The account ID of the node's owner.
"""
function describe_node(NodeId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET", "/nodes/$(NodeId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_node(
NodeId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/nodes/$(NodeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_node_from_template_job(job_id)
describe_node_from_template_job(job_id, params::Dict{String,<:Any})
Returns information about a job to create a camera stream node.
# Arguments
- `job_id`: The job's ID.
"""
function describe_node_from_template_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/template-job/$(JobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_node_from_template_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/template-job/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_package(package_id)
describe_package(package_id, params::Dict{String,<:Any})
Returns information about a package.
# Arguments
- `package_id`: The package's ID.
"""
function describe_package(PackageId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET",
"/packages/metadata/$(PackageId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_package(
PackageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/packages/metadata/$(PackageId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_package_import_job(job_id)
describe_package_import_job(job_id, params::Dict{String,<:Any})
Returns information about a package import job.
# Arguments
- `job_id`: The job's ID.
"""
function describe_package_import_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/import-jobs/$(JobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_package_import_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/import-jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_package_version(package_id, package_version)
describe_package_version(package_id, package_version, params::Dict{String,<:Any})
Returns information about a package version.
# Arguments
- `package_id`: The version's ID.
- `package_version`: The version's version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OwnerAccount"`: The version's owner account.
- `"PatchVersion"`: The version's patch version.
"""
function describe_package_version(
PackageId, PackageVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/metadata/$(PackageId)/versions/$(PackageVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_package_version(
PackageId,
PackageVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/packages/metadata/$(PackageId)/versions/$(PackageVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_instance_dependencies(application_instance_id)
list_application_instance_dependencies(application_instance_id, params::Dict{String,<:Any})
Returns a list of application instance dependencies.
# Arguments
- `application_instance_id`: The application instance's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of application instance dependencies to return in one
page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_application_instance_dependencies(
ApplicationInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)/package-dependencies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_instance_dependencies(
ApplicationInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)/package-dependencies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_instance_node_instances(application_instance_id)
list_application_instance_node_instances(application_instance_id, params::Dict{String,<:Any})
Returns a list of application node instances.
# Arguments
- `application_instance_id`: The node instances' application instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of node instances to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_application_instance_node_instances(
ApplicationInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)/node-instances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_instance_node_instances(
ApplicationInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/application-instances/$(ApplicationInstanceId)/node-instances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_instances()
list_application_instances(params::Dict{String,<:Any})
Returns a list of application instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deviceId"`: The application instances' device ID.
- `"maxResults"`: The maximum number of application instances to return in one page of
results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
- `"statusFilter"`: Only include instances with a specific status.
"""
function list_application_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET",
"/application-instances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/application-instances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_devices()
list_devices(params::Dict{String,<:Any})
Returns a list of devices.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceAggregatedStatusFilter"`: Filter based on a device's status.
- `"MaxResults"`: The maximum number of devices to return in one page of results.
- `"NameFilter"`: Filter based on device's name. Prefixes supported.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
- `"SortBy"`: The target column to be sorted on. Default column sort is CREATED_TIME.
- `"SortOrder"`: The sorting order for the returned list. SortOrder is DESCENDING by
default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
"""
function list_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET", "/devices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET", "/devices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_devices_jobs()
list_devices_jobs(params::Dict{String,<:Any})
Returns a list of jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceId"`: Filter results by the job's target device ID.
- `"MaxResults"`: The maximum number of device jobs to return in one page of results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_devices_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama("GET", "/jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_devices_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET", "/jobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_node_from_template_jobs()
list_node_from_template_jobs(params::Dict{String,<:Any})
Returns a list of camera stream node jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of node from template jobs to return in one page of
results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_node_from_template_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET",
"/packages/template-job";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_node_from_template_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/template-job",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_nodes()
list_nodes(params::Dict{String,<:Any})
Returns a list of nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"category"`: Search for nodes by category.
- `"maxResults"`: The maximum number of nodes to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
- `"ownerAccount"`: Search for nodes by the account ID of the nodes' owner.
- `"packageName"`: Search for nodes by name.
- `"packageVersion"`: Search for nodes by version.
- `"patchVersion"`: Search for nodes by patch version.
"""
function list_nodes(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama("GET", "/nodes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_nodes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET", "/nodes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_package_import_jobs()
list_package_import_jobs(params::Dict{String,<:Any})
Returns a list of package import jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of package import jobs to return in one page of
results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_package_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET",
"/packages/import-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_package_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/packages/import-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_packages()
list_packages(params::Dict{String,<:Any})
Returns a list of packages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of packages to return in one page of results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"GET", "/packages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_packages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET", "/packages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of tags for a resource.
# Arguments
- `resource_arn`: The resource's ARN.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_device(name)
provision_device(name, params::Dict{String,<:Any})
Creates a device and returns a configuration archive. The configuration archive is a ZIP
file that contains a provisioning certificate that is valid for 5 minutes. Name the
configuration archive certificates-omni_device-name.zip and transfer it to the device
within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port
next to the HDMI output.
# Arguments
- `name`: A name for the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the device.
- `"NetworkingConfiguration"`: A networking configuration for the device.
- `"Tags"`: Tags for the device.
"""
function provision_device(Name; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"POST",
"/devices",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_device(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"POST",
"/devices",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_package_version(package_id, package_version, patch_version)
register_package_version(package_id, package_version, patch_version, params::Dict{String,<:Any})
Registers a package version.
# Arguments
- `package_id`: A package ID.
- `package_version`: A package version.
- `patch_version`: A patch version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MarkLatest"`: Whether to mark the new version as the latest version.
- `"OwnerAccount"`: An owner account.
"""
function register_package_version(
PackageId,
PackageVersion,
PatchVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"PUT",
"/packages/$(PackageId)/versions/$(PackageVersion)/patch/$(PatchVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_package_version(
PackageId,
PackageVersion,
PatchVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"PUT",
"/packages/$(PackageId)/versions/$(PackageVersion)/patch/$(PatchVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_application_instance(application_instance_id)
remove_application_instance(application_instance_id, params::Dict{String,<:Any})
Removes an application instance.
# Arguments
- `application_instance_id`: An application instance ID.
"""
function remove_application_instance(
ApplicationInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"DELETE",
"/application-instances/$(ApplicationInstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_application_instance(
ApplicationInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"DELETE",
"/application-instances/$(ApplicationInstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
signal_application_instance_node_instances(application_instance_id, node_signals)
signal_application_instance_node_instances(application_instance_id, node_signals, params::Dict{String,<:Any})
Signal camera nodes to stop or resume.
# Arguments
- `application_instance_id`: An application instance ID.
- `node_signals`: A list of signals.
"""
function signal_application_instance_node_instances(
ApplicationInstanceId, NodeSignals; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"PUT",
"/application-instances/$(ApplicationInstanceId)/node-signals",
Dict{String,Any}("NodeSignals" => NodeSignals);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function signal_application_instance_node_instances(
ApplicationInstanceId,
NodeSignals,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"PUT",
"/application-instances/$(ApplicationInstanceId)/node-signals",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("NodeSignals" => NodeSignals), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Tags a resource.
# Arguments
- `resource_arn`: The resource's ARN.
- `tags`: Tags for the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a resource.
# Arguments
- `resource_arn`: The resource's ARN.
- `tag_keys`: Tag keys to remove.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return panorama(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_device_metadata(device_id)
update_device_metadata(device_id, params::Dict{String,<:Any})
Updates a device's metadata.
# Arguments
- `device_id`: The device's ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the device.
"""
function update_device_metadata(DeviceId; aws_config::AbstractAWSConfig=global_aws_config())
return panorama(
"PUT",
"/devices/$(DeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_metadata(
DeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return panorama(
"PUT",
"/devices/$(DeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 53822 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: payment_cryptography
using AWS.Compat
using AWS.UUIDs
"""
create_alias(alias_name)
create_alias(alias_name, params::Dict{String,<:Any})
Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.
You can use an alias to identify a key in the console and when you call cryptographic
operations such as EncryptData or DecryptData. You can associate the alias with any key in
the same Amazon Web Services Region. Each alias is associated with only one key at a time,
but a key can have multiple aliases. You can't create an alias without a key. The alias
must be unique in the account and Amazon Web Services Region, but you can create another
alias with the same name in a different Amazon Web Services Region. To change the key
that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias.
These operations don't affect the underlying key. To get the alias that you created, call
ListAliases. Cross-account use: This operation can't be used across different Amazon Web
Services accounts. Related operations: DeleteAlias GetAlias ListAliases
UpdateAlias
# Arguments
- `alias_name`: A friendly name that you can use to refer to a key. An alias must begin
with alias/ followed by a name, for example alias/ExampleAlias. It can contain only
alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Don't
include personal, confidential or sensitive information in this field. This field may be
displayed in plaintext in CloudTrail logs and other output.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeyArn"`: The KeyARN of the key to associate with the alias.
"""
function create_alias(AliasName; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"CreateAlias",
Dict{String,Any}("AliasName" => AliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alias(
AliasName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"CreateAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AliasName" => AliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_key(exportable, key_attributes)
create_key(exportable, key_attributes, params::Dict{String,<:Any})
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. You use
keys for cryptographic functions such as encryption and decryption. In addition to the key
material used in cryptographic operations, an Amazon Web Services Payment Cryptography key
includes metadata such as the key ARN, key usage, key origin, creation date, description,
and key state. When you create a key, you specify both immutable and mutable data about the
key. The immutable data contains key attributes that define the scope and cryptographic
operations that you can perform using the key, for example key class (example:
SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example:
TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about
valid combinations of key attributes, see Understanding key attributes in the Amazon Web
Services Payment Cryptography User Guide. The mutable data contained within a key includes
usage timestamp and key deletion timestamp and can be modified after creation. Amazon Web
Services Payment Cryptography binds key attributes to keys using key blocks when you store
or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped
and never stores or transmits them in the clear. Cross-account use: This operation can't
be used across different Amazon Web Services accounts. Related operations: DeleteKey
GetKey ListKeys
# Arguments
- `exportable`: Specifies whether the key is exportable from the service.
- `key_attributes`: The role of the key, the algorithm it supports, and the cryptographic
operations allowed with the key. This data is immutable after the key is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Specifies whether to enable the key. If the key is enabled, it is activated
for use within the service. If the key is not enabled, then it is created but not
activated. The default value is enabled.
- `"KeyCheckValueAlgorithm"`: The algorithm that Amazon Web Services Payment Cryptography
uses to calculate the key check value (KCV). It is used to validate the key integrity. For
TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key
to be checked and retaining the 3 highest order bytes of the encrypted result. For AES
keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero
and retaining the 3 highest order bytes of the encrypted result.
- `"Tags"`: Assigns one or more tags to the Amazon Web Services Payment Cryptography key.
Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services
Payment Cryptography key, use the TagResource operation. Each tag consists of a tag key and
a tag value. Both the tag key and the tag value are required, but the tag value can be an
empty (null) string. You can't have more than one tag on an Amazon Web Services Payment
Cryptography key with the same tag key. Don't include personal, confidential or sensitive
information in this field. This field may be displayed in plaintext in CloudTrail logs and
other output. Tagging or untagging an Amazon Web Services Payment Cryptography key can
allow or deny permission to the key.
"""
function create_key(
Exportable, KeyAttributes; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"CreateKey",
Dict{String,Any}("Exportable" => Exportable, "KeyAttributes" => KeyAttributes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_key(
Exportable,
KeyAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"CreateKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Exportable" => Exportable, "KeyAttributes" => KeyAttributes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alias(alias_name)
delete_alias(alias_name, params::Dict{String,<:Any})
Deletes the alias, but doesn't affect the underlying key. Each key can have multiple
aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias
of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to
create a new alias. To associate an existing alias with a different key, call UpdateAlias.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: CreateAlias GetAlias ListAliases UpdateAlias
# Arguments
- `alias_name`: A friendly name that you can use to refer Amazon Web Services Payment
Cryptography key. This value must begin with alias/ followed by a name, such as
alias/ExampleAlias.
"""
function delete_alias(AliasName; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"DeleteAlias",
Dict{String,Any}("AliasName" => AliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alias(
AliasName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"DeleteAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AliasName" => AliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_key(key_identifier)
delete_key(key_identifier, params::Dict{String,<:Any})
Deletes the key material and metadata associated with Amazon Web Services Payment
Cryptography key. Key deletion is irreversible. After a key is deleted, you can't perform
cryptographic operations using the key. For example, you can't decrypt data that was
encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may
become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment
Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call
this operation, Amazon Web Services Payment Cryptography disables the specified key but
doesn't delete it until after a waiting period set using DeleteKeyInDays. The default
waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After
the key is deleted, the KeyState is DELETE_COMPLETE. You should delete a key only when you
are sure that you don't need to use it anymore and no other parties are utilizing this key.
If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: RestoreKey StartKeyUsage StopKeyUsage
# Arguments
- `key_identifier`: The KeyARN of the key that is scheduled for deletion.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteKeyInDays"`: The waiting period for key deletion. The default value is seven days.
"""
function delete_key(KeyIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"DeleteKey",
Dict{String,Any}("KeyIdentifier" => KeyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_key(
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"DeleteKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyIdentifier" => KeyIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_key(export_key_identifier, key_material)
export_key(export_key_identifier, key_material, params::Dict{String,<:Any})
Exports a key from Amazon Web Services Payment Cryptography. Amazon Web Services Payment
Cryptography simplifies key exchange by replacing the existing paper-based approach with a
modern electronic approach. With ExportKey you can export symmetric keys using either
symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your
Amazon Web Services Payment Cryptography generated keys with other service partners to
perform cryptographic operations outside of Amazon Web Services Payment Cryptography For
symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31
norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web
Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key
exchange mechanism. Asymmetric key exchange methods are typically used to establish
bi-directional trust between the two parties exhanging keys and are used for initial key
exchange such as Key Encryption Key (KEK). After which you can export working keys using
symmetric method to perform various cryptographic operations within Amazon Web Services
Payment Cryptography. The TR-34 norm is intended for exchanging 3DES keys only and keys are
imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm,
KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap,
you can exchange both 3DES and AES-128 keys. The keys are imported in a
WrappedKeyCryptogram format and you will need to specify the key attributes during import.
You can also use ExportKey functionality to generate and export an IPEK (Initial Pin
Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34
export key exchange. IPEK is generated from BDK (Base Derivation Key) and
ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist
within Amazon Web Services Payment Cryptography and has to be re-generated each time during
export. For key exchange using TR-31 or TR-34 key blocks, you can also export optional
blocks within the key block header which contain additional attribute information about the
key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key
block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict
exportability of the key after export from Amazon Web Services Payment Cryptography. The
OptionalBlocks contain the additional data related to the key. For information on data type
that can be included within optional blocks, refer to ASC X9.143-2022. Data included in
key block headers is signed but transmitted in clear text. Sensitive or confidential
information should not be included in optional blocks. Refer to ASC X9.143-2022 standard
for information on allowed data type. To export initial keys (KEK) or IPEK using TR-34
Using this operation, you can export initial key using TR-34 asymmetric key exchange. You
can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34
terminology, the sending party of the key is called Key Distribution Host (KDH) and the
receiving party of the key is called Key Receiving Device (KRD). During key export process,
KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the
user receiving the key. To initiate TR-34 key export, the KRD must obtain an export token
by calling GetParametersForExport. This operation also generates a key pair for the purpose
of key export, signs the key and returns back the signing public key certificate (also
known as KDH signing certificate) and root certificate chain. The KDH uses the private key
to sign the the export payload and the signing public key certificate is provided to KRD to
verify the signature. The KRD can import the root certificate into its Hardware Security
Module (HSM), as required. The export token and the associated KDH signing certificate
expires after 7 days. Next the KRD generates a key pair for the the purpose of encrypting
the KDH key and provides the public key cerificate (also known as KRD wrapping certificate)
back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services
Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web
Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the
key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock.
For more information on TR-34 key export, see section Exporting symmetric keys in the
Amazon Web Services Payment Cryptography User Guide. Set the following parameters:
ExportAttributes: Specify export attributes in case of IPEK export. This parameter is
optional for KEK export. ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of
IPEK) under export. KeyMaterial: Use Tr34KeyBlock parameters.
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed
the KRD wrapping key certificate. ExportToken: Obtained from KDH by calling
GetParametersForImport. WrappingKeyCertificate: The public key certificate in PEM format
(base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for
encryption of the TR-34 export payload. This certificate must be signed by the root
certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services
Payment Cryptography. When this operation is successful, Amazon Web Services Payment
Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock. To export initial keys
(KEK) or IPEK using RSA Wrap and Unwrap Using this operation, you can export initial key
using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an
asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM
format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import
the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for
RootCertificatePublicKey. Next call ExportKey and set the following parameters:
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed
wrapping key certificate. KeyMaterial: Set to KeyCryptogram. WrappingKeyCertificate:
The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and
signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into
Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component
to unwrap the WrappedKeyCryptogram. When this operation is successful, Amazon Web
Services Payment Cryptography returns the WrappedKeyCryptogram. To export working keys or
IPEK using TR-31 Using this operation, you can export working keys or IPEK using TR-31
symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or
wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. Set the
following parameters: ExportAttributes: Specify export attributes in case of IPEK
export. This parameter is optional for KEK export. ExportKeyIdentifier: The KeyARN of
the KEK or BDK (in case of IPEK) under export. KeyMaterial: Use Tr31KeyBlock parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the
working key or IPEK as a TR-31 WrappedKeyBlock. Cross-account use: This operation can't be
used across different Amazon Web Services accounts. Related operations:
GetParametersForExport ImportKey
# Arguments
- `export_key_identifier`: The KeyARN of the key under export from Amazon Web Services
Payment Cryptography.
- `key_material`: The key block format type, for example, TR-34 or TR-31, to use during key
material export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExportAttributes"`: The attributes for IPEK generation during export.
"""
function export_key(
ExportKeyIdentifier, KeyMaterial; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"ExportKey",
Dict{String,Any}(
"ExportKeyIdentifier" => ExportKeyIdentifier, "KeyMaterial" => KeyMaterial
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_key(
ExportKeyIdentifier,
KeyMaterial,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"ExportKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExportKeyIdentifier" => ExportKeyIdentifier,
"KeyMaterial" => KeyMaterial,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_alias(alias_name)
get_alias(alias_name, params::Dict{String,<:Any})
Gets the Amazon Web Services Payment Cryptography key associated with the alias.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: CreateAlias DeleteAlias ListAliases
UpdateAlias
# Arguments
- `alias_name`: The alias of the Amazon Web Services Payment Cryptography key.
"""
function get_alias(AliasName; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"GetAlias",
Dict{String,Any}("AliasName" => AliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_alias(
AliasName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"GetAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AliasName" => AliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_key(key_identifier)
get_key(key_identifier, params::Dict{String,<:Any})
Gets the key material for an Amazon Web Services Payment Cryptography key, including the
immutable and mutable data specified when the key was created. Cross-account use: This
operation can't be used across different Amazon Web Services accounts. Related operations:
CreateKey DeleteKey ListKeys
# Arguments
- `key_identifier`: The KeyARN of the Amazon Web Services Payment Cryptography key.
"""
function get_key(KeyIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"GetKey",
Dict{String,Any}("KeyIdentifier" => KeyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_key(
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"GetKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyIdentifier" => KeyIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parameters_for_export(key_material_type, signing_key_algorithm)
get_parameters_for_export(key_material_type, signing_key_algorithm, params::Dict{String,<:Any})
Gets the export token and the signing key certificate to initiate a TR-34 key export from
Amazon Web Services Payment Cryptography. The signing key certificate signs the wrapped key
under export within the TR-34 key payload. The export token and signing key certificate
must be in place and operational before calling ExportKey. The export token expires in 7
days. You can use the same export token to export multiple keys from your service account.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: ExportKey GetParametersForImport
# Arguments
- `key_material_type`: The key block format type (for example, TR-34 or TR-31) to use
during key material export. Export token is only required for a TR-34 key export,
TR34_KEY_BLOCK. Export token is not required for TR-31 key export.
- `signing_key_algorithm`: The signing key algorithm to generate a signing key certificate.
This certificate signs the wrapped key under export within the TR-34 key block. RSA_2048 is
the only signing key algorithm allowed.
"""
function get_parameters_for_export(
KeyMaterialType, SigningKeyAlgorithm; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"GetParametersForExport",
Dict{String,Any}(
"KeyMaterialType" => KeyMaterialType,
"SigningKeyAlgorithm" => SigningKeyAlgorithm,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameters_for_export(
KeyMaterialType,
SigningKeyAlgorithm,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"GetParametersForExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyMaterialType" => KeyMaterialType,
"SigningKeyAlgorithm" => SigningKeyAlgorithm,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parameters_for_import(key_material_type, wrapping_key_algorithm)
get_parameters_for_import(key_material_type, wrapping_key_algorithm, params::Dict{String,<:Any})
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. The wrapping key certificate wraps the key under import. The
import token and wrapping key certificate must be in place and operational before calling
ImportKey. The import token expires in 7 days. You can use the same import token to import
multiple keys into your service account. Cross-account use: This operation can't be used
across different Amazon Web Services accounts. Related operations:
GetParametersForExport ImportKey
# Arguments
- `key_material_type`: The method to use for key material import. Import token is only
required for TR-34 WrappedKeyBlock (TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram
(KEY_CRYPTOGRAM). Import token is not required for TR-31, root public key cerificate or
trusted public key certificate.
- `wrapping_key_algorithm`: The wrapping key algorithm to generate a wrapping key
certificate. This certificate wraps the key under import. At this time, RSA_2048 is the
allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072,
RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.
"""
function get_parameters_for_import(
KeyMaterialType, WrappingKeyAlgorithm; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"GetParametersForImport",
Dict{String,Any}(
"KeyMaterialType" => KeyMaterialType,
"WrappingKeyAlgorithm" => WrappingKeyAlgorithm,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameters_for_import(
KeyMaterialType,
WrappingKeyAlgorithm,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"GetParametersForImport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyMaterialType" => KeyMaterialType,
"WrappingKeyAlgorithm" => WrappingKeyAlgorithm,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_public_key_certificate(key_identifier)
get_public_key_certificate(key_identifier, params::Dict{String,<:Any})
Gets the public key certificate of the asymmetric key pair that exists within Amazon Web
Services Payment Cryptography. Unlike the private key of an asymmetric key, which never
leaves Amazon Web Services Payment Cryptography unencrypted, callers with
GetPublicKeyCertificate permission can download the public key certificate of the
asymmetric key. You can share the public key certificate to allow others to encrypt
messages and verify signatures outside of Amazon Web Services Payment Cryptography
Cross-account use: This operation can't be used across different Amazon Web Services
accounts.
# Arguments
- `key_identifier`: The KeyARN of the asymmetric key pair.
"""
function get_public_key_certificate(
KeyIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"GetPublicKeyCertificate",
Dict{String,Any}("KeyIdentifier" => KeyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_public_key_certificate(
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"GetPublicKeyCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyIdentifier" => KeyIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_key(key_material)
import_key(key_material, params::Dict{String,<:Any})
Imports symmetric keys and public key certificates in PEM format (base64 encoded) into
Amazon Web Services Payment Cryptography. Amazon Web Services Payment Cryptography
simplifies key exchange by replacing the existing paper-based approach with a modern
electronic approach. With ImportKey you can import symmetric keys using either symmetric
and asymmetric key exchange mechanisms. For symmetric key exchange, Amazon Web Services
Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And
for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9
TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods
are typically used to establish bi-directional trust between the two parties exhanging keys
and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key
(ZMK). After which you can import working keys using symmetric method to perform various
cryptographic operations within Amazon Web Services Payment Cryptography. The TR-34 norm is
intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format.
Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained
within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128
keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify
the key attributes during import. You can also import a root public key certificate, used
to sign other public key certificates, or a trusted public key certificate under an already
established root public key certificate. To import a public root key certificate You can
also import a root public key certificate, used to sign other public key certificates, or a
trusted public key certificate under an already established root public key certificate.
To import a public root key certificate Using this operation, you can import the public
component (in PEM cerificate format) of your private root key. You can use the imported
public root key certificate for digital signatures, for example signing wrapping key or
signing key in TR-34, within your Amazon Web Services Payment Cryptography account. Set the
following parameters: KeyMaterial: RootCertificatePublicKey KeyClass: PUBLIC_KEY
KeyModesOfUse: Verify KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE
PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the
private root key under import. To import a trusted public key certificate The root
public key certificate must be in place and operational before you import a trusted public
key certificate. Set the following parameters: KeyMaterial: TrustedCertificatePublicKey
CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap,
sign, or encrypt that you will allow the trusted public key certificate to perform.
PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded)
under import. To import initial keys (KEK or ZMK or similar) using TR-34 Using this
operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34
terminology, the sending party of the key is called Key Distribution Host (KDH) and the
receiving party of the key is called Key Receiving Device (KRD). During the key import
process, KDH is the user who initiates the key import and KRD is Amazon Web Services
Payment Cryptography who receives the key. To initiate TR-34 key import, the KDH must
obtain an import token by calling GetParametersForImport. This operation generates an
encryption keypair for the purpose of key import, signs the key and returns back the
wrapping key certificate (also known as KRD wrapping certificate) and the root certificate
chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to
encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and
associated KRD wrapping certificate expires after 7 days. Next the KDH generates a key pair
for the purpose of signing the encrypted KDH key and provides the public certificate of the
signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import
the root certificate chain of the KDH signing certificate by calling ImportKey for
RootCertificatePublicKey. For more information on TR-34 key import, see section Importing
symmetric keys in the Amazon Web Services Payment Cryptography User Guide. Set the
following parameters: KeyMaterial: Use Tr34KeyBlock parameters.
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed
the KDH signing key certificate. ImportToken: Obtained from KRD by calling
GetParametersForImport. WrappedKeyBlock: The TR-34 wrapped key material from KDH. It
contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH
signing private key. This TR-34 key block is typically generated by the KDH Hardware
Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH
signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier)
imported in Amazon Web Services Payment Cryptography. To import initial keys (KEK or ZMK
or similar) using RSA Wrap and Unwrap Using this operation, you can import initial key
using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call
GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token.
This operation also generates an encryption keypair for the purpose of key import, signs
the key and returns back the wrapping key certificate in PEM format (base64 encoded) and
its root certificate chain. The import token and associated KRD wrapping certificate
expires after 7 days. You must trust and install the wrapping certificate and its
certificate chain on the sending HSM and use it to wrap the key under export for
WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM
and provide the ImportToken and KeyAttributes for the key under import. To import working
keys using TR-31 Amazon Web Services Payment Cryptography uses TR-31 symmetric key
exchange norm to import working keys. A KEK must be established within Amazon Web Services
Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31
key import, set the following parameters: KeyMaterial: Use Tr31KeyBlock parameters.
WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import,
encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon
Web Services Payment Cryptography. WrappingKeyIdentifier: The KeyArn of the KEK that
Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: ExportKey GetParametersForImport
# Arguments
- `key_material`: The key or public key certificate type to use during key material import,
for example TR-34 or RootCertificatePublicKey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Specifies whether import key is enabled.
- `"KeyCheckValueAlgorithm"`: The algorithm that Amazon Web Services Payment Cryptography
uses to calculate the key check value (KCV). It is used to validate the key integrity. For
TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key
to be checked and retaining the 3 highest order bytes of the encrypted result. For AES
keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero
and retaining the 3 highest order bytes of the encrypted result.
- `"Tags"`: Assigns one or more tags to the Amazon Web Services Payment Cryptography key.
Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services
Payment Cryptography key, use the TagResource operation. Each tag consists of a tag key and
a tag value. Both the tag key and the tag value are required, but the tag value can be an
empty (null) string. You can't have more than one tag on an Amazon Web Services Payment
Cryptography key with the same tag key. If you specify an existing tag key with a different
tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the
specified one. Don't include personal, confidential or sensitive information in this
field. This field may be displayed in plaintext in CloudTrail logs and other output.
Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny
permission to the key.
"""
function import_key(KeyMaterial; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"ImportKey",
Dict{String,Any}("KeyMaterial" => KeyMaterial);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_key(
KeyMaterial,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"ImportKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyMaterial" => KeyMaterial), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_aliases()
list_aliases(params::Dict{String,<:Any})
Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web
Services Region. You can filter the list of aliases. For more information, see Using
aliases in the Amazon Web Services Payment Cryptography User Guide. This is a paginated
operation, which means that each response might contain only a subset of all the aliases.
When the response contains only a subset of aliases, it includes a NextToken value. Use
this value in a subsequent ListAliases request to get more aliases. When you receive a
response with no NextToken (or an empty or null value), that means there are no more
aliases to get. Cross-account use: This operation can't be used across different Amazon
Web Services accounts. Related operations: CreateAlias DeleteAlias GetAlias
UpdateAlias
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter to specify the maximum number of items to return. When
this value is present, Amazon Web Services Payment Cryptography does not return more than
the specified number of items, but it might return fewer. This value is optional. If you
include a value, it must be between 1 and 100, inclusive. If you do not include a value, it
defaults to 50.
- `"NextToken"`: Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextToken from the truncated response you
just received.
"""
function list_aliases(; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"ListAliases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_aliases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"ListAliases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_keys()
list_keys(params::Dict{String,<:Any})
Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
You can filter the list of keys. This is a paginated operation, which means that each
response might contain only a subset of all the keys. When the response contains only a
subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys
request to get more keys. When you receive a response with no NextToken (or an empty or
null value), that means there are no more keys to get. Cross-account use: This operation
can't be used across different Amazon Web Services accounts. Related operations:
CreateKey DeleteKey GetKey
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeyState"`: The key state of the keys you want to list.
- `"MaxResults"`: Use this parameter to specify the maximum number of items to return. When
this value is present, Amazon Web Services Payment Cryptography does not return more than
the specified number of items, but it might return fewer. This value is optional. If you
include a value, it must be between 1 and 100, inclusive. If you do not include a value, it
defaults to 50.
- `"NextToken"`: Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextToken from the truncated response you
just received.
"""
function list_keys(; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"ListKeys"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_keys(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"ListKeys", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags for an Amazon Web Services resource. This is a paginated operation, which
means that each response might contain only a subset of all the tags. When the response
contains only a subset of tags, it includes a NextToken value. Use this value in a
subsequent ListTagsForResource request to get more tags. When you receive a response with
no NextToken (or an empty or null value), that means there are no more tags to get.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: TagResource UntagResource
# Arguments
- `resource_arn`: The KeyARN of the key whose tags you are getting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter to specify the maximum number of items to return. When
this value is present, Amazon Web Services Payment Cryptography does not return more than
the specified number of items, but it might return fewer. This value is optional. If you
include a value, it must be between 1 and 100, inclusive. If you do not include a value, it
defaults to 50.
- `"NextToken"`: Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextToken from the truncated response you
just received.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_key(key_identifier)
restore_key(key_identifier, params::Dict{String,<:Any})
Cancels a scheduled key deletion during the waiting period. Use this operation to restore a
Key that is scheduled for deletion. During the waiting period, the KeyState is
DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key
will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for
deletePendingTimestamp is removed. Cross-account use: This operation can't be used across
different Amazon Web Services accounts. Related operations: DeleteKey
StartKeyUsage StopKeyUsage
# Arguments
- `key_identifier`: The KeyARN of the key to be restored within Amazon Web Services Payment
Cryptography.
"""
function restore_key(KeyIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"RestoreKey",
Dict{String,Any}("KeyIdentifier" => KeyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_key(
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"RestoreKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyIdentifier" => KeyIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_key_usage(key_identifier)
start_key_usage(key_identifier, params::Dict{String,<:Any})
Enables an Amazon Web Services Payment Cryptography key, which makes it active for
cryptographic operations within Amazon Web Services Payment Cryptography Cross-account
use: This operation can't be used across different Amazon Web Services accounts. Related
operations: StopKeyUsage
# Arguments
- `key_identifier`: The KeyArn of the key.
"""
function start_key_usage(KeyIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"StartKeyUsage",
Dict{String,Any}("KeyIdentifier" => KeyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_key_usage(
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"StartKeyUsage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyIdentifier" => KeyIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_key_usage(key_identifier)
stop_key_usage(key_identifier, params::Dict{String,<:Any})
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within
Amazon Web Services Payment Cryptography. You can use this operation instead of DeleteKey
to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: DeleteKey StartKeyUsage
# Arguments
- `key_identifier`: The KeyArn of the key.
"""
function stop_key_usage(KeyIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"StopKeyUsage",
Dict{String,Any}("KeyIdentifier" => KeyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_key_usage(
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"StopKeyUsage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KeyIdentifier" => KeyIdentifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or edits tags on an Amazon Web Services Payment Cryptography key. Tagging or
untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to
the key. Each tag consists of a tag key and a tag value, both of which are case-sensitive
strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key
and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can
also add tags to an Amazon Web Services Payment Cryptography key when you create it with
CreateKey. Cross-account use: This operation can't be used across different Amazon Web
Services accounts. Related operations: ListTagsForResource UntagResource
# Arguments
- `resource_arn`: The KeyARN of the key whose tags are being updated.
- `tags`: One or more tags. Each tag consists of a tag key and a tag value. The tag value
can be an empty (null) string. You can't have more than one tag on an Amazon Web Services
Payment Cryptography key with the same tag key. If you specify an existing tag key with a
different tag value, Amazon Web Services Payment Cryptography replaces the current tag
value with the new one. Don't include personal, confidential or sensitive information in
this field. This field may be displayed in plaintext in CloudTrail logs and other output.
To use this parameter, you must have TagResource permission in an IAM policy. Don't
include personal, confidential or sensitive information in this field. This field may be
displayed in plaintext in CloudTrail logs and other output.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Deletes a tag from an Amazon Web Services Payment Cryptography key. Tagging or untagging
an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: ListTagsForResource TagResource
# Arguments
- `resource_arn`: The KeyARN of the key whose tags are being removed.
- `tag_keys`: One or more tag keys. Don't include the tag values. If the Amazon Web
Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services
Payment Cryptography doesn't throw an exception or return a response. To confirm that the
operation succeeded, use the ListTagsForResource operation.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return payment_cryptography(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_alias(alias_name)
update_alias(alias_name, params::Dict{String,<:Any})
Associates an existing Amazon Web Services Payment Cryptography alias with a different key.
Each alias is associated with only one Amazon Web Services Payment Cryptography key at a
time, although a key can have multiple aliases. The alias and the Amazon Web Services
Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web
Services Region Cross-account use: This operation can't be used across different Amazon
Web Services accounts. Related operations: CreateAlias DeleteAlias GetAlias
ListAliases
# Arguments
- `alias_name`: The alias whose associated key is changing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeyArn"`: The KeyARN for the key that you are updating or removing from the alias.
"""
function update_alias(AliasName; aws_config::AbstractAWSConfig=global_aws_config())
return payment_cryptography(
"UpdateAlias",
Dict{String,Any}("AliasName" => AliasName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_alias(
AliasName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography(
"UpdateAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AliasName" => AliasName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 41696 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: payment_cryptography_data
using AWS.Compat
using AWS.UUIDs
"""
decrypt_data(cipher_text, decryption_attributes, key_identifier)
decrypt_data(cipher_text, decryption_attributes, key_identifier, params::Dict{String,<:Any})
Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or
derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the
Amazon Web Services Payment Cryptography User Guide. You can use an encryption key
generated within Amazon Web Services Payment Cryptography, or you can import your own
encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse
set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts
the ciphertext using the private component of the asymmetric encryption key pair. For data
encryption outside of Amazon Web Services Payment Cryptography, you can export the public
component of the asymmetric key pair by calling GetPublicCertificate. For symmetric and
DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES
algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES
algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports
RSA. When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8
bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For
RSA, it sould be equal to the key size unless padding is enabled. For information about
valid keys for this operation, see Understanding key attributes and Key types for specific
data operations in the Amazon Web Services Payment Cryptography User Guide. Cross-account
use: This operation can't be used across different Amazon Web Services accounts. Related
operations: EncryptData GetPublicCertificate ImportKey
# Arguments
- `cipher_text`: The ciphertext to decrypt.
- `decryption_attributes`: The encryption key type and attributes for ciphertext decryption.
- `key_identifier`: The keyARN of the encryption key that Amazon Web Services Payment
Cryptography uses for ciphertext decryption.
"""
function decrypt_data(
CipherText,
DecryptionAttributes,
KeyIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/keys/$(KeyIdentifier)/decrypt",
Dict{String,Any}(
"CipherText" => CipherText, "DecryptionAttributes" => DecryptionAttributes
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decrypt_data(
CipherText,
DecryptionAttributes,
KeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/keys/$(KeyIdentifier)/decrypt",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CipherText" => CipherText,
"DecryptionAttributes" => DecryptionAttributes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
encrypt_data(encryption_attributes, key_identifier, plain_text)
encrypt_data(encryption_attributes, key_identifier, plain_text, params::Dict{String,<:Any})
Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or
derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the
Amazon Web Services Payment Cryptography User Guide. You can generate an encryption key
within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your
own encryption key by calling ImportKey. For this operation, the key must have
KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public
component. You can import the public component of an asymmetric key pair created outside
Amazon Web Services Payment Cryptography by calling ImportKey. For symmetric and DUKPT
encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For
EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For
asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. When you use
TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES
DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal
to the key size unless padding is enabled. To encrypt using DUKPT, you must already have a
BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you
can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already
have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.
For information about valid keys for this operation, see Understanding key attributes and
Key types for specific data operations in the Amazon Web Services Payment Cryptography User
Guide. Cross-account use: This operation can't be used across different Amazon Web
Services accounts. Related operations: DecryptData GetPublicCertificate
ImportKey ReEncryptData
# Arguments
- `encryption_attributes`: The encryption key type and attributes for plaintext encryption.
- `key_identifier`: The keyARN of the encryption key that Amazon Web Services Payment
Cryptography uses for plaintext encryption.
- `plain_text`: The plaintext to be encrypted. For encryption using asymmetric keys,
plaintext data length is constrained by encryption key strength that you define in
KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more
information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
"""
function encrypt_data(
EncryptionAttributes,
KeyIdentifier,
PlainText;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/keys/$(KeyIdentifier)/encrypt",
Dict{String,Any}(
"EncryptionAttributes" => EncryptionAttributes, "PlainText" => PlainText
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function encrypt_data(
EncryptionAttributes,
KeyIdentifier,
PlainText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/keys/$(KeyIdentifier)/encrypt",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EncryptionAttributes" => EncryptionAttributes, "PlainText" => PlainText
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_card_validation_data(generation_attributes, key_identifier, primary_account_number)
generate_card_validation_data(generation_attributes, key_identifier, primary_account_number, params::Dict{String,<:Any})
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).
For more information, see Generate card data in the Amazon Web Services Payment
Cryptography User Guide. This operation generates a CVV or CSC value that is printed on a
payment credit or debit card during card production. The CVV or CSC, PAN (Primary Account
Number) and expiration date of the card are required to check its validity during
transaction processing. To begin this operation, a CVK (Card Verification Key) encryption
key is required. You can use CreateKey or ImportKey to establish a CVK within Amazon Web
Services Payment Cryptography. The KeyModesOfUse should be set to Generate and Verify for a
CVK encryption key. For information about valid keys for this operation, see Understanding
key attributes and Key types for specific data operations in the Amazon Web Services
Payment Cryptography User Guide. Cross-account use: This operation can't be used across
different Amazon Web Services accounts. Related operations: ImportKey
VerifyCardValidationData
# Arguments
- `generation_attributes`: The algorithm for generating CVV or CSC values for the card
within Amazon Web Services Payment Cryptography.
- `key_identifier`: The keyARN of the CVK encryption key that Amazon Web Services Payment
Cryptography uses to generate card data.
- `primary_account_number`: The Primary Account Number (PAN), a unique identifier for a
payment credit or debit card that associates the card with a specific account holder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ValidationDataLength"`: The length of the CVV or CSC to be generated. The default value
is 3.
"""
function generate_card_validation_data(
GenerationAttributes,
KeyIdentifier,
PrimaryAccountNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/cardvalidationdata/generate",
Dict{String,Any}(
"GenerationAttributes" => GenerationAttributes,
"KeyIdentifier" => KeyIdentifier,
"PrimaryAccountNumber" => PrimaryAccountNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_card_validation_data(
GenerationAttributes,
KeyIdentifier,
PrimaryAccountNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/cardvalidationdata/generate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GenerationAttributes" => GenerationAttributes,
"KeyIdentifier" => KeyIdentifier,
"PrimaryAccountNumber" => PrimaryAccountNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_mac(generation_attributes, key_identifier, message_data)
generate_mac(generation_attributes, key_identifier, message_data, params::Dict{String,<:Any})
Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment
Cryptography. You can use this operation to authenticate card-related data by using known
data values to generate MAC for data validation between the sending and receiving parties.
This operation uses message data, a secret encryption key and MAC algorithm to generate a
unique MAC value for transmission. The receiving party of the MAC must use the same message
data, secret encryption key and MAC algorithm to reproduce another MAC value for
comparision. You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by
setting generation attributes and algorithm to the associated values. The MAC generation
encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC
generation, and they key must have KeyModesOfUse set to Generate and Verify. For
information about valid keys for this operation, see Understanding key attributes and Key
types for specific data operations in the Amazon Web Services Payment Cryptography User
Guide. Cross-account use: This operation can't be used across different Amazon Web
Services accounts. Related operations: VerifyMac
# Arguments
- `generation_attributes`: The attributes and data values to use for MAC generation within
Amazon Web Services Payment Cryptography.
- `key_identifier`: The keyARN of the MAC generation encryption key.
- `message_data`: The data for which a MAC is under generation. This value must be
hexBinary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MacLength"`: The length of a MAC under generation.
"""
function generate_mac(
GenerationAttributes,
KeyIdentifier,
MessageData;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/mac/generate",
Dict{String,Any}(
"GenerationAttributes" => GenerationAttributes,
"KeyIdentifier" => KeyIdentifier,
"MessageData" => MessageData,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_mac(
GenerationAttributes,
KeyIdentifier,
MessageData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/mac/generate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GenerationAttributes" => GenerationAttributes,
"KeyIdentifier" => KeyIdentifier,
"MessageData" => MessageData,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_pin_data(encryption_key_identifier, generation_attributes, generation_key_identifier, pin_block_format, primary_account_number)
generate_pin_data(encryption_key_identifier, generation_attributes, generation_key_identifier, pin_block_format, primary_account_number, params::Dict{String,<:Any})
Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN
Offset during new card issuance or reissuance. For more information, see Generate PIN data
in the Amazon Web Services Payment Cryptography User Guide. PIN data is never transmitted
in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN,
PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an
EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This
operation uses a separate Pin Verification Key (PVK) for VISA PVV generation. For
information about valid keys for this operation, see Understanding key attributes and Key
types for specific data operations in the Amazon Web Services Payment Cryptography User
Guide. Cross-account use: This operation can't be used across different Amazon Web
Services accounts. Related operations: GenerateCardValidationData TranslatePinData
VerifyPinData
# Arguments
- `encryption_key_identifier`: The keyARN of the PEK that Amazon Web Services Payment
Cryptography uses to encrypt the PIN Block.
- `generation_attributes`: The attributes and values to use for PIN, PVV, or PIN Offset
generation.
- `generation_key_identifier`: The keyARN of the PEK that Amazon Web Services Payment
Cryptography uses for pin data generation.
- `pin_block_format`: The PIN encoding format for pin data generation as specified in ISO
9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3. The
ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block
formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits
in length. The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the
fill digits are random values from 10 to 15.
- `primary_account_number`: The Primary Account Number (PAN), a unique identifier for a
payment credit or debit card that associates the card with a specific account holder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PinDataLength"`: The length of PIN under generation.
"""
function generate_pin_data(
EncryptionKeyIdentifier,
GenerationAttributes,
GenerationKeyIdentifier,
PinBlockFormat,
PrimaryAccountNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/pindata/generate",
Dict{String,Any}(
"EncryptionKeyIdentifier" => EncryptionKeyIdentifier,
"GenerationAttributes" => GenerationAttributes,
"GenerationKeyIdentifier" => GenerationKeyIdentifier,
"PinBlockFormat" => PinBlockFormat,
"PrimaryAccountNumber" => PrimaryAccountNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_pin_data(
EncryptionKeyIdentifier,
GenerationAttributes,
GenerationKeyIdentifier,
PinBlockFormat,
PrimaryAccountNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/pindata/generate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EncryptionKeyIdentifier" => EncryptionKeyIdentifier,
"GenerationAttributes" => GenerationAttributes,
"GenerationKeyIdentifier" => GenerationKeyIdentifier,
"PinBlockFormat" => PinBlockFormat,
"PrimaryAccountNumber" => PrimaryAccountNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
re_encrypt_data(cipher_text, incoming_encryption_attributes, incoming_key_identifier, outgoing_encryption_attributes, outgoing_key_identifier)
re_encrypt_data(cipher_text, incoming_encryption_attributes, incoming_key_identifier, outgoing_encryption_attributes, outgoing_key_identifier, params::Dict{String,<:Any})
Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption Keys. You can
either generate an encryption key within Amazon Web Services Payment Cryptography by
calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for
use with this operation must be in a compatible key state with KeyModesOfUse set to
Encrypt. In asymmetric encryption, ciphertext is encrypted using public component (imported
by calling ImportKey) of the asymmetric key pair created outside of Amazon Web Services
Payment Cryptography. For symmetric and DUKPT encryption, Amazon Web Services Payment
Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web
Services Payment Cryptography supports RSA. To encrypt using DUKPT, a DUKPT key must
already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be
generated by calling CreateKey. For information about valid keys for this operation, see
Understanding key attributes and Key types for specific data operations in the Amazon Web
Services Payment Cryptography User Guide. Cross-account use: This operation can't be used
across different Amazon Web Services accounts. Related operations: DecryptData
EncryptData GetPublicCertificate ImportKey
# Arguments
- `cipher_text`: Ciphertext to be encrypted. The minimum allowed length is 16 bytes and
maximum allowed length is 4096 bytes.
- `incoming_encryption_attributes`: The attributes and values for incoming ciphertext.
- `incoming_key_identifier`: The keyARN of the encryption key of incoming ciphertext data.
- `outgoing_encryption_attributes`: The attributes and values for outgoing ciphertext data
after encryption by Amazon Web Services Payment Cryptography.
- `outgoing_key_identifier`: The keyARN of the encryption key of outgoing ciphertext data
after encryption by Amazon Web Services Payment Cryptography.
"""
function re_encrypt_data(
CipherText,
IncomingEncryptionAttributes,
IncomingKeyIdentifier,
OutgoingEncryptionAttributes,
OutgoingKeyIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/keys/$(IncomingKeyIdentifier)/reencrypt",
Dict{String,Any}(
"CipherText" => CipherText,
"IncomingEncryptionAttributes" => IncomingEncryptionAttributes,
"OutgoingEncryptionAttributes" => OutgoingEncryptionAttributes,
"OutgoingKeyIdentifier" => OutgoingKeyIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function re_encrypt_data(
CipherText,
IncomingEncryptionAttributes,
IncomingKeyIdentifier,
OutgoingEncryptionAttributes,
OutgoingKeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/keys/$(IncomingKeyIdentifier)/reencrypt",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CipherText" => CipherText,
"IncomingEncryptionAttributes" => IncomingEncryptionAttributes,
"OutgoingEncryptionAttributes" => OutgoingEncryptionAttributes,
"OutgoingKeyIdentifier" => OutgoingKeyIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
translate_pin_data(encrypted_pin_block, incoming_key_identifier, incoming_translation_attributes, outgoing_key_identifier, outgoing_translation_attributes)
translate_pin_data(encrypted_pin_block, incoming_key_identifier, incoming_translation_attributes, outgoing_key_identifier, outgoing_translation_attributes, params::Dict{String,<:Any})
Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information,
see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide. PIN
block translation involves changing the encrytion of PIN block from one encryption key to
another encryption key and changing PIN block format from one to another without PIN block
data leaving Amazon Web Services Payment Cryptography. The encryption key transformation
can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for
DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation
type for DUKPT translations. The allowed combinations of PIN block format translations are
guided by PCI. It is important to note that not all encrypted PIN block formats (example,
format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that
requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does
not require a PAN for generation. For information about valid keys for this operation, see
Understanding key attributes and Key types for specific data operations in the Amazon Web
Services Payment Cryptography User Guide. Amazon Web Services Payment Cryptography
currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length.
That is, PAN is the right most 12 digits excluding the check digits. Cross-account use:
This operation can't be used across different Amazon Web Services accounts. Related
operations: GeneratePinData VerifyPinData
# Arguments
- `encrypted_pin_block`: The encrypted PIN block data that Amazon Web Services Payment
Cryptography translates.
- `incoming_key_identifier`: The keyARN of the encryption key under which incoming PIN
block data is encrypted. This key type can be PEK or BDK.
- `incoming_translation_attributes`: The format of the incoming PIN block data for
translation within Amazon Web Services Payment Cryptography.
- `outgoing_key_identifier`: The keyARN of the encryption key for encrypting outgoing PIN
block data. This key type can be PEK or BDK.
- `outgoing_translation_attributes`: The format of the outgoing PIN block data after
translation by Amazon Web Services Payment Cryptography.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncomingDukptAttributes"`: The attributes and values to use for incoming DUKPT
encryption key for PIN block translation.
- `"OutgoingDukptAttributes"`: The attributes and values to use for outgoing DUKPT
encryption key after PIN block translation.
"""
function translate_pin_data(
EncryptedPinBlock,
IncomingKeyIdentifier,
IncomingTranslationAttributes,
OutgoingKeyIdentifier,
OutgoingTranslationAttributes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/pindata/translate",
Dict{String,Any}(
"EncryptedPinBlock" => EncryptedPinBlock,
"IncomingKeyIdentifier" => IncomingKeyIdentifier,
"IncomingTranslationAttributes" => IncomingTranslationAttributes,
"OutgoingKeyIdentifier" => OutgoingKeyIdentifier,
"OutgoingTranslationAttributes" => OutgoingTranslationAttributes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function translate_pin_data(
EncryptedPinBlock,
IncomingKeyIdentifier,
IncomingTranslationAttributes,
OutgoingKeyIdentifier,
OutgoingTranslationAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/pindata/translate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EncryptedPinBlock" => EncryptedPinBlock,
"IncomingKeyIdentifier" => IncomingKeyIdentifier,
"IncomingTranslationAttributes" => IncomingTranslationAttributes,
"OutgoingKeyIdentifier" => OutgoingKeyIdentifier,
"OutgoingTranslationAttributes" => OutgoingTranslationAttributes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_auth_request_cryptogram(auth_request_cryptogram, key_identifier, major_key_derivation_mode, session_key_derivation_attributes, transaction_data)
verify_auth_request_cryptogram(auth_request_cryptogram, key_identifier, major_key_derivation_mode, session_key_derivation_attributes, transaction_data, params::Dict{String,<:Any})
Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization.
For more information, see Verify auth request cryptogram in the Amazon Web Services Payment
Cryptography User Guide. ARQC generation is done outside of Amazon Web Services Payment
Cryptography and is typically generated on a point of sale terminal for an EMV chip card to
obtain payment authorization during transaction time. For ARQC verification, you must first
import the ARQC generated outside of Amazon Web Services Payment Cryptography by calling
ImportKey. This operation uses the imported ARQC and an major encryption key (DUKPT)
created by calling CreateKey to either provide a boolean ARQC verification result or
provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method 2.
The ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and ARPC_METHOD_2 uses
CardStatusUpdate to generate ARPC. For information about valid keys for this operation,
see Understanding key attributes and Key types for specific data operations in the Amazon
Web Services Payment Cryptography User Guide. Cross-account use: This operation can't be
used across different Amazon Web Services accounts. Related operations:
VerifyCardValidationData VerifyPinData
# Arguments
- `auth_request_cryptogram`: The auth request cryptogram imported into Amazon Web Services
Payment Cryptography for ARQC verification using a major encryption key and transaction
data.
- `key_identifier`: The keyARN of the major encryption key that Amazon Web Services Payment
Cryptography uses for ARQC verification.
- `major_key_derivation_mode`: The method to use when deriving the major encryption key for
ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation
mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.
- `session_key_derivation_attributes`: The attributes and values to use for deriving a
session key for ARQC verification within Amazon Web Services Payment Cryptography. The same
attributes were used for ARQC generation outside of Amazon Web Services Payment
Cryptography.
- `transaction_data`: The transaction data that Amazon Web Services Payment Cryptography
uses for ARQC verification. The same transaction is used for ARQC generation outside of
Amazon Web Services Payment Cryptography.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthResponseAttributes"`: The attributes and values for auth request cryptogram
verification. These parameters are required in case using ARPC Method 1 or Method 2 for
ARQC verification.
"""
function verify_auth_request_cryptogram(
AuthRequestCryptogram,
KeyIdentifier,
MajorKeyDerivationMode,
SessionKeyDerivationAttributes,
TransactionData;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/cryptogram/verify",
Dict{String,Any}(
"AuthRequestCryptogram" => AuthRequestCryptogram,
"KeyIdentifier" => KeyIdentifier,
"MajorKeyDerivationMode" => MajorKeyDerivationMode,
"SessionKeyDerivationAttributes" => SessionKeyDerivationAttributes,
"TransactionData" => TransactionData,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_auth_request_cryptogram(
AuthRequestCryptogram,
KeyIdentifier,
MajorKeyDerivationMode,
SessionKeyDerivationAttributes,
TransactionData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/cryptogram/verify",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthRequestCryptogram" => AuthRequestCryptogram,
"KeyIdentifier" => KeyIdentifier,
"MajorKeyDerivationMode" => MajorKeyDerivationMode,
"SessionKeyDerivationAttributes" => SessionKeyDerivationAttributes,
"TransactionData" => TransactionData,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_card_validation_data(key_identifier, primary_account_number, validation_data, verification_attributes)
verify_card_validation_data(key_identifier, primary_account_number, validation_data, verification_attributes, params::Dict{String,<:Any})
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).
For more information, see Verify card data in the Amazon Web Services Payment Cryptography
User Guide. This operation validates the CVV or CSC codes that is printed on a payment
credit or debit card during card payment transaction. The input values are typically
provided as part of an inbound transaction to an issuer or supporting platform partner.
Amazon Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) and
expiration date of the card to check its validity during transaction processing. In this
operation, the CVK (Card Verification Key) encryption key for use with card data
verification is same as the one in used for GenerateCardValidationData. For information
about valid keys for this operation, see Understanding key attributes and Key types for
specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services
accounts. Related operations: GenerateCardValidationData
VerifyAuthRequestCryptogram VerifyPinData
# Arguments
- `key_identifier`: The keyARN of the CVK encryption key that Amazon Web Services Payment
Cryptography uses to verify card data.
- `primary_account_number`: The Primary Account Number (PAN), a unique identifier for a
payment credit or debit card that associates the card with a specific account holder.
- `validation_data`: The CVV or CSC value for use for card data verification within Amazon
Web Services Payment Cryptography.
- `verification_attributes`: The algorithm to use for verification of card data within
Amazon Web Services Payment Cryptography.
"""
function verify_card_validation_data(
KeyIdentifier,
PrimaryAccountNumber,
ValidationData,
VerificationAttributes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/cardvalidationdata/verify",
Dict{String,Any}(
"KeyIdentifier" => KeyIdentifier,
"PrimaryAccountNumber" => PrimaryAccountNumber,
"ValidationData" => ValidationData,
"VerificationAttributes" => VerificationAttributes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_card_validation_data(
KeyIdentifier,
PrimaryAccountNumber,
ValidationData,
VerificationAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/cardvalidationdata/verify",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyIdentifier" => KeyIdentifier,
"PrimaryAccountNumber" => PrimaryAccountNumber,
"ValidationData" => ValidationData,
"VerificationAttributes" => VerificationAttributes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_mac(key_identifier, mac, message_data, verification_attributes)
verify_mac(key_identifier, mac, message_data, verification_attributes, params::Dict{String,<:Any})
Verifies a Message Authentication Code (MAC). You can use this operation to verify MAC for
message data authentication such as . In this operation, you must use the same message
data, secret encryption key and MAC algorithm that was used to generate MAC. You can use
this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes
and algorithm to the associated values. For information about valid keys for this
operation, see Understanding key attributes and Key types for specific data operations in
the Amazon Web Services Payment Cryptography User Guide. Cross-account use: This
operation can't be used across different Amazon Web Services accounts. Related operations:
GenerateMac
# Arguments
- `key_identifier`: The keyARN of the encryption key that Amazon Web Services Payment
Cryptography uses to verify MAC data.
- `mac`: The MAC being verified.
- `message_data`: The data on for which MAC is under verification. This value must be
hexBinary.
- `verification_attributes`: The attributes and data values to use for MAC verification
within Amazon Web Services Payment Cryptography.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MacLength"`: The length of the MAC.
"""
function verify_mac(
KeyIdentifier,
Mac,
MessageData,
VerificationAttributes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/mac/verify",
Dict{String,Any}(
"KeyIdentifier" => KeyIdentifier,
"Mac" => Mac,
"MessageData" => MessageData,
"VerificationAttributes" => VerificationAttributes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_mac(
KeyIdentifier,
Mac,
MessageData,
VerificationAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/mac/verify",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyIdentifier" => KeyIdentifier,
"Mac" => Mac,
"MessageData" => MessageData,
"VerificationAttributes" => VerificationAttributes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_pin_data(encrypted_pin_block, encryption_key_identifier, pin_block_format, primary_account_number, verification_attributes, verification_key_identifier)
verify_pin_data(encrypted_pin_block, encryption_key_identifier, pin_block_format, primary_account_number, verification_attributes, verification_key_identifier, params::Dict{String,<:Any})
Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV
and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment
Cryptography User Guide. This operation verifies PIN data for user payment card. A card
holder PIN data is never transmitted in clear to or from Amazon Web Services Payment
Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset
generation and then encrypts it using PIN Encryption Key (PEK) to create an
EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. For
information about valid keys for this operation, see Understanding key attributes and Key
types for specific data operations in the Amazon Web Services Payment Cryptography User
Guide. Cross-account use: This operation can't be used across different Amazon Web
Services accounts. Related operations: GeneratePinData TranslatePinData
# Arguments
- `encrypted_pin_block`: The encrypted PIN block data that Amazon Web Services Payment
Cryptography verifies.
- `encryption_key_identifier`: The keyARN of the encryption key under which the PIN block
data is encrypted. This key type can be PEK or BDK.
- `pin_block_format`: The PIN encoding format for pin data generation as specified in ISO
9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3. The
ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block
formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits
in length. The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the
fill digits are random values from 10 to 15.
- `primary_account_number`: The Primary Account Number (PAN), a unique identifier for a
payment credit or debit card that associates the card with a specific account holder.
- `verification_attributes`: The attributes and values for PIN data verification.
- `verification_key_identifier`: The keyARN of the PIN verification key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DukptAttributes"`: The attributes and values for the DUKPT encrypted PIN block data.
- `"PinDataLength"`: The length of PIN being verified.
"""
function verify_pin_data(
EncryptedPinBlock,
EncryptionKeyIdentifier,
PinBlockFormat,
PrimaryAccountNumber,
VerificationAttributes,
VerificationKeyIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/pindata/verify",
Dict{String,Any}(
"EncryptedPinBlock" => EncryptedPinBlock,
"EncryptionKeyIdentifier" => EncryptionKeyIdentifier,
"PinBlockFormat" => PinBlockFormat,
"PrimaryAccountNumber" => PrimaryAccountNumber,
"VerificationAttributes" => VerificationAttributes,
"VerificationKeyIdentifier" => VerificationKeyIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_pin_data(
EncryptedPinBlock,
EncryptionKeyIdentifier,
PinBlockFormat,
PrimaryAccountNumber,
VerificationAttributes,
VerificationKeyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return payment_cryptography_data(
"POST",
"/pindata/verify",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EncryptedPinBlock" => EncryptedPinBlock,
"EncryptionKeyIdentifier" => EncryptionKeyIdentifier,
"PinBlockFormat" => PinBlockFormat,
"PrimaryAccountNumber" => PrimaryAccountNumber,
"VerificationAttributes" => VerificationAttributes,
"VerificationKeyIdentifier" => VerificationKeyIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 35666 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pca_connector_ad
using AWS.Compat
using AWS.UUIDs
"""
create_connector(certificate_authority_arn, directory_id, vpc_information)
create_connector(certificate_authority_arn, directory_id, vpc_information, params::Dict{String,<:Any})
Creates a connector between Amazon Web Services Private CA and an Active Directory. You
must specify the private CA, directory ID, and security groups.
# Arguments
- `certificate_authority_arn`: The Amazon Resource Name (ARN) of the certificate authority
being used.
- `directory_id`: The identifier of the Active Directory.
- `vpc_information`: Security group IDs that describe the inbound and outbound rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Idempotency token.
- `"Tags"`: Metadata assigned to a connector consisting of a key-value pair.
"""
function create_connector(
CertificateAuthorityArn,
DirectoryId,
VpcInformation;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/connectors",
Dict{String,Any}(
"CertificateAuthorityArn" => CertificateAuthorityArn,
"DirectoryId" => DirectoryId,
"VpcInformation" => VpcInformation,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector(
CertificateAuthorityArn,
DirectoryId,
VpcInformation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/connectors",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateAuthorityArn" => CertificateAuthorityArn,
"DirectoryId" => DirectoryId,
"VpcInformation" => VpcInformation,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_directory_registration(directory_id)
create_directory_registration(directory_id, params::Dict{String,<:Any})
Creates a directory registration that authorizes communication between Amazon Web Services
Private CA and an Active Directory
# Arguments
- `directory_id`: The identifier of the Active Directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Idempotency token.
- `"Tags"`: Metadata assigned to a directory registration consisting of a key-value pair.
"""
function create_directory_registration(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"POST",
"/directoryRegistrations",
Dict{String,Any}("DirectoryId" => DirectoryId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_directory_registration(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/directoryRegistrations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_principal_name(connector_arn, directory_registration_arn)
create_service_principal_name(connector_arn, directory_registration_arn, params::Dict{String,<:Any})
Creates a service principal name (SPN) for the service account in Active Directory.
Kerberos authentication uses SPNs to associate a service instance with a service sign-in
account.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
- `directory_registration_arn`: The Amazon Resource Name (ARN) that was returned when you
called CreateDirectoryRegistration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Idempotency token.
"""
function create_service_principal_name(
ConnectorArn,
DirectoryRegistrationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames/$(ConnectorArn)",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_principal_name(
ConnectorArn,
DirectoryRegistrationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames/$(ConnectorArn)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template(connector_arn, definition, name)
create_template(connector_arn, definition, name, params::Dict{String,<:Any})
Creates an Active Directory compatible certificate template. The connectors issues
certificates using these templates based on the requester’s Active Directory group
membership.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
- `definition`: Template configuration to define the information included in certificates.
Define certificate validity and renewal periods, certificate request handling and
enrollment options, key usage extensions, application policies, and cryptography settings.
- `name`: Name of the template. The template name must be unique.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Idempotency token.
- `"Tags"`: Metadata assigned to a template consisting of a key-value pair.
"""
function create_template(
ConnectorArn, Definition, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"POST",
"/templates",
Dict{String,Any}(
"ConnectorArn" => ConnectorArn,
"Definition" => Definition,
"Name" => Name,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template(
ConnectorArn,
Definition,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/templates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectorArn" => ConnectorArn,
"Definition" => Definition,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template_group_access_control_entry(access_rights, group_display_name, group_security_identifier, template_arn)
create_template_group_access_control_entry(access_rights, group_display_name, group_security_identifier, template_arn, params::Dict{String,<:Any})
Create a group access control entry. Allow or deny Active Directory groups from enrolling
and/or autoenrolling with the template based on the group security identifiers (SIDs).
# Arguments
- `access_rights`: Allow or deny permissions for an Active Directory group to enroll or
autoenroll certificates for a template.
- `group_display_name`: Name of the Active Directory group. This name does not need to
match the group name in Active Directory.
- `group_security_identifier`: Security identifier (SID) of the group object from Active
Directory. The SID starts with \"S-\".
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Idempotency token.
"""
function create_template_group_access_control_entry(
AccessRights,
GroupDisplayName,
GroupSecurityIdentifier,
TemplateArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/templates/$(TemplateArn)/accessControlEntries",
Dict{String,Any}(
"AccessRights" => AccessRights,
"GroupDisplayName" => GroupDisplayName,
"GroupSecurityIdentifier" => GroupSecurityIdentifier,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template_group_access_control_entry(
AccessRights,
GroupDisplayName,
GroupSecurityIdentifier,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/templates/$(TemplateArn)/accessControlEntries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessRights" => AccessRights,
"GroupDisplayName" => GroupDisplayName,
"GroupSecurityIdentifier" => GroupSecurityIdentifier,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector(connector_arn)
delete_connector(connector_arn, params::Dict{String,<:Any})
Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN)
of the connector that you want to delete. You can find the ARN by calling the
https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action.
Deleting a connector does not deregister your directory with Amazon Web Services Private
CA. You can deregister your directory by calling the
https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistra
tion action.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
"""
function delete_connector(ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"DELETE",
"/connectors/$(ConnectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/connectors/$(ConnectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_directory_registration(directory_registration_arn)
delete_directory_registration(directory_registration_arn, params::Dict{String,<:Any})
Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web
Services Private CA with the directory.
# Arguments
- `directory_registration_arn`: The Amazon Resource Name (ARN) that was returned when you
called CreateDirectoryRegistration.
"""
function delete_directory_registration(
DirectoryRegistrationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"DELETE",
"/directoryRegistrations/$(DirectoryRegistrationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_directory_registration(
DirectoryRegistrationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/directoryRegistrations/$(DirectoryRegistrationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_principal_name(connector_arn, directory_registration_arn)
delete_service_principal_name(connector_arn, directory_registration_arn, params::Dict{String,<:Any})
Deletes the service principal name (SPN) used by a connector to authenticate with your
Active Directory.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
- `directory_registration_arn`: The Amazon Resource Name (ARN) that was returned when you
called CreateDirectoryRegistration.
"""
function delete_service_principal_name(
ConnectorArn,
DirectoryRegistrationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames/$(ConnectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_principal_name(
ConnectorArn,
DirectoryRegistrationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames/$(ConnectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template(template_arn)
delete_template(template_arn, params::Dict{String,<:Any})
Deletes a template. Certificates issued using the template are still valid until they are
revoked or expired.
# Arguments
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
"""
function delete_template(TemplateArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"DELETE",
"/templates/$(TemplateArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/templates/$(TemplateArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template_group_access_control_entry(group_security_identifier, template_arn)
delete_template_group_access_control_entry(group_security_identifier, template_arn, params::Dict{String,<:Any})
Deletes a group access control entry.
# Arguments
- `group_security_identifier`: Security identifier (SID) of the group object from Active
Directory. The SID starts with \"S-\".
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
"""
function delete_template_group_access_control_entry(
GroupSecurityIdentifier, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"DELETE",
"/templates/$(TemplateArn)/accessControlEntries/$(GroupSecurityIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template_group_access_control_entry(
GroupSecurityIdentifier,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/templates/$(TemplateArn)/accessControlEntries/$(GroupSecurityIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connector(connector_arn)
get_connector(connector_arn, params::Dict{String,<:Any})
Lists information about your connector. You specify the connector on input by its ARN
(Amazon Resource Name).
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
"""
function get_connector(ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"GET",
"/connectors/$(ConnectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connector(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/connectors/$(ConnectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_directory_registration(directory_registration_arn)
get_directory_registration(directory_registration_arn, params::Dict{String,<:Any})
A structure that contains information about your directory registration.
# Arguments
- `directory_registration_arn`: The Amazon Resource Name (ARN) that was returned when you
called CreateDirectoryRegistration.
"""
function get_directory_registration(
DirectoryRegistrationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET",
"/directoryRegistrations/$(DirectoryRegistrationArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_directory_registration(
DirectoryRegistrationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/directoryRegistrations/$(DirectoryRegistrationArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_principal_name(connector_arn, directory_registration_arn)
get_service_principal_name(connector_arn, directory_registration_arn, params::Dict{String,<:Any})
Lists the service principal name that the connector uses to authenticate with Active
Directory.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
- `directory_registration_arn`: The Amazon Resource Name (ARN) that was returned when you
called CreateDirectoryRegistration.
"""
function get_service_principal_name(
ConnectorArn,
DirectoryRegistrationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames/$(ConnectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_principal_name(
ConnectorArn,
DirectoryRegistrationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames/$(ConnectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template(template_arn)
get_template(template_arn, params::Dict{String,<:Any})
Retrieves a certificate template that the connector uses to issue certificates from a
private CA.
# Arguments
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
"""
function get_template(TemplateArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"GET",
"/templates/$(TemplateArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/templates/$(TemplateArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template_group_access_control_entry(group_security_identifier, template_arn)
get_template_group_access_control_entry(group_security_identifier, template_arn, params::Dict{String,<:Any})
Retrieves the group access control entries for a template.
# Arguments
- `group_security_identifier`: Security identifier (SID) of the group object from Active
Directory. The SID starts with \"S-\".
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
"""
function get_template_group_access_control_entry(
GroupSecurityIdentifier, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET",
"/templates/$(TemplateArn)/accessControlEntries/$(GroupSecurityIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template_group_access_control_entry(
GroupSecurityIdentifier,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/templates/$(TemplateArn)/accessControlEntries/$(GroupSecurityIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connectors()
list_connectors(params::Dict{String,<:Any})
Lists the connectors that you created by using the
https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter when paginating results to specify the maximum number
of items to return in the response on each page. If additional items exist beyond the
number you specify, the NextToken element is sent in the response. Use this NextToken value
in a subsequent request to retrieve additional items.
- `"NextToken"`: Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of the NextToken
parameter from the response you just received.
"""
function list_connectors(; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"GET", "/connectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET", "/connectors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_directory_registrations()
list_directory_registrations(params::Dict{String,<:Any})
Lists the directory registrations that you created by using the
https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistra
tion action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter when paginating results to specify the maximum number
of items to return in the response on each page. If additional items exist beyond the
number you specify, the NextToken element is sent in the response. Use this NextToken value
in a subsequent request to retrieve additional items.
- `"NextToken"`: Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of the NextToken
parameter from the response you just received.
"""
function list_directory_registrations(; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"GET",
"/directoryRegistrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_directory_registrations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET",
"/directoryRegistrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_principal_names(directory_registration_arn)
list_service_principal_names(directory_registration_arn, params::Dict{String,<:Any})
Lists the service principal names that the connector uses to authenticate with Active
Directory.
# Arguments
- `directory_registration_arn`: The Amazon Resource Name (ARN) that was returned when you
called CreateDirectoryRegistration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter when paginating results to specify the maximum number
of items to return in the response on each page. If additional items exist beyond the
number you specify, the NextToken element is sent in the response. Use this NextToken value
in a subsequent request to retrieve additional items.
- `"NextToken"`: Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of the NextToken
parameter from the response you just received.
"""
function list_service_principal_names(
DirectoryRegistrationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_principal_names(
DirectoryRegistrationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/directoryRegistrations/$(DirectoryRegistrationArn)/servicePrincipalNames",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags, if any, that are associated with your resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that was returned when you created the
resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_group_access_control_entries(template_arn)
list_template_group_access_control_entries(template_arn, params::Dict{String,<:Any})
Lists group access control entries you created.
# Arguments
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter when paginating results to specify the maximum number
of items to return in the response on each page. If additional items exist beyond the
number you specify, the NextToken element is sent in the response. Use this NextToken value
in a subsequent request to retrieve additional items.
- `"NextToken"`: Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of the NextToken
parameter from the response you just received.
"""
function list_template_group_access_control_entries(
TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"GET",
"/templates/$(TemplateArn)/accessControlEntries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_group_access_control_entries(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/templates/$(TemplateArn)/accessControlEntries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates(connector_arn)
list_templates(connector_arn, params::Dict{String,<:Any})
Lists the templates, if any, that are associated with a connector.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateConnector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Use this parameter when paginating results to specify the maximum number
of items to return in the response on each page. If additional items exist beyond the
number you specify, the NextToken element is sent in the response. Use this NextToken value
in a subsequent request to retrieve additional items.
- `"NextToken"`: Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of the NextToken
parameter from the response you just received.
"""
function list_templates(ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"GET",
"/templates",
Dict{String,Any}("ConnectorArn" => ConnectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_templates(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"GET",
"/templates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorArn" => ConnectorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to your resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that was returned when you created the
resource.
- `tags`: Metadata assigned to a directory registration consisting of a key-value pair.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from your resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that was returned when you created the
resource.
- `tag_keys`: Specifies a list of tag keys that you want to remove from the specified
resources.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template(template_arn)
update_template(template_arn, params::Dict{String,<:Any})
Update template configuration to define the information included in certificates.
# Arguments
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Definition"`: Template configuration to define the information included in
certificates. Define certificate validity and renewal periods, certificate request handling
and enrollment options, key usage extensions, application policies, and cryptography
settings.
- `"ReenrollAllCertificateHolders"`: This setting allows the major version of a template to
be increased automatically. All members of Active Directory groups that are allowed to
enroll with a template will receive a new certificate issued using that template.
"""
function update_template(TemplateArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_ad(
"PATCH",
"/templates/$(TemplateArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"PATCH",
"/templates/$(TemplateArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template_group_access_control_entry(group_security_identifier, template_arn)
update_template_group_access_control_entry(group_security_identifier, template_arn, params::Dict{String,<:Any})
Update a group access control entry you created using
CreateTemplateGroupAccessControlEntry.
# Arguments
- `group_security_identifier`: Security identifier (SID) of the group object from Active
Directory. The SID starts with \"S-\".
- `template_arn`: The Amazon Resource Name (ARN) that was returned when you called
CreateTemplate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessRights"`: Allow or deny permissions for an Active Directory group to enroll or
autoenroll certificates for a template.
- `"GroupDisplayName"`: Name of the Active Directory group. This name does not need to
match the group name in Active Directory.
"""
function update_template_group_access_control_entry(
GroupSecurityIdentifier, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_ad(
"PATCH",
"/templates/$(TemplateArn)/accessControlEntries/$(GroupSecurityIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template_group_access_control_entry(
GroupSecurityIdentifier,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_ad(
"PATCH",
"/templates/$(TemplateArn)/accessControlEntries/$(GroupSecurityIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 16705 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pca_connector_scep
using AWS.Compat
using AWS.UUIDs
"""
create_challenge(connector_arn)
create_challenge(connector_arn, params::Dict{String,<:Any})
For general-purpose connectors. Creates a challenge password for the specified connector.
The SCEP protocol uses a challenge password to authenticate a request before issuing a
certificate from a certificate authority (CA). Your SCEP clients include the challenge
password as part of their certificate request to Connector for SCEP. To retrieve the
connector Amazon Resource Names (ARNs) for the connectors in your account, call
ListConnectors. To create additional challenge passwords for the connector, call
CreateChallenge again. We recommend frequently rotating your challenge passwords.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) of the connector that you want to create
a challenge for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Custom string that can be used to distinguish between calls to the
CreateChallenge action. Client tokens for CreateChallenge time out after five minutes.
Therefore, if you call CreateChallenge multiple times with the same client token within
five minutes, Connector for SCEP recognizes that you are requesting only one challenge and
will only respond with one. If you change the client token for each call, Connector for
SCEP recognizes that you are requesting multiple challenge passwords.
- `"Tags"`: The key-value pairs to associate with the resource.
"""
function create_challenge(ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_scep(
"POST",
"/challenges",
Dict{String,Any}("ConnectorArn" => ConnectorArn, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_challenge(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"POST",
"/challenges",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectorArn" => ConnectorArn, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector(certificate_authority_arn)
create_connector(certificate_authority_arn, params::Dict{String,<:Any})
Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate
Authority to your SCEP-compatible devices and mobile device management (MDM) systems.
Before you create a connector, you must complete a set of prerequisites, including creation
of a private certificate authority (CA) to use with this connector. For more information,
see Connector for SCEP prerequisites.
# Arguments
- `certificate_authority_arn`: The Amazon Resource Name (ARN) of the Amazon Web Services
Private Certificate Authority certificate authority to use with this connector. Due to
security vulnerabilities present in the SCEP protocol, we recommend using a private CA
that's dedicated for use with the connector. To retrieve the private CAs associated with
your account, you can call ListCertificateAuthorities using the Amazon Web Services Private
CA API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Custom string that can be used to distinguish between calls to the
CreateChallenge action. Client tokens for CreateChallenge time out after five minutes.
Therefore, if you call CreateChallenge multiple times with the same client token within
five minutes, Connector for SCEP recognizes that you are requesting only one challenge and
will only respond with one. If you change the client token for each call, Connector for
SCEP recognizes that you are requesting multiple challenge passwords.
- `"MobileDeviceManagement"`: If you don't supply a value, by default Connector for SCEP
creates a connector for general-purpose use. A general-purpose connector is designed to
work with clients or endpoints that support the SCEP protocol, except Connector for SCEP
for Microsoft Intune. With connectors for general-purpose use, you manage SCEP challenge
passwords using Connector for SCEP. For information about considerations and limitations
with using Connector for SCEP, see Considerations and Limitations. If you provide an
IntuneConfiguration, Connector for SCEP creates a connector for use with Microsoft Intune,
and you manage the challenge passwords using Microsoft Intune. For more information, see
Using Connector for SCEP for Microsoft Intune.
- `"Tags"`: The key-value pairs to associate with the resource.
"""
function create_connector(
CertificateAuthorityArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"POST",
"/connectors",
Dict{String,Any}(
"CertificateAuthorityArn" => CertificateAuthorityArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector(
CertificateAuthorityArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"POST",
"/connectors",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateAuthorityArn" => CertificateAuthorityArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_challenge(challenge_arn)
delete_challenge(challenge_arn, params::Dict{String,<:Any})
Deletes the specified Challenge.
# Arguments
- `challenge_arn`: The Amazon Resource Name (ARN) of the challenge password to delete.
"""
function delete_challenge(ChallengeArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_scep(
"DELETE",
"/challenges/$(ChallengeArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_challenge(
ChallengeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"DELETE",
"/challenges/$(ChallengeArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector(connector_arn)
delete_connector(connector_arn, params::Dict{String,<:Any})
Deletes the specified Connector. This operation also deletes any challenges associated with
the connector.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) of the connector to delete.
"""
function delete_connector(ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_scep(
"DELETE",
"/connectors/$(ConnectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"DELETE",
"/connectors/$(ConnectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_challenge_metadata(challenge_arn)
get_challenge_metadata(challenge_arn, params::Dict{String,<:Any})
Retrieves the metadata for the specified Challenge.
# Arguments
- `challenge_arn`: The Amazon Resource Name (ARN) of the challenge.
"""
function get_challenge_metadata(
ChallengeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"GET",
"/challengeMetadata/$(ChallengeArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_challenge_metadata(
ChallengeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"GET",
"/challengeMetadata/$(ChallengeArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_challenge_password(challenge_arn)
get_challenge_password(challenge_arn, params::Dict{String,<:Any})
Retrieves the challenge password for the specified Challenge.
# Arguments
- `challenge_arn`: The Amazon Resource Name (ARN) of the challenge.
"""
function get_challenge_password(
ChallengeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"GET",
"/challengePasswords/$(ChallengeArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_challenge_password(
ChallengeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"GET",
"/challengePasswords/$(ChallengeArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connector(connector_arn)
get_connector(connector_arn, params::Dict{String,<:Any})
Retrieves details about the specified Connector. Calling this action returns important
details about the connector, such as the public SCEP URL where your clients can request
certificates.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) of the connector.
"""
function get_connector(ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_scep(
"GET",
"/connectors/$(ConnectorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connector(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"GET",
"/connectors/$(ConnectorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_challenge_metadata(connector_arn)
list_challenge_metadata(connector_arn, params::Dict{String,<:Any})
Retrieves the challenge metadata for the specified ARN.
# Arguments
- `connector_arn`: The Amazon Resource Name (ARN) of the connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that you want Connector for SCEP to return
for this request. If more objects are available, in the response, Connector for SCEP
provides a NextToken value that you can use in a subsequent call to get the next batch of
objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
"""
function list_challenge_metadata(
ConnectorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"GET",
"/challengeMetadata",
Dict{String,Any}("ConnectorArn" => ConnectorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_challenge_metadata(
ConnectorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"GET",
"/challengeMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorArn" => ConnectorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connectors()
list_connectors(params::Dict{String,<:Any})
Lists the connectors belonging to your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that you want Connector for SCEP to return
for this request. If more objects are available, in the response, Connector for SCEP
provides a NextToken value that you can use in a subsequent call to get the next batch of
objects.
- `"NextToken"`: When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the maximum you requested,
Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of
objects, use the token returned from the prior request in your next request.
"""
function list_connectors(; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_scep(
"GET", "/connectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"GET", "/connectors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the tags associated with the specified resource. Tags are key-value pairs that
you can use to categorize and manage your resources, for purposes like billing. For
example, you might set the tag key to \"customer\" and the value to the customer name or
ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50
tags for a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"GET",
"/tags/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to your resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The key-value pairs to associate with the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return pca_connector_scep(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from your resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: Specifies a list of tag keys that you want to remove from the specified
resources.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pca_connector_scep(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pca_connector_scep(
"DELETE",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 115045 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: personalize
using AWS.Compat
using AWS.UUIDs
"""
create_batch_inference_job(job_input, job_name, job_output, role_arn, solution_version_arn)
create_batch_inference_job(job_input, job_name, job_output, role_arn, solution_version_arn, params::Dict{String,<:Any})
Generates batch recommendations based on a list of items or users stored in Amazon S3 and
exports the recommendations to an Amazon S3 bucket. To generate batch recommendations,
specify the ARN of a solution version and an Amazon S3 URI for the input and output data.
For user personalization, popular items, and personalized ranking solutions, the batch
inference job generates a list of recommended items for each user ID in the input file. For
related items solutions, the job generates a list of recommended items for each item ID in
the input file. For more information, see Creating a batch inference job . If you use the
Similar-Items recipe, Amazon Personalize can add descriptive themes to batch
recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the
name of the field that contains item names in the input data. For more information about
generating themes, see Batch recommendations with themes from Content Generator . You
can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
# Arguments
- `job_input`: The Amazon S3 path that leads to the input file to base your recommendations
on. The input material must be in JSON format.
- `job_name`: The name of the batch inference job to create.
- `job_output`: The path to the Amazon S3 bucket where the job's output will be stored.
- `role_arn`: The ARN of the Amazon Identity and Access Management role that has
permissions to read and write to your input and output Amazon S3 buckets respectively.
- `solution_version_arn`: The Amazon Resource Name (ARN) of the solution version that will
be used to generate the batch inference recommendations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"batchInferenceJobConfig"`: The configuration details of a batch inference job.
- `"batchInferenceJobMode"`: The mode of the batch inference job. To generate descriptive
themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want
to generate themes, use the default BATCH_INFERENCE. When you get batch recommendations
with themes, you will incur additional costs. For more information, see Amazon Personalize
pricing.
- `"filterArn"`: The ARN of the filter to apply to the batch inference job. For more
information on using filters, see Filtering batch recommendations.
- `"numResults"`: The number of recommendations to retrieve.
- `"tags"`: A list of tags to apply to the batch inference job.
- `"themeGenerationConfig"`: For theme generation jobs, specify the name of the column in
your Items dataset that contains each item's name.
"""
function create_batch_inference_job(
jobInput,
jobName,
jobOutput,
roleArn,
solutionVersionArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateBatchInferenceJob",
Dict{String,Any}(
"jobInput" => jobInput,
"jobName" => jobName,
"jobOutput" => jobOutput,
"roleArn" => roleArn,
"solutionVersionArn" => solutionVersionArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_batch_inference_job(
jobInput,
jobName,
jobOutput,
roleArn,
solutionVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateBatchInferenceJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"jobInput" => jobInput,
"jobName" => jobName,
"jobOutput" => jobOutput,
"roleArn" => roleArn,
"solutionVersionArn" => solutionVersionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_batch_segment_job(job_input, job_name, job_output, role_arn, solution_version_arn)
create_batch_segment_job(job_input, job_name, job_output, role_arn, solution_version_arn, params::Dict{String,<:Any})
Creates a batch segment job. The operation can handle up to 50 million records and the
input file must be in JSON format. For more information, see Getting batch recommendations
and user segments.
# Arguments
- `job_input`: The Amazon S3 path for the input data used to generate the batch segment job.
- `job_name`: The name of the batch segment job to create.
- `job_output`: The Amazon S3 path for the bucket where the job's output will be stored.
- `role_arn`: The ARN of the Amazon Identity and Access Management role that has
permissions to read and write to your input and output Amazon S3 buckets respectively.
- `solution_version_arn`: The Amazon Resource Name (ARN) of the solution version you want
the batch segment job to use to generate batch segments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterArn"`: The ARN of the filter to apply to the batch segment job. For more
information on using filters, see Filtering batch recommendations.
- `"numResults"`: The number of predicted users generated by the batch segment job for each
line of input data. The maximum number of users per segment is 5 million.
- `"tags"`: A list of tags to apply to the batch segment job.
"""
function create_batch_segment_job(
jobInput,
jobName,
jobOutput,
roleArn,
solutionVersionArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateBatchSegmentJob",
Dict{String,Any}(
"jobInput" => jobInput,
"jobName" => jobName,
"jobOutput" => jobOutput,
"roleArn" => roleArn,
"solutionVersionArn" => solutionVersionArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_batch_segment_job(
jobInput,
jobName,
jobOutput,
roleArn,
solutionVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateBatchSegmentJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"jobInput" => jobInput,
"jobName" => jobName,
"jobOutput" => jobOutput,
"roleArn" => roleArn,
"solutionVersionArn" => solutionVersionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_campaign(name, solution_version_arn)
create_campaign(name, solution_version_arn, params::Dict{String,<:Any})
You incur campaign costs while it is active. To avoid unnecessary costs, make sure to
delete the campaign when you are finished. For information about campaign costs, see Amazon
Personalize pricing. Creates a campaign that deploys a solution version. When a client
calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in
the request. Minimum Provisioned TPS and Auto-Scaling A high minProvisionedTPS will
increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track
your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as
necessary. When you create an Amazon Personalize campaign, you can specify the minimum
provisioned transactions per second (minProvisionedTPS) for the campaign. This is the
baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets
the minimum billing charge for the campaign while it is active. A transaction is a single
GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.
If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the
provisioned capacity up and down, but never below minProvisionedTPS. There's a short time
delay while the capacity is increased that might cause loss of transactions. When your
traffic reduces, capacity returns to the minProvisionedTPS. You are charged for the the
minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS.
The actual TPS is the total number of recommendation requests you make. We recommend
starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics,
and then increase the minProvisionedTPS as necessary. For more information about campaign
costs, see Amazon Personalize pricing. Status A campaign can be in one of the following
states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE
PENDING > DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait
until the status of the campaign is ACTIVE before asking the campaign for recommendations.
Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
# Arguments
- `name`: A name for the new campaign. The campaign name must be unique within your account.
- `solution_version_arn`: The Amazon Resource Name (ARN) of the trained model to deploy
with the campaign. To specify the latest solution version of your solution, specify the ARN
of your solution in SolutionArn/LATEST format. You must use this format if you set
syncWithLatestSolutionVersion to True in the CampaignConfig. To deploy a model that isn't
the latest solution version of your solution, specify the ARN of the solution version.
For more information about automatic campaign updates, see Enabling automatic campaign
updates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"campaignConfig"`: The configuration details of a campaign.
- `"minProvisionedTPS"`: Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS
will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default).
Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as
necessary.
- `"tags"`: A list of tags to apply to the campaign.
"""
function create_campaign(
name, solutionVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"CreateCampaign",
Dict{String,Any}("name" => name, "solutionVersionArn" => solutionVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_campaign(
name,
solutionVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateCampaign",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "solutionVersionArn" => solutionVersionArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_deletion_job(data_source, dataset_group_arn, job_name, role_arn)
create_data_deletion_job(data_source, dataset_group_arn, job_name, role_arn, params::Dict{String,<:Any})
Creates a batch job that deletes all references to specific users from an Amazon
Personalize dataset group in batches. You specify the users to delete in a CSV file of
userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains
on the users’ data and no longer considers the users when generating user segments. For
more information about creating a data deletion job, see Deleting users. Your input file
must be a CSV file with a single USER_ID column that lists the users IDs. For more
information about preparing the CSV file, see Preparing your data deletion file and
uploading it to Amazon S3. To give Amazon Personalize permission to access your input CSV
file of userIds, you must specify an IAM service role that has permission to read from the
data source. This role needs GetObject and ListBucket permissions for the bucket and its
content. These permissions are the same as importing data. For information on granting
access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3
Resources. After you create a job, it can take up to a day to delete all references to
the users from datasets and models. Until the job completes, Amazon Personalize continues
to use the data when training. And if you use a User Segmentation recipe, the users might
appear in user segments. Status A data deletion job can have one of the following
statuses: PENDING > IN_PROGRESS > COMPLETED -or- FAILED To get the status of the
data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon
Resource Name (ARN) of the job. If the status is FAILED, the response includes a
failureReason key, which describes why the job failed. Related APIs
ListDataDeletionJobs DescribeDataDeletionJob
# Arguments
- `data_source`: The Amazon S3 bucket that contains the list of userIds of the users to
delete.
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group that has the
datasets you want to delete records from.
- `job_name`: The name for the data deletion job.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role that has permissions to read
from the Amazon S3 data source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of tags to apply to the data deletion job.
"""
function create_data_deletion_job(
dataSource,
datasetGroupArn,
jobName,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDataDeletionJob",
Dict{String,Any}(
"dataSource" => dataSource,
"datasetGroupArn" => datasetGroupArn,
"jobName" => jobName,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_deletion_job(
dataSource,
datasetGroupArn,
jobName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDataDeletionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataSource" => dataSource,
"datasetGroupArn" => datasetGroupArn,
"jobName" => jobName,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(dataset_group_arn, dataset_type, name, schema_arn)
create_dataset(dataset_group_arn, dataset_type, name, schema_arn, params::Dict{String,<:Any})
Creates an empty dataset and adds it to the specified dataset group. Use
CreateDatasetImportJob to import your training data to a dataset. There are 5 types of
datasets: Item interactions Items Users Action interactions Actions Each
dataset type has an associated schema with required field types. Only the Item interactions
dataset is required in order to train a model (also referred to as creating a solution). A
dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS
> ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status
of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets
DescribeDataset DeleteDataset
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group to add the
dataset to.
- `dataset_type`: The type of dataset. One of the following (case insensitive) values:
Interactions Items Users Actions Action_Interactions
- `name`: The name for the dataset.
- `schema_arn`: The ARN of the schema to associate with the dataset. The schema defines the
dataset fields.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of tags to apply to the dataset.
"""
function create_dataset(
datasetGroupArn,
datasetType,
name,
schemaArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDataset",
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"datasetType" => datasetType,
"name" => name,
"schemaArn" => schemaArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
datasetGroupArn,
datasetType,
name,
schemaArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"datasetType" => datasetType,
"name" => name,
"schemaArn" => schemaArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset_export_job(dataset_arn, job_name, job_output, role_arn)
create_dataset_export_job(dataset_arn, job_name, job_output, role_arn, params::Dict{String,<:Any})
Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon
Personalize to export the training data, you must specify an service-linked IAM role that
gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information,
see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset
export job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS
> ACTIVE -or- CREATE FAILED To get the status of the export job, call
DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export
job. The dataset export is complete when the status shows as ACTIVE. If the status shows as
CREATE FAILED, the response includes a failureReason key, which describes why the job
failed.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset that contains the data to
export.
- `job_name`: The name for the dataset export job.
- `job_output`: The path to the Amazon S3 bucket where the job's output is stored.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM service role that has permissions
to add data to your output Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ingestionMode"`: The data to export, based on how you imported the data. You can choose
to export only BULK data that you imported using a dataset import job, only PUT data that
you imported incrementally (using the console, PutEvents, PutUsers and PutItems
operations), or ALL for both types. The default value is PUT.
- `"tags"`: A list of tags to apply to the dataset export job.
"""
function create_dataset_export_job(
datasetArn,
jobName,
jobOutput,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDatasetExportJob",
Dict{String,Any}(
"datasetArn" => datasetArn,
"jobName" => jobName,
"jobOutput" => jobOutput,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset_export_job(
datasetArn,
jobName,
jobOutput,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDatasetExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetArn" => datasetArn,
"jobName" => jobName,
"jobOutput" => jobOutput,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset_group(name)
create_dataset_group(name, params::Dict{String,<:Any})
Creates an empty dataset group. A dataset group is a container for Amazon Personalize
resources. A dataset group can contain at most three datasets, one for each type of
dataset: Item interactions Items Users Actions Action interactions A dataset
group can be a Domain dataset group, where you specify a domain and use pre-configured
resources like recommenders, or a Custom dataset group, where you use custom resources,
such as a solution with a solution version, that you deploy with a campaign. If you start
with a Domain dataset group, you can still add custom resources such as solutions and
solution versions trained with recipes for custom use cases and deployed with campaigns. A
dataset group can be in one of the following states: CREATE PENDING > CREATE
IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the
dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the
response includes a failureReason key, which describes why the creation failed. You must
wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.
If you specify a KMS key, you must also include an Identity and Access Management (IAM)
role that has permission to access the key. APIs that require a dataset group ARN in the
request CreateDataset CreateEventTracker CreateSolution Related APIs
ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
# Arguments
- `name`: The name for the new dataset group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domain"`: The domain of the dataset group. Specify a domain to create a Domain dataset
group. The domain you specify determines the default schemas for datasets and the use cases
available for recommenders. If you don't specify a domain, you create a Custom dataset
group with solution versions that you deploy with a campaign.
- `"kmsKeyArn"`: The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used
to encrypt the datasets.
- `"roleArn"`: The ARN of the Identity and Access Management (IAM) role that has
permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only
valid when also specifying a KMS key.
- `"tags"`: A list of tags to apply to the dataset group.
"""
function create_dataset_group(name; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"CreateDatasetGroup",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset_group(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"CreateDatasetGroup",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset_import_job(data_source, dataset_arn, job_name, role_arn)
create_dataset_import_job(data_source, dataset_arn, job_name, role_arn, params::Dict{String,<:Any})
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an
Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you
must specify an IAM service role that has permission to read from the data source, as
Amazon Personalize makes a copy of your data and processes it internally. For information
on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon
S3 Resources. If you already created a recommender or deployed a custom solution version
with a campaign, how new bulk records influence recommendations depends on the domain use
case or recipe that you use. For more information, see How new data influences real-time
recommendations. By default, a dataset import job replaces any existing data in the
dataset that you imported in bulk. To add new records without replacing existing data,
specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. Status
A dataset import job can be in one of the following states: CREATE PENDING > CREATE
IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call
DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import
job. The dataset import is complete when the status shows as ACTIVE. If the status shows as
CREATE FAILED, the response includes a failureReason key, which describes why the job
failed. Importing takes time. You must wait until the status shows as ACTIVE before
training a model using the dataset. Related APIs ListDatasetImportJobs
DescribeDatasetImportJob
# Arguments
- `data_source`: The Amazon S3 bucket that contains the training data to import.
- `dataset_arn`: The ARN of the dataset that receives the imported data.
- `job_name`: The name for the dataset import job.
- `role_arn`: The ARN of the IAM role that has permissions to read from the Amazon S3 data
source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"importMode"`: Specify how to add the new records to an existing dataset. The default
import mode is FULL. If you haven't imported bulk records into the dataset previously, you
can only specify FULL. Specify FULL to overwrite all existing bulk data in your dataset.
Data you imported individually is not replaced. Specify INCREMENTAL to append the new
records to the existing data in your dataset. Amazon Personalize replaces any record with
the same ID with the new one.
- `"publishAttributionMetricsToS3"`: If you created a metric attribution, specify whether
to publish metrics for this import job to Amazon S3
- `"tags"`: A list of tags to apply to the dataset import job.
"""
function create_dataset_import_job(
dataSource,
datasetArn,
jobName,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDatasetImportJob",
Dict{String,Any}(
"dataSource" => dataSource,
"datasetArn" => datasetArn,
"jobName" => jobName,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset_import_job(
dataSource,
datasetArn,
jobName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateDatasetImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataSource" => dataSource,
"datasetArn" => datasetArn,
"jobName" => jobName,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_tracker(dataset_group_arn, name)
create_event_tracker(dataset_group_arn, name, params::Dict{String,<:Any})
Creates an event tracker that you use when adding event data to a specified dataset group
using the PutEvents API. Only one event tracker can be associated with a dataset group.
You will get an error if you call CreateEventTracker using the same dataset group as an
existing event tracker. When you create an event tracker, the response includes a tracking
ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize
then appends the event data to the Item interactions dataset of the dataset group you
specify in your event tracker. The event tracker can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING >
DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker.
The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs
ListEventTrackers DescribeEventTracker DeleteEventTracker
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group that receives
the event data.
- `name`: The name for the event tracker.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of tags to apply to the event tracker.
"""
function create_event_tracker(
datasetGroupArn, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"CreateEventTracker",
Dict{String,Any}("datasetGroupArn" => datasetGroupArn, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_tracker(
datasetGroupArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateEventTracker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetGroupArn" => datasetGroupArn, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_filter(dataset_group_arn, filter_expression, name)
create_filter(dataset_group_arn, filter_expression, name, params::Dict{String,<:Any})
Creates a recommendation filter. For more information, see Filtering recommendations and
user segments.
# Arguments
- `dataset_group_arn`: The ARN of the dataset group that the filter will belong to.
- `filter_expression`: The filter expression defines which items are included or excluded
from recommendations. Filter expression must follow specific format rules. For information
about filter expression structure and syntax, see Filter expressions.
- `name`: The name of the filter to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of tags to apply to the filter.
"""
function create_filter(
datasetGroupArn,
filterExpression,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateFilter",
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"filterExpression" => filterExpression,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_filter(
datasetGroupArn,
filterExpression,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"filterExpression" => filterExpression,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_metric_attribution(dataset_group_arn, metrics, metrics_output_config, name)
create_metric_attribution(dataset_group_arn, metrics, metrics_output_config, name, params::Dict{String,<:Any})
Creates a metric attribution. A metric attribution creates reports on the data that you
import into Amazon Personalize. Depending on how you imported the data, you can view
reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of
recommendations.
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the destination dataset group for
the metric attribution.
- `metrics`: A list of metric attributes for the metric attribution. Each metric attribute
specifies an event type to track and a function. Available functions are SUM() or
SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items)
and column to sum as a parameter. For example SUM(Items.PRICE).
- `metrics_output_config`: The output configuration details for the metric attribution.
- `name`: A name for the metric attribution.
"""
function create_metric_attribution(
datasetGroupArn,
metrics,
metricsOutputConfig,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateMetricAttribution",
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"metrics" => metrics,
"metricsOutputConfig" => metricsOutputConfig,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_metric_attribution(
datasetGroupArn,
metrics,
metricsOutputConfig,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateMetricAttribution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"metrics" => metrics,
"metricsOutputConfig" => metricsOutputConfig,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recommender(dataset_group_arn, name, recipe_arn)
create_recommender(dataset_group_arn, name, recipe_arn, params::Dict{String,<:Any})
Creates a recommender with the recipe (a Domain dataset group use case) you specify. You
create recommenders for a Domain dataset group and specify the recommender's Amazon
Resource Name (ARN) when you make a GetRecommendations request. Minimum recommendation
requests per second A high minRecommendationRequestsPerSecond will increase your bill. We
recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your
usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond
as necessary. When you create a recommender, you can configure the recommender's minimum
recommendation requests per second. The minimum recommendation requests per second
(minRecommendationRequestsPerSecond) specifies the baseline recommendation request
throughput provisioned by Amazon Personalize. The default
minRecommendationRequestsPerSecond is 1. A recommendation request is a single
GetRecommendations operation. Request throughput is measured in requests per second and
Amazon Personalize uses your requests per second to derive your requests per hour and the
price of your recommender usage. If your requests per second increases beyond
minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity
up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay
while the capacity is increased that might cause loss of requests. Your bill is the
greater of either the minimum requests per hour (based on
minRecommendationRequestsPerSecond) or the actual number of requests. The actual request
throughput used is calculated as the average requests/second within a one-hour window. We
recommend starting with the default minRecommendationRequestsPerSecond, track your usage
using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
as necessary. Status A recommender can be in one of the following states: CREATE
PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED STOP PENDING > STOP
IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE DELETE
PENDING > DELETE IN_PROGRESS To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the recommender for
recommendations. Related APIs ListRecommenders DescribeRecommender
UpdateRecommender DeleteRecommender
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the destination domain dataset
group for the recommender.
- `name`: The name of the recommender.
- `recipe_arn`: The Amazon Resource Name (ARN) of the recipe that the recommender will use.
For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group
use cases can be used to create a recommender. For information about use cases see Choosing
recommender use cases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"recommenderConfig"`: The configuration details of the recommender.
- `"tags"`: A list of tags to apply to the recommender.
"""
function create_recommender(
datasetGroupArn, name, recipeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"CreateRecommender",
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn, "name" => name, "recipeArn" => recipeArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recommender(
datasetGroupArn,
name,
recipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateRecommender",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetGroupArn" => datasetGroupArn,
"name" => name,
"recipeArn" => recipeArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_schema(name, schema)
create_schema(name, schema, params::Dict{String,<:Any})
Creates an Amazon Personalize schema from the specified schema string. The schema you
create must be in Avro JSON format. Amazon Personalize recognizes three schema variants.
Each schema is associated with a dataset type and has a set of required field and keywords.
If you are creating a schema for a dataset in a Domain dataset group, you provide the
domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs ListSchemas DescribeSchema DeleteSchema
# Arguments
- `name`: The name for the schema.
- `schema`: A schema in Avro JSON format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domain"`: The domain for the schema. If you are creating a schema for a dataset in a
Domain dataset group, specify the domain you chose when you created the Domain dataset
group.
"""
function create_schema(name, schema; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"CreateSchema",
Dict{String,Any}("name" => name, "schema" => schema);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schema(
name,
schema,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "schema" => schema), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_solution(dataset_group_arn, name)
create_solution(dataset_group_arn, name, params::Dict{String,<:Any})
After you create a solution, you can’t change its configuration. By default, all new
solutions use automatic training. With automatic training, you incur training costs while
your solution is active. You can't stop automatic training for a solution. To avoid
unnecessary costs, make sure to delete the solution when you are finished. For information
about training costs, see Amazon Personalize pricing. Creates the configuration for
training a model (creating a solution version). This configuration includes the recipe to
use for model training and optional training configuration, such as columns to use in
training and feature transformation parameters. For more information about configuring a
solution, see Creating and configuring a solution. By default, new solutions use
automatic training to create solution versions every 7 days. You can change the training
frequency. Automatic solution version creation starts one hour after the solution is
ACTIVE. If you manually create a solution version within the hour, the solution skips the
first automatic training. For more information, see Configuring automatic training. To
turn off automatic training, set performAutoTraining to false. If you turn off automatic
training, you must manually create a solution version by calling the CreateSolutionVersion
operation. After training starts, you can get the solution version's Amazon Resource Name
(ARN) with the ListSolutionVersions API operation. To get its status, use the
DescribeSolutionVersion. After training completes you can evaluate model accuracy by
calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it
using CreateCampaign. The campaign provides recommendations to a client through the
GetRecommendations API. Amazon Personalize doesn't support configuring the hpoObjective
for solution hyperparameter optimization at this time. Status A solution can be in one
of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the solution, call
DescribeSolution. If you use manual training, the status must be ACTIVE before you call
CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion
DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group that provides
the training data.
- `name`: The name for the solution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eventType"`: When your have multiple event types (using an EVENT_TYPE schema field),
this parameter specifies which event type (for example, 'click' or 'like') is used for
training the model. If you do not provide an eventType, Amazon Personalize will use all
interactions for training with equal weight regardless of type.
- `"performAutoML"`: We don't recommend enabling automated machine learning. Instead,
match your use case to the available Amazon Personalize recipes. For more information, see
Choosing a recipe. Whether to perform automated machine learning (AutoML). The default is
false. For this case, you must specify recipeArn. When set to true, Amazon Personalize
analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and
hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the
optimal recipe by running tests with different values for the hyperparameters. AutoML
lengthens the training process as compared to selecting a specific recipe.
- `"performAutoTraining"`: Whether the solution uses automatic training to create new
solution versions (trained models). The default is True and the solution automatically
creates new solution versions every 7 days. You can change the training frequency by
specifying a schedulingExpression in the AutoTrainingConfig as part of solution
configuration. For more information about automatic training, see Configuring automatic
training. Automatic solution version creation starts one hour after the solution is
ACTIVE. If you manually create a solution version within the hour, the solution skips the
first automatic training. After training starts, you can get the solution version's
Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status,
use the DescribeSolutionVersion.
- `"performHPO"`: Whether to perform hyperparameter optimization (HPO) on the specified or
selected recipe. The default is false. When performing AutoML, this parameter is always
true and you should not set it to false.
- `"recipeArn"`: The Amazon Resource Name (ARN) of the recipe to use for model training.
This is required when performAutoML is false. For information about different Amazon
Personalize recipes and their ARNs, see Choosing a recipe.
- `"solutionConfig"`: The configuration to use with the solution. When performAutoML is set
to true, Amazon Personalize only evaluates the autoMLConfig section of the solution
configuration. Amazon Personalize doesn't support configuring the hpoObjective at this
time.
- `"tags"`: A list of tags to apply to the solution.
"""
function create_solution(
datasetGroupArn, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"CreateSolution",
Dict{String,Any}("datasetGroupArn" => datasetGroupArn, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_solution(
datasetGroupArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateSolution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetGroupArn" => datasetGroupArn, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_solution_version(solution_arn)
create_solution_version(solution_arn, params::Dict{String,<:Any})
Trains or retrains an active solution in a Custom dataset group. A solution is created
using the CreateSolution operation and must be in the ACTIVE state before calling
CreateSolutionVersion. A new version of the solution is created every time you call this
operation. Status A solution version can be in one of the following states: CREATE
PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED CREATE STOPPING CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows
as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response
includes a failureReason key, which describes why the job failed. Related APIs
ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution
DescribeSolution DeleteSolution
# Arguments
- `solution_arn`: The Amazon Resource Name (ARN) of the solution containing the training
configuration information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the solution version.
- `"tags"`: A list of tags to apply to the solution version.
- `"trainingMode"`: The scope of training to be performed when creating the solution
version. The default is FULL. This creates a completely new model based on the entirety of
the training data from the datasets in your dataset group. If you use
User-Personalization, you can specify a training mode of UPDATE. This updates the model to
consider new items for recommendations. It is not a full retraining. You should still
complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop
automatic updates for the solution version. To resume updates, create a new solution with
training mode set to FULL and deploy it in a campaign. For more information about automatic
updates, see Automatic updates. The UPDATE option can only be used when you already have
an active solution version created from the input solution using the FULL option and the
input solution was trained with the User-Personalization recipe or the legacy
HRNN-Coldstart recipe.
"""
function create_solution_version(
solutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"CreateSolutionVersion",
Dict{String,Any}("solutionArn" => solutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_solution_version(
solutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"CreateSolutionVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("solutionArn" => solutionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_campaign(campaign_arn)
delete_campaign(campaign_arn, params::Dict{String,<:Any})
Removes a campaign by deleting the solution deployment. The solution that the campaign is
based on is not deleted and can be redeployed when needed. A deleted campaign can no longer
be specified in a GetRecommendations request. For information on creating campaigns, see
CreateCampaign.
# Arguments
- `campaign_arn`: The Amazon Resource Name (ARN) of the campaign to delete.
"""
function delete_campaign(campaignArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DeleteCampaign",
Dict{String,Any}("campaignArn" => campaignArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_campaign(
campaignArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteCampaign",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("campaignArn" => campaignArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_arn)
delete_dataset(dataset_arn, params::Dict{String,<:Any})
Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or
SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on
datasets, see CreateDataset.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset to delete.
"""
function delete_dataset(datasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DeleteDataset",
Dict{String,Any}("datasetArn" => datasetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset(
datasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("datasetArn" => datasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset_group(dataset_group_arn)
delete_dataset_group(dataset_group_arn, params::Dict{String,<:Any})
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
All associated event trackers. All associated solutions. All datasets in the dataset
group.
# Arguments
- `dataset_group_arn`: The ARN of the dataset group to delete.
"""
function delete_dataset_group(
datasetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DeleteDatasetGroup",
Dict{String,Any}("datasetGroupArn" => datasetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset_group(
datasetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteDatasetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("datasetGroupArn" => datasetGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_tracker(event_tracker_arn)
delete_event_tracker(event_tracker_arn, params::Dict{String,<:Any})
Deletes the event tracker. Does not delete the dataset from the dataset group. For more
information on event trackers, see CreateEventTracker.
# Arguments
- `event_tracker_arn`: The Amazon Resource Name (ARN) of the event tracker to delete.
"""
function delete_event_tracker(
eventTrackerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DeleteEventTracker",
Dict{String,Any}("eventTrackerArn" => eventTrackerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_tracker(
eventTrackerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteEventTracker",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("eventTrackerArn" => eventTrackerArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_filter(filter_arn)
delete_filter(filter_arn, params::Dict{String,<:Any})
Deletes a filter.
# Arguments
- `filter_arn`: The ARN of the filter to delete.
"""
function delete_filter(filterArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DeleteFilter",
Dict{String,Any}("filterArn" => filterArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_filter(
filterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteFilter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("filterArn" => filterArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_metric_attribution(metric_attribution_arn)
delete_metric_attribution(metric_attribution_arn, params::Dict{String,<:Any})
Deletes a metric attribution.
# Arguments
- `metric_attribution_arn`: The metric attribution's Amazon Resource Name (ARN).
"""
function delete_metric_attribution(
metricAttributionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DeleteMetricAttribution",
Dict{String,Any}("metricAttributionArn" => metricAttributionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_metric_attribution(
metricAttributionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteMetricAttribution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("metricAttributionArn" => metricAttributionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recommender(recommender_arn)
delete_recommender(recommender_arn, params::Dict{String,<:Any})
Deactivates and removes a recommender. A deleted recommender can no longer be specified in
a GetRecommendations request.
# Arguments
- `recommender_arn`: The Amazon Resource Name (ARN) of the recommender to delete.
"""
function delete_recommender(
recommenderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DeleteRecommender",
Dict{String,Any}("recommenderArn" => recommenderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recommender(
recommenderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteRecommender",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("recommenderArn" => recommenderArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schema(schema_arn)
delete_schema(schema_arn, params::Dict{String,<:Any})
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the
schema. For more information on schemas, see CreateSchema.
# Arguments
- `schema_arn`: The Amazon Resource Name (ARN) of the schema to delete.
"""
function delete_schema(schemaArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DeleteSchema",
Dict{String,Any}("schemaArn" => schemaArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schema(
schemaArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("schemaArn" => schemaArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_solution(solution_arn)
delete_solution(solution_arn, params::Dict{String,<:Any})
Deletes all versions of a solution and the Solution object itself. Before deleting a
solution, you must delete all campaigns based on the solution. To determine what campaigns
are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the
solution. You can't delete a solution if an associated SolutionVersion is in the CREATE
PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
# Arguments
- `solution_arn`: The ARN of the solution to delete.
"""
function delete_solution(solutionArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DeleteSolution",
Dict{String,Any}("solutionArn" => solutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_solution(
solutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DeleteSolution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("solutionArn" => solutionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_algorithm(algorithm_arn)
describe_algorithm(algorithm_arn, params::Dict{String,<:Any})
Describes the given algorithm.
# Arguments
- `algorithm_arn`: The Amazon Resource Name (ARN) of the algorithm to describe.
"""
function describe_algorithm(algorithmArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeAlgorithm",
Dict{String,Any}("algorithmArn" => algorithmArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_algorithm(
algorithmArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeAlgorithm",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("algorithmArn" => algorithmArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_batch_inference_job(batch_inference_job_arn)
describe_batch_inference_job(batch_inference_job_arn, params::Dict{String,<:Any})
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN),
status, input and output configurations, and the ARN of the solution version used to
generate the recommendations.
# Arguments
- `batch_inference_job_arn`: The ARN of the batch inference job to describe.
"""
function describe_batch_inference_job(
batchInferenceJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeBatchInferenceJob",
Dict{String,Any}("batchInferenceJobArn" => batchInferenceJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_batch_inference_job(
batchInferenceJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeBatchInferenceJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("batchInferenceJobArn" => batchInferenceJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_batch_segment_job(batch_segment_job_arn)
describe_batch_segment_job(batch_segment_job_arn, params::Dict{String,<:Any})
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
status, input and output configurations, and the ARN of the solution version used to
generate segments.
# Arguments
- `batch_segment_job_arn`: The ARN of the batch segment job to describe.
"""
function describe_batch_segment_job(
batchSegmentJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeBatchSegmentJob",
Dict{String,Any}("batchSegmentJobArn" => batchSegmentJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_batch_segment_job(
batchSegmentJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeBatchSegmentJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("batchSegmentJobArn" => batchSegmentJobArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_campaign(campaign_arn)
describe_campaign(campaign_arn, params::Dict{String,<:Any})
Describes the given campaign, including its status. A campaign can be in one of the
following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED, the response
includes the failureReason key, which describes why. For more information on campaigns, see
CreateCampaign.
# Arguments
- `campaign_arn`: The Amazon Resource Name (ARN) of the campaign.
"""
function describe_campaign(campaignArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeCampaign",
Dict{String,Any}("campaignArn" => campaignArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_campaign(
campaignArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeCampaign",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("campaignArn" => campaignArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_deletion_job(data_deletion_job_arn)
describe_data_deletion_job(data_deletion_job_arn, params::Dict{String,<:Any})
Describes the data deletion job created by CreateDataDeletionJob, including the job status.
# Arguments
- `data_deletion_job_arn`: The Amazon Resource Name (ARN) of the data deletion job.
"""
function describe_data_deletion_job(
dataDeletionJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeDataDeletionJob",
Dict{String,Any}("dataDeletionJobArn" => dataDeletionJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_deletion_job(
dataDeletionJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeDataDeletionJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("dataDeletionJobArn" => dataDeletionJobArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_arn)
describe_dataset(dataset_arn, params::Dict{String,<:Any})
Describes the given dataset. For more information on datasets, see CreateDataset.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset to describe.
"""
function describe_dataset(datasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeDataset",
Dict{String,Any}("datasetArn" => datasetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset(
datasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("datasetArn" => datasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset_export_job(dataset_export_job_arn)
describe_dataset_export_job(dataset_export_job_arn, params::Dict{String,<:Any})
Describes the dataset export job created by CreateDatasetExportJob, including the export
job status.
# Arguments
- `dataset_export_job_arn`: The Amazon Resource Name (ARN) of the dataset export job to
describe.
"""
function describe_dataset_export_job(
datasetExportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeDatasetExportJob",
Dict{String,Any}("datasetExportJobArn" => datasetExportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset_export_job(
datasetExportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeDatasetExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetExportJobArn" => datasetExportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset_group(dataset_group_arn)
describe_dataset_group(dataset_group_arn, params::Dict{String,<:Any})
Describes the given dataset group. For more information on dataset groups, see
CreateDatasetGroup.
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group to describe.
"""
function describe_dataset_group(
datasetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeDatasetGroup",
Dict{String,Any}("datasetGroupArn" => datasetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset_group(
datasetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeDatasetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("datasetGroupArn" => datasetGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset_import_job(dataset_import_job_arn)
describe_dataset_import_job(dataset_import_job_arn, params::Dict{String,<:Any})
Describes the dataset import job created by CreateDatasetImportJob, including the import
job status.
# Arguments
- `dataset_import_job_arn`: The Amazon Resource Name (ARN) of the dataset import job to
describe.
"""
function describe_dataset_import_job(
datasetImportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeDatasetImportJob",
Dict{String,Any}("datasetImportJobArn" => datasetImportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset_import_job(
datasetImportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeDatasetImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetImportJobArn" => datasetImportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_tracker(event_tracker_arn)
describe_event_tracker(event_tracker_arn, params::Dict{String,<:Any})
Describes an event tracker. The response includes the trackingId and status of the event
tracker. For more information on event trackers, see CreateEventTracker.
# Arguments
- `event_tracker_arn`: The Amazon Resource Name (ARN) of the event tracker to describe.
"""
function describe_event_tracker(
eventTrackerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeEventTracker",
Dict{String,Any}("eventTrackerArn" => eventTrackerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_event_tracker(
eventTrackerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeEventTracker",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("eventTrackerArn" => eventTrackerArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_feature_transformation(feature_transformation_arn)
describe_feature_transformation(feature_transformation_arn, params::Dict{String,<:Any})
Describes the given feature transformation.
# Arguments
- `feature_transformation_arn`: The Amazon Resource Name (ARN) of the feature
transformation to describe.
"""
function describe_feature_transformation(
featureTransformationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeFeatureTransformation",
Dict{String,Any}("featureTransformationArn" => featureTransformationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_feature_transformation(
featureTransformationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeFeatureTransformation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("featureTransformationArn" => featureTransformationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_filter(filter_arn)
describe_filter(filter_arn, params::Dict{String,<:Any})
Describes a filter's properties.
# Arguments
- `filter_arn`: The ARN of the filter to describe.
"""
function describe_filter(filterArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeFilter",
Dict{String,Any}("filterArn" => filterArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_filter(
filterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeFilter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("filterArn" => filterArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metric_attribution(metric_attribution_arn)
describe_metric_attribution(metric_attribution_arn, params::Dict{String,<:Any})
Describes a metric attribution.
# Arguments
- `metric_attribution_arn`: The metric attribution's Amazon Resource Name (ARN).
"""
function describe_metric_attribution(
metricAttributionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeMetricAttribution",
Dict{String,Any}("metricAttributionArn" => metricAttributionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metric_attribution(
metricAttributionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeMetricAttribution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("metricAttributionArn" => metricAttributionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recipe(recipe_arn)
describe_recipe(recipe_arn, params::Dict{String,<:Any})
Describes a recipe. A recipe contains three items: An algorithm that trains a model.
Hyperparameters that govern the training. Feature transformation information for
modifying the input data before training. Amazon Personalize provides a set of predefined
recipes. You specify a recipe when you create a solution with the CreateSolution API.
CreateSolution trains a model by using the algorithm in the specified recipe and a training
dataset. The solution, when deployed as a campaign, can provide recommendations using the
GetRecommendations API.
# Arguments
- `recipe_arn`: The Amazon Resource Name (ARN) of the recipe to describe.
"""
function describe_recipe(recipeArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeRecipe",
Dict{String,Any}("recipeArn" => recipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_recipe(
recipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeRecipe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("recipeArn" => recipeArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recommender(recommender_arn)
describe_recommender(recommender_arn, params::Dict{String,<:Any})
Describes the given recommender, including its status. A recommender can be in one of the
following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS
> ACTIVE DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED,
the response includes the failureReason key, which describes why. The modelMetrics key is
null when the recommender is being created or deleted. For more information on
recommenders, see CreateRecommender.
# Arguments
- `recommender_arn`: The Amazon Resource Name (ARN) of the recommender to describe.
"""
function describe_recommender(
recommenderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeRecommender",
Dict{String,Any}("recommenderArn" => recommenderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_recommender(
recommenderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeRecommender",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("recommenderArn" => recommenderArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_schema(schema_arn)
describe_schema(schema_arn, params::Dict{String,<:Any})
Describes a schema. For more information on schemas, see CreateSchema.
# Arguments
- `schema_arn`: The Amazon Resource Name (ARN) of the schema to retrieve.
"""
function describe_schema(schemaArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeSchema",
Dict{String,Any}("schemaArn" => schemaArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_schema(
schemaArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("schemaArn" => schemaArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_solution(solution_arn)
describe_solution(solution_arn, params::Dict{String,<:Any})
Describes a solution. For more information on solutions, see CreateSolution.
# Arguments
- `solution_arn`: The Amazon Resource Name (ARN) of the solution to describe.
"""
function describe_solution(solutionArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"DescribeSolution",
Dict{String,Any}("solutionArn" => solutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_solution(
solutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeSolution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("solutionArn" => solutionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_solution_version(solution_version_arn)
describe_solution_version(solution_version_arn, params::Dict{String,<:Any})
Describes a specific version of a solution. For more information on solutions, see
CreateSolution
# Arguments
- `solution_version_arn`: The Amazon Resource Name (ARN) of the solution version.
"""
function describe_solution_version(
solutionVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"DescribeSolutionVersion",
Dict{String,Any}("solutionVersionArn" => solutionVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_solution_version(
solutionVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"DescribeSolutionVersion",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("solutionVersionArn" => solutionVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_solution_metrics(solution_version_arn)
get_solution_metrics(solution_version_arn, params::Dict{String,<:Any})
Gets the metrics for the specified solution version.
# Arguments
- `solution_version_arn`: The Amazon Resource Name (ARN) of the solution version for which
to get metrics.
"""
function get_solution_metrics(
solutionVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"GetSolutionMetrics",
Dict{String,Any}("solutionVersionArn" => solutionVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_solution_metrics(
solutionVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"GetSolutionMetrics",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("solutionVersionArn" => solutionVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_inference_jobs()
list_batch_inference_jobs(params::Dict{String,<:Any})
Gets a list of the batch inference jobs that have been performed off of a solution version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of batch inference job results to return in each page.
The default value is 100.
- `"nextToken"`: The token to request the next page of results.
- `"solutionVersionArn"`: The Amazon Resource Name (ARN) of the solution version from which
the batch inference jobs were created.
"""
function list_batch_inference_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListBatchInferenceJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_batch_inference_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListBatchInferenceJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_segment_jobs()
list_batch_segment_jobs(params::Dict{String,<:Any})
Gets a list of the batch segment jobs that have been performed off of a solution version
that you specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of batch segment job results to return in each page.
The default value is 100.
- `"nextToken"`: The token to request the next page of results.
- `"solutionVersionArn"`: The Amazon Resource Name (ARN) of the solution version that the
batch segment jobs used to generate batch segments.
"""
function list_batch_segment_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListBatchSegmentJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_batch_segment_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListBatchSegmentJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_campaigns()
list_campaigns(params::Dict{String,<:Any})
Returns a list of campaigns that use the given solution. When a solution is not specified,
all the campaigns associated with the account are listed. The response provides the
properties for each campaign, including the Amazon Resource Name (ARN). For more
information on campaigns, see CreateCampaign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of campaigns to return.
- `"nextToken"`: A token returned from the previous call to ListCampaigns for getting the
next set of campaigns (if they exist).
- `"solutionArn"`: The Amazon Resource Name (ARN) of the solution to list the campaigns
for. When a solution is not specified, all the campaigns associated with the account are
listed.
"""
function list_campaigns(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListCampaigns"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_campaigns(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListCampaigns", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_data_deletion_jobs()
list_data_deletion_jobs(params::Dict{String,<:Any})
Returns a list of data deletion jobs for a dataset group ordered by creation time, with the
most recent first. When a dataset group is not specified, all the data deletion jobs
associated with the account are listed. The response provides the properties for each job,
including the Amazon Resource Name (ARN). For more information on data deletion jobs, see
Deleting users.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The Amazon Resource Name (ARN) of the dataset group to list data
deletion jobs for.
- `"maxResults"`: The maximum number of data deletion jobs to return.
- `"nextToken"`: A token returned from the previous call to ListDataDeletionJobs for
getting the next set of jobs (if they exist).
"""
function list_data_deletion_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListDataDeletionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_data_deletion_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListDataDeletionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dataset_export_jobs()
list_dataset_export_jobs(params::Dict{String,<:Any})
Returns a list of dataset export jobs that use the given dataset. When a dataset is not
specified, all the dataset export jobs associated with the account are listed. The response
provides the properties for each dataset export job, including the Amazon Resource Name
(ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more
information on datasets, see CreateDataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetArn"`: The Amazon Resource Name (ARN) of the dataset to list the dataset export
jobs for.
- `"maxResults"`: The maximum number of dataset export jobs to return.
- `"nextToken"`: A token returned from the previous call to ListDatasetExportJobs for
getting the next set of dataset export jobs (if they exist).
"""
function list_dataset_export_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListDatasetExportJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_dataset_export_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListDatasetExportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dataset_groups()
list_dataset_groups(params::Dict{String,<:Any})
Returns a list of dataset groups. The response provides the properties for each dataset
group, including the Amazon Resource Name (ARN). For more information on dataset groups,
see CreateDatasetGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of dataset groups to return.
- `"nextToken"`: A token returned from the previous call to ListDatasetGroups for getting
the next set of dataset groups (if they exist).
"""
function list_dataset_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListDatasetGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_dataset_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListDatasetGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_dataset_import_jobs()
list_dataset_import_jobs(params::Dict{String,<:Any})
Returns a list of dataset import jobs that use the given dataset. When a dataset is not
specified, all the dataset import jobs associated with the account are listed. The response
provides the properties for each dataset import job, including the Amazon Resource Name
(ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more
information on datasets, see CreateDataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetArn"`: The Amazon Resource Name (ARN) of the dataset to list the dataset import
jobs for.
- `"maxResults"`: The maximum number of dataset import jobs to return.
- `"nextToken"`: A token returned from the previous call to ListDatasetImportJobs for
getting the next set of dataset import jobs (if they exist).
"""
function list_dataset_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListDatasetImportJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_dataset_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListDatasetImportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
Returns the list of datasets contained in the given dataset group. The response provides
the properties for each dataset, including the Amazon Resource Name (ARN). For more
information on datasets, see CreateDataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The Amazon Resource Name (ARN) of the dataset group that contains
the datasets to list.
- `"maxResults"`: The maximum number of datasets to return.
- `"nextToken"`: A token returned from the previous call to ListDatasets for getting the
next set of dataset import jobs (if they exist).
"""
function list_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListDatasets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListDatasets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_event_trackers()
list_event_trackers(params::Dict{String,<:Any})
Returns the list of event trackers associated with the account. The response provides the
properties for each event tracker, including the Amazon Resource Name (ARN) and tracking
ID. For more information on event trackers, see CreateEventTracker.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The ARN of a dataset group used to filter the response.
- `"maxResults"`: The maximum number of event trackers to return.
- `"nextToken"`: A token returned from the previous call to ListEventTrackers for getting
the next set of event trackers (if they exist).
"""
function list_event_trackers(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListEventTrackers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_trackers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListEventTrackers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_filters()
list_filters(params::Dict{String,<:Any})
Lists all filters that belong to a given dataset group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The ARN of the dataset group that contains the filters.
- `"maxResults"`: The maximum number of filters to return.
- `"nextToken"`: A token returned from the previous call to ListFilters for getting the
next set of filters (if they exist).
"""
function list_filters(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListFilters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_filters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListFilters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_metric_attribution_metrics()
list_metric_attribution_metrics(params::Dict{String,<:Any})
Lists the metrics for the metric attribution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of metrics to return in one page of results.
- `"metricAttributionArn"`: The Amazon Resource Name (ARN) of the metric attribution to
retrieve attributes for.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_metric_attribution_metrics(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListMetricAttributionMetrics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_metric_attribution_metrics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListMetricAttributionMetrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_metric_attributions()
list_metric_attributions(params::Dict{String,<:Any})
Lists metric attributions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The metric attributions' dataset group Amazon Resource Name (ARN).
- `"maxResults"`: The maximum number of metric attributions to return in one page of
results.
- `"nextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_metric_attributions(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListMetricAttributions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_metric_attributions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListMetricAttributions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recipes()
list_recipes(params::Dict{String,<:Any})
Returns a list of available recipes. The response provides the properties for each recipe,
including the recipe's Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domain"`: Filters returned recipes by domain for a Domain dataset group. Only recipes
(Domain dataset group use cases) for this domain are included in the response. If you don't
specify a domain, all recipes are returned.
- `"maxResults"`: The maximum number of recipes to return.
- `"nextToken"`: A token returned from the previous call to ListRecipes for getting the
next set of recipes (if they exist).
- `"recipeProvider"`: The default is SERVICE.
"""
function list_recipes(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListRecipes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recipes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListRecipes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_recommenders()
list_recommenders(params::Dict{String,<:Any})
Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group
is not specified, all the recommenders associated with the account are listed. The response
provides the properties for each recommender, including the Amazon Resource Name (ARN). For
more information on recommenders, see CreateRecommender.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The Amazon Resource Name (ARN) of the Domain dataset group to list
the recommenders for. When a Domain dataset group is not specified, all the recommenders
associated with the account are listed.
- `"maxResults"`: The maximum number of recommenders to return.
- `"nextToken"`: A token returned from the previous call to ListRecommenders for getting
the next set of recommenders (if they exist).
"""
function list_recommenders(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListRecommenders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recommenders(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListRecommenders", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_schemas()
list_schemas(params::Dict{String,<:Any})
Returns the list of schemas associated with the account. The response provides the
properties for each schema, including the Amazon Resource Name (ARN). For more information
on schemas, see CreateSchema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of schemas to return.
- `"nextToken"`: A token returned from the previous call to ListSchemas for getting the
next set of schemas (if they exist).
"""
function list_schemas(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListSchemas"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_schemas(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListSchemas", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_solution_versions()
list_solution_versions(params::Dict{String,<:Any})
Returns a list of solution versions for the given solution. When a solution is not
specified, all the solution versions associated with the account are listed. The response
provides the properties for each solution version, including the Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of solution versions to return.
- `"nextToken"`: A token returned from the previous call to ListSolutionVersions for
getting the next set of solution versions (if they exist).
- `"solutionArn"`: The Amazon Resource Name (ARN) of the solution.
"""
function list_solution_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListSolutionVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_solution_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListSolutionVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_solutions()
list_solutions(params::Dict{String,<:Any})
Returns a list of solutions in a given dataset group. When a dataset group is not
specified, all the solutions associated with the account are listed. The response provides
the properties for each solution, including the Amazon Resource Name (ARN). For more
information on solutions, see CreateSolution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetGroupArn"`: The Amazon Resource Name (ARN) of the dataset group.
- `"maxResults"`: The maximum number of solutions to return.
- `"nextToken"`: A token returned from the previous call to ListSolutions for getting the
next set of solutions (if they exist).
"""
function list_solutions(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"ListSolutions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_solutions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListSolutions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Get a list of tags attached to a resource.
# Arguments
- `resource_arn`: The resource's Amazon Resource Name (ARN).
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"ListTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_recommender(recommender_arn)
start_recommender(recommender_arn, params::Dict{String,<:Any})
Starts a recommender that is INACTIVE. Starting a recommender does not create any new
models, but resumes billing and automatic retraining for the recommender.
# Arguments
- `recommender_arn`: The Amazon Resource Name (ARN) of the recommender to start.
"""
function start_recommender(
recommenderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"StartRecommender",
Dict{String,Any}("recommenderArn" => recommenderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_recommender(
recommenderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"StartRecommender",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("recommenderArn" => recommenderArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_recommender(recommender_arn)
stop_recommender(recommender_arn, params::Dict{String,<:Any})
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic
retraining for the recommender.
# Arguments
- `recommender_arn`: The Amazon Resource Name (ARN) of the recommender to stop.
"""
function stop_recommender(recommenderArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"StopRecommender",
Dict{String,Any}("recommenderArn" => recommenderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_recommender(
recommenderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"StopRecommender",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("recommenderArn" => recommenderArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_solution_version_creation(solution_version_arn)
stop_solution_version_creation(solution_version_arn, params::Dict{String,<:Any})
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE
IN_PROGRESS. Depending on the current state of the solution version, the solution version
state changes as follows: CREATE_PENDING > CREATE_STOPPED or CREATE_IN_PROGRESS >
CREATE_STOPPING > CREATE_STOPPED You are billed for all of the training completed up
until you stop the solution version creation. You cannot resume creating a solution version
once it has been stopped.
# Arguments
- `solution_version_arn`: The Amazon Resource Name (ARN) of the solution version you want
to stop creating.
"""
function stop_solution_version_creation(
solutionVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"StopSolutionVersionCreation",
Dict{String,Any}("solutionVersionArn" => solutionVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_solution_version_creation(
solutionVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"StopSolutionVersionCreation",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("solutionVersionArn" => solutionVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Add a list of tags to a resource.
# Arguments
- `resource_arn`: The resource's Amazon Resource Name (ARN).
- `tags`: Tags to apply to the resource. For more information see Tagging Amazon
Personalize resources.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags that are attached to a resource. For more information, see
Removing tags from Amazon Personalize resources.
# Arguments
- `resource_arn`: The resource's Amazon Resource Name (ARN).
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_campaign(campaign_arn)
update_campaign(campaign_arn, params::Dict{String,<:Any})
Updates a campaign to deploy a retrained solution version with an existing campaign,
change your campaign's minProvisionedTPS, or modify your campaign's configuration. For
example, you can set enableMetadataWithRecommendations to true for an existing campaign.
To update a campaign to start automatically using the latest solution version, specify the
following: For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN)
of your solution in SolutionArn/LATEST format. In the campaignConfig, set
syncWithLatestSolutionVersion to true. To update a campaign, the campaign status must be
ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The
campaign will use the previous solution version and campaign configuration to generate
recommendations until the latest campaign update status is Active. For more information
about updating a campaign, including code samples, see Updating a campaign. For more
information about campaigns, see Creating a campaign.
# Arguments
- `campaign_arn`: The Amazon Resource Name (ARN) of the campaign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"campaignConfig"`: The configuration details of a campaign.
- `"minProvisionedTPS"`: Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS
will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default).
Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as
necessary.
- `"solutionVersionArn"`: The Amazon Resource Name (ARN) of a new model to deploy. To
specify the latest solution version of your solution, specify the ARN of your solution in
SolutionArn/LATEST format. You must use this format if you set
syncWithLatestSolutionVersion to True in the CampaignConfig. To deploy a model that isn't
the latest solution version of your solution, specify the ARN of the solution version.
For more information about automatic campaign updates, see Enabling automatic campaign
updates.
"""
function update_campaign(campaignArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"UpdateCampaign",
Dict{String,Any}("campaignArn" => campaignArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_campaign(
campaignArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"UpdateCampaign",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("campaignArn" => campaignArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dataset(dataset_arn, schema_arn)
update_dataset(dataset_arn, schema_arn, params::Dict{String,<:Any})
Update a dataset to replace its schema with a new or existing one. For more information,
see Replacing a dataset's schema.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset that you want to update.
- `schema_arn`: The Amazon Resource Name (ARN) of the new schema you want use.
"""
function update_dataset(
datasetArn, schemaArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"UpdateDataset",
Dict{String,Any}("datasetArn" => datasetArn, "schemaArn" => schemaArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset(
datasetArn,
schemaArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"UpdateDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetArn" => datasetArn, "schemaArn" => schemaArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_metric_attribution()
update_metric_attribution(params::Dict{String,<:Any})
Updates a metric attribution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addMetrics"`: Add new metric attributes to the metric attribution.
- `"metricAttributionArn"`: The Amazon Resource Name (ARN) for the metric attribution to
update.
- `"metricsOutputConfig"`: An output config for the metric attribution.
- `"removeMetrics"`: Remove metric attributes from the metric attribution.
"""
function update_metric_attribution(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize(
"UpdateMetricAttribution"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_metric_attribution(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"UpdateMetricAttribution",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_recommender(recommender_arn, recommender_config)
update_recommender(recommender_arn, recommender_config, params::Dict{String,<:Any})
Updates the recommender to modify the recommender configuration. If you update the
recommender to modify the columns used in training, Amazon Personalize automatically starts
a full retraining of the models backing your recommender. While the update completes, you
can still get recommendations from the recommender. The recommender uses the previous
configuration until the update completes. To track the status of this update, use the
latestRecommenderUpdate returned in the DescribeRecommender operation.
# Arguments
- `recommender_arn`: The Amazon Resource Name (ARN) of the recommender to modify.
- `recommender_config`: The configuration details of the recommender.
"""
function update_recommender(
recommenderArn, recommenderConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize(
"UpdateRecommender",
Dict{String,Any}(
"recommenderArn" => recommenderArn, "recommenderConfig" => recommenderConfig
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_recommender(
recommenderArn,
recommenderConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize(
"UpdateRecommender",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"recommenderArn" => recommenderArn,
"recommenderConfig" => recommenderConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 7457 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: personalize_events
using AWS.Compat
using AWS.UUIDs
"""
put_action_interactions(action_interactions, tracking_id)
put_action_interactions(action_interactions, tracking_id, params::Dict{String,<:Any})
Records action interaction event data. An action interaction event is an interaction
between a user and an action. For example, a user taking an action, such a enrolling in a
membership program or downloading your app. For more information about recording action
interactions, see Recording action interaction events. For more information about actions
in an Actions dataset, see Actions dataset.
# Arguments
- `action_interactions`: A list of action interaction events from the session.
- `tracking_id`: The ID of your action interaction event tracker. When you create an Action
interactions dataset, Amazon Personalize creates an action interaction event tracker for
you. For more information, see Action interaction event tracker ID.
"""
function put_action_interactions(
actionInteractions, trackingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize_events(
"POST",
"/action-interactions",
Dict{String,Any}(
"actionInteractions" => actionInteractions, "trackingId" => trackingId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_action_interactions(
actionInteractions,
trackingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize_events(
"POST",
"/action-interactions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionInteractions" => actionInteractions, "trackingId" => trackingId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_actions(actions, dataset_arn)
put_actions(actions, dataset_arn, params::Dict{String,<:Any})
Adds one or more actions to an Actions dataset. For more information see Importing actions
individually.
# Arguments
- `actions`: A list of action data.
- `dataset_arn`: The Amazon Resource Name (ARN) of the Actions dataset you are adding the
action or actions to.
"""
function put_actions(actions, datasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return personalize_events(
"POST",
"/actions",
Dict{String,Any}("actions" => actions, "datasetArn" => datasetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_actions(
actions,
datasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize_events(
"POST",
"/actions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("actions" => actions, "datasetArn" => datasetArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_events(event_list, session_id, tracking_id)
put_events(event_list, session_id, tracking_id, params::Dict{String,<:Any})
Records item interaction event data. For more information see Recording item interaction
events.
# Arguments
- `event_list`: A list of event data from the session.
- `session_id`: The session ID associated with the user's visit. Your application generates
the sessionId when a user first visits your website or uses your application. Amazon
Personalize uses the sessionId to associate events with the user before they log in. For
more information, see Recording item interaction events.
- `tracking_id`: The tracking ID for the event. The ID is generated by a call to the
CreateEventTracker API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"userId"`: The user associated with the event.
"""
function put_events(
eventList, sessionId, trackingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize_events(
"POST",
"/events",
Dict{String,Any}(
"eventList" => eventList, "sessionId" => sessionId, "trackingId" => trackingId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_events(
eventList,
sessionId,
trackingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize_events(
"POST",
"/events",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventList" => eventList,
"sessionId" => sessionId,
"trackingId" => trackingId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_items(dataset_arn, items)
put_items(dataset_arn, items, params::Dict{String,<:Any})
Adds one or more items to an Items dataset. For more information see Importing items
individually.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the Items dataset you are adding the
item or items to.
- `items`: A list of item data.
"""
function put_items(datasetArn, items; aws_config::AbstractAWSConfig=global_aws_config())
return personalize_events(
"POST",
"/items",
Dict{String,Any}("datasetArn" => datasetArn, "items" => items);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_items(
datasetArn,
items,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize_events(
"POST",
"/items",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetArn" => datasetArn, "items" => items),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_users(dataset_arn, users)
put_users(dataset_arn, users, params::Dict{String,<:Any})
Adds one or more users to a Users dataset. For more information see Importing users
individually.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the Users dataset you are adding the
user or users to.
- `users`: A list of user data.
"""
function put_users(datasetArn, users; aws_config::AbstractAWSConfig=global_aws_config())
return personalize_events(
"POST",
"/users",
Dict{String,Any}("datasetArn" => datasetArn, "users" => users);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_users(
datasetArn,
users,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize_events(
"POST",
"/users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("datasetArn" => datasetArn, "users" => users),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 10373 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: personalize_runtime
using AWS.Compat
using AWS.UUIDs
"""
get_action_recommendations()
get_action_recommendations(params::Dict{String,<:Any})
Returns a list of recommended actions in sorted in descending order by prediction score.
Use the GetActionRecommendations API if you have a custom campaign that deploys a solution
version trained with a PERSONALIZED_ACTIONS recipe. For more information about
PERSONALIZED_ACTIONS recipes, see PERSONALIZED_ACTIONS recipes. For more information about
getting action recommendations, see Getting action recommendations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"campaignArn"`: The Amazon Resource Name (ARN) of the campaign to use for getting action
recommendations. This campaign must deploy a solution version trained with a
PERSONALIZED_ACTIONS recipe.
- `"filterArn"`: The ARN of the filter to apply to the returned recommendations. For more
information, see Filtering Recommendations. When using this parameter, be sure the filter
resource is ACTIVE.
- `"filterValues"`: The values to use when filtering recommendations. For each placeholder
parameter in your filter expression, provide the parameter name (in matching case) as a key
and the filter value(s) as the corresponding value. Separate multiple values for one
parameter with a comma. For filter expressions that use an INCLUDE element to include
actions, you must provide values for all parameters that are defined in the expression. For
filters with expressions that use an EXCLUDE element to exclude actions, you can omit the
filter-values. In this case, Amazon Personalize doesn't use that portion of the expression
to filter recommendations. For more information, see Filtering recommendations and user
segments.
- `"numResults"`: The number of results to return. The default is 5. The maximum is 100.
- `"userId"`: The user ID of the user to provide action recommendations for.
"""
function get_action_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize_runtime(
"POST",
"/action-recommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_action_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize_runtime(
"POST",
"/action-recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_personalized_ranking(campaign_arn, input_list, user_id)
get_personalized_ranking(campaign_arn, input_list, user_id, params::Dict{String,<:Any})
Re-ranks a list of recommended items for the given user. The first item in the list is
deemed the most likely item to be of interest to the user. The solution backing the
campaign must have been created using a recipe of type PERSONALIZED_RANKING.
# Arguments
- `campaign_arn`: The Amazon Resource Name (ARN) of the campaign to use for generating the
personalized ranking.
- `input_list`: A list of items (by itemId) to rank. If an item was not included in the
training dataset, the item is appended to the end of the reranked list. If you are
including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
- `user_id`: The user for which you want the campaign to provide a personalized ranking.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"context"`: The contextual metadata to use when getting recommendations. Contextual
metadata includes any interaction information that might be relevant when getting a user's
recommendations, such as the user's current location or device type.
- `"filterArn"`: The Amazon Resource Name (ARN) of a filter you created to include items or
exclude items from recommendations for a given user. For more information, see Filtering
Recommendations.
- `"filterValues"`: The values to use when filtering recommendations. For each placeholder
parameter in your filter expression, provide the parameter name (in matching case) as a key
and the filter value(s) as the corresponding value. Separate multiple values for one
parameter with a comma. For filter expressions that use an INCLUDE element to include
items, you must provide values for all parameters that are defined in the expression. For
filters with expressions that use an EXCLUDE element to exclude items, you can omit the
filter-values.In this case, Amazon Personalize doesn't use that portion of the expression
to filter recommendations. For more information, see Filtering Recommendations.
- `"metadataColumns"`: If you enabled metadata in recommendations when you created or
updated the campaign, specify metadata columns from your Items dataset to include in the
personalized ranking. The map key is ITEMS and the value is a list of column names from
your Items dataset. The maximum number of columns you can provide is 10. For information
about enabling metadata for a campaign, see Enabling metadata in recommendations for a
campaign.
"""
function get_personalized_ranking(
campaignArn, inputList, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize_runtime(
"POST",
"/personalize-ranking",
Dict{String,Any}(
"campaignArn" => campaignArn, "inputList" => inputList, "userId" => userId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_personalized_ranking(
campaignArn,
inputList,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return personalize_runtime(
"POST",
"/personalize-ranking",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"campaignArn" => campaignArn,
"inputList" => inputList,
"userId" => userId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendations()
get_recommendations(params::Dict{String,<:Any})
Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name
(ARN) is required and the required user and item input depends on the recipe type used to
create the solution backing the campaign as follows: USER_PERSONALIZATION - userId
required, itemId not used RELATED_ITEMS - itemId required, userId not used Campaigns
that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the
API. For recommenders, the recommender's ARN is required and the required item and user
input depends on the use case (domain-based recipe) backing the recommender. For
information on use case requirements see Choosing recommender use cases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"campaignArn"`: The Amazon Resource Name (ARN) of the campaign to use for getting
recommendations.
- `"context"`: The contextual metadata to use when getting recommendations. Contextual
metadata includes any interaction information that might be relevant when getting a user's
recommendations, such as the user's current location or device type.
- `"filterArn"`: The ARN of the filter to apply to the returned recommendations. For more
information, see Filtering Recommendations. When using this parameter, be sure the filter
resource is ACTIVE.
- `"filterValues"`: The values to use when filtering recommendations. For each placeholder
parameter in your filter expression, provide the parameter name (in matching case) as a key
and the filter value(s) as the corresponding value. Separate multiple values for one
parameter with a comma. For filter expressions that use an INCLUDE element to include
items, you must provide values for all parameters that are defined in the expression. For
filters with expressions that use an EXCLUDE element to exclude items, you can omit the
filter-values.In this case, Amazon Personalize doesn't use that portion of the expression
to filter recommendations. For more information, see Filtering recommendations and user
segments.
- `"itemId"`: The item ID to provide recommendations for. Required for RELATED_ITEMS recipe
type.
- `"metadataColumns"`: If you enabled metadata in recommendations when you created or
updated the campaign or recommender, specify the metadata columns from your Items dataset
to include in item recommendations. The map key is ITEMS and the value is a list of column
names from your Items dataset. The maximum number of columns you can provide is 10. For
information about enabling metadata for a campaign, see Enabling metadata in
recommendations for a campaign. For information about enabling metadata for a recommender,
see Enabling metadata in recommendations for a recommender.
- `"numResults"`: The number of results to return. The default is 25. If you are including
metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
- `"promotions"`: The promotions to apply to the recommendation request. A promotion
defines additional business rules that apply to a configurable subset of recommended items.
- `"recommenderArn"`: The Amazon Resource Name (ARN) of the recommender to use to get
recommendations. Provide a recommender ARN if you created a Domain dataset group with a
recommender for a domain use case.
- `"userId"`: The user ID to provide recommendations for. Required for USER_PERSONALIZATION
recipe type.
"""
function get_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return personalize_runtime(
"POST", "/recommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return personalize_runtime(
"POST",
"/recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 35027 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pi
using AWS.Compat
using AWS.UUIDs
"""
create_performance_analysis_report(end_time, identifier, service_type, start_time)
create_performance_analysis_report(end_time, identifier, service_type, start_time, params::Dict{String,<:Any})
Creates a new performance analysis report for a specific time period for the DB instance.
# Arguments
- `end_time`: The end time defined for the analysis report.
- `identifier`: An immutable, Amazon Web Services Region-unique identifier for a data
source. Performance Insights gathers metrics from this data source. To use an Amazon RDS
instance as a data source, you specify its DbiResourceId value. For example, specify
db-ADECBTYHKTSAUMUZQYPDS2GW4A.
- `service_type`: The Amazon Web Services service for which Performance Insights will
return metrics. Valid value is RDS.
- `start_time`: The start time defined for the analysis report.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The metadata assigned to the analysis report consisting of a key-value pair.
"""
function create_performance_analysis_report(
EndTime,
Identifier,
ServiceType,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"CreatePerformanceAnalysisReport",
Dict{String,Any}(
"EndTime" => EndTime,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_performance_analysis_report(
EndTime,
Identifier,
ServiceType,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"CreatePerformanceAnalysisReport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_performance_analysis_report(analysis_report_id, identifier, service_type)
delete_performance_analysis_report(analysis_report_id, identifier, service_type, params::Dict{String,<:Any})
Deletes a performance analysis report.
# Arguments
- `analysis_report_id`: The unique identifier of the analysis report for deletion.
- `identifier`: An immutable identifier for a data source that is unique for an Amazon Web
Services Region. Performance Insights gathers metrics from this data source. In the
console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the
identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its
DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
- `service_type`: The Amazon Web Services service for which Performance Insights will
return metrics. Valid value is RDS.
"""
function delete_performance_analysis_report(
AnalysisReportId,
Identifier,
ServiceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"DeletePerformanceAnalysisReport",
Dict{String,Any}(
"AnalysisReportId" => AnalysisReportId,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_performance_analysis_report(
AnalysisReportId,
Identifier,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"DeletePerformanceAnalysisReport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnalysisReportId" => AnalysisReportId,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dimension_keys(end_time, group_by, identifier, metric, service_type, start_time)
describe_dimension_keys(end_time, group_by, identifier, metric, service_type, start_time, params::Dict{String,<:Any})
For a specific time period, retrieve the top N dimension keys for a metric. Each response
element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only
the first 500 bytes are returned.
# Arguments
- `end_time`: The date and time specifying the end of the requested time series data. The
value specified is exclusive, which means that data points less than (but not equal to)
EndTime are returned. The value for EndTime must be later than the value for StartTime.
- `group_by`: A specification for how to aggregate the data points from a query result. You
must specify a valid dimension group. Performance Insights returns all dimensions within
this group, unless you provide the names of specific dimensions within this group. You can
also request that Performance Insights return a limited number of values for a dimension.
- `identifier`: An immutable, Amazon Web Services Region-unique identifier for a data
source. Performance Insights gathers metrics from this data source. To use an Amazon RDS
instance as a data source, you specify its DbiResourceId value. For example, specify
db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
- `metric`: The name of a Performance Insights metric to be measured. Valid values for
Metric are: db.load.avg - A scaled representation of the number of active sessions for
the database engine. db.sampledload.avg - The raw number of active sessions for the
database engine. If the number of active sessions is less than an internal Performance
Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of
active sessions is greater than the internal threshold, Performance Insights samples the
active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the
raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query
db.load.avg only.
- `service_type`: The Amazon Web Services service for which Performance Insights will
return metrics. Valid values are as follows: RDS DOCDB
- `start_time`: The date and time specifying the beginning of the requested time series
data. You must specify a StartTime within the past 7 days. The value specified is
inclusive, which means that data points equal to or greater than StartTime are returned.
The value for StartTime must be earlier than the value for EndTime.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalMetrics"`: Additional metrics for the top N dimension keys. If the specified
dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL
metrics to get the values for the top N SQL digests. The response syntax is as follows:
\"AdditionalMetrics\" : { \"string\" : \"string\" }.
- `"Filter"`: One or more filters to apply in the request. Restrictions: Any number of
filters by the same dimension, as specified in the GroupBy or Partition parameters. A
single filter for any other dimension in this dimension group.
- `"MaxResults"`: The maximum number of items to return in the response. If more items
exist than the specified MaxRecords value, a pagination token is included in the response
so that the remaining results can be retrieved.
- `"NextToken"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the token, up to the
value specified by MaxRecords.
- `"PartitionBy"`: For each dimension specified in GroupBy, specify a secondary dimension
to further subdivide the partition keys in the response.
- `"PeriodInSeconds"`: The granularity, in seconds, of the data points returned from
Performance Insights. A period can be as short as one second, or as long as one day (86400
seconds). Valid values are: 1 (one second) 60 (one minute) 300 (five minutes)
3600 (one hour) 86400 (twenty-four hours) If you don't specify PeriodInSeconds, then
Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data
points in the response.
"""
function describe_dimension_keys(
EndTime,
GroupBy,
Identifier,
Metric,
ServiceType,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"DescribeDimensionKeys",
Dict{String,Any}(
"EndTime" => EndTime,
"GroupBy" => GroupBy,
"Identifier" => Identifier,
"Metric" => Metric,
"ServiceType" => ServiceType,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dimension_keys(
EndTime,
GroupBy,
Identifier,
Metric,
ServiceType,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"DescribeDimensionKeys",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"GroupBy" => GroupBy,
"Identifier" => Identifier,
"Metric" => Metric,
"ServiceType" => ServiceType,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dimension_key_details(group, group_identifier, identifier, service_type)
get_dimension_key_details(group, group_identifier, identifier, service_type, params::Dict{String,<:Any})
Get the attributes of the specified dimension group for a DB instance or data source. For
example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the
dimension db.sql.statement associated with this ID. This operation is useful because
GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement
text.
# Arguments
- `group`: The name of the dimension group. Performance Insights searches the specified
group for the dimension group ID. The following group name values are valid: db.query
(Amazon DocumentDB only) db.sql (Amazon RDS and Aurora only)
- `group_identifier`: The ID of the dimension group from which to retrieve dimension
details. For dimension group db.sql, the group ID is db.sql.id. The following group ID
values are valid: db.sql.id for dimension group db.sql (Aurora and RDS only)
db.query.id for dimension group db.query (DocumentDB only)
- `identifier`: The ID for a data source from which to gather dimension data. This ID must
be immutable and unique within an Amazon Web Services Region. When a DB instance is the
data source, specify its DbiResourceId value. For example, specify
db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
- `service_type`: The Amazon Web Services service for which Performance Insights returns
data. The only valid value is RDS.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestedDimensions"`: A list of dimensions to retrieve the detail data for within the
given dimension group. If you don't specify this parameter, Performance Insights returns
all dimension data within the specified dimension group. Specify dimension names for the
following dimension groups: db.sql - Specify either the full dimension name
db.sql.statement or the short dimension name statement (Aurora and RDS only). db.query -
Specify either the full dimension name db.query.statement or the short dimension name
statement (DocumentDB only).
"""
function get_dimension_key_details(
Group,
GroupIdentifier,
Identifier,
ServiceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetDimensionKeyDetails",
Dict{String,Any}(
"Group" => Group,
"GroupIdentifier" => GroupIdentifier,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dimension_key_details(
Group,
GroupIdentifier,
Identifier,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetDimensionKeyDetails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Group" => Group,
"GroupIdentifier" => GroupIdentifier,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_performance_analysis_report(analysis_report_id, identifier, service_type)
get_performance_analysis_report(analysis_report_id, identifier, service_type, params::Dict{String,<:Any})
Retrieves the report including the report ID, status, time details, and the insights with
recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights
include the description and recommendation fields.
# Arguments
- `analysis_report_id`: A unique identifier of the created analysis report. For example,
report-12345678901234567
- `identifier`: An immutable identifier for a data source that is unique for an Amazon Web
Services Region. Performance Insights gathers metrics from this data source. In the
console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the
identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its
DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
- `service_type`: The Amazon Web Services service for which Performance Insights will
return metrics. Valid value is RDS.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The text language in the report. The default language is EN_US
(English).
- `"TextFormat"`: Indicates the text format in the report. The options are PLAIN_TEXT or
MARKDOWN. The default value is plain text.
"""
function get_performance_analysis_report(
AnalysisReportId,
Identifier,
ServiceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetPerformanceAnalysisReport",
Dict{String,Any}(
"AnalysisReportId" => AnalysisReportId,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_performance_analysis_report(
AnalysisReportId,
Identifier,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetPerformanceAnalysisReport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnalysisReportId" => AnalysisReportId,
"Identifier" => Identifier,
"ServiceType" => ServiceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_metadata(identifier, service_type)
get_resource_metadata(identifier, service_type, params::Dict{String,<:Any})
Retrieve the metadata for different features. For example, the metadata might indicate that
a feature is turned on or off on a specific DB instance.
# Arguments
- `identifier`: An immutable identifier for a data source that is unique for an Amazon Web
Services Region. Performance Insights gathers metrics from this data source. To use a DB
instance as a data source, specify its DbiResourceId value. For example, specify
db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
- `service_type`: The Amazon Web Services service for which Performance Insights returns
metrics.
"""
function get_resource_metadata(
Identifier, ServiceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"GetResourceMetadata",
Dict{String,Any}("Identifier" => Identifier, "ServiceType" => ServiceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_metadata(
Identifier,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetResourceMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Identifier" => Identifier, "ServiceType" => ServiceType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_metrics(end_time, identifier, metric_queries, service_type, start_time)
get_resource_metrics(end_time, identifier, metric_queries, service_type, start_time, params::Dict{String,<:Any})
Retrieve Performance Insights metrics for a set of data sources over a time period. You can
provide specific dimension groups and dimensions, and provide filtering criteria for each
group. You must specify an aggregate function for each metric. Each response element
returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first
500 bytes are returned.
# Arguments
- `end_time`: The date and time specifying the end of the requested time series query
range. The value specified is exclusive. Thus, the command returns data points less than
(but not equal to) EndTime. The value for EndTime must be later than the value for
StartTime.
- `identifier`: An immutable identifier for a data source that is unique for an Amazon Web
Services Region. Performance Insights gathers metrics from this data source. In the
console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the
identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its
DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
- `metric_queries`: An array of one or more queries to perform. Each query must specify a
Performance Insights metric and specify an aggregate function, and you can provide
filtering criteria. You must append the aggregate function to the metric. For example, to
find the average for the metric db.load you must use db.load.avg. Valid values for
aggregate functions include .avg, .min, .max, and .sum.
- `service_type`: The Amazon Web Services service for which Performance Insights returns
metrics. Valid values are as follows: RDS DOCDB
- `start_time`: The date and time specifying the beginning of the requested time series
query range. You can't specify a StartTime that is earlier than 7 days ago. By default,
Performance Insights has 7 days of retention, but you can extend this range up to 2 years.
The value specified is inclusive. Thus, the command returns data points equal to or greater
than StartTime. The value for StartTime must be earlier than the value for EndTime.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return in the response. If more items
exist than the specified MaxRecords value, a pagination token is included in the response
so that the remaining results can be retrieved.
- `"NextToken"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the token, up to the
value specified by MaxRecords.
- `"PeriodAlignment"`: The returned timestamp which is the start or end time of the time
periods. The default value is END_TIME.
- `"PeriodInSeconds"`: The granularity, in seconds, of the data points returned from
Performance Insights. A period can be as short as one second, or as long as one day (86400
seconds). Valid values are: 1 (one second) 60 (one minute) 300 (five minutes)
3600 (one hour) 86400 (twenty-four hours) If you don't specify PeriodInSeconds, then
Performance Insights will choose a value for you, with a goal of returning roughly 100-200
data points in the response.
"""
function get_resource_metrics(
EndTime,
Identifier,
MetricQueries,
ServiceType,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetResourceMetrics",
Dict{String,Any}(
"EndTime" => EndTime,
"Identifier" => Identifier,
"MetricQueries" => MetricQueries,
"ServiceType" => ServiceType,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_metrics(
EndTime,
Identifier,
MetricQueries,
ServiceType,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"GetResourceMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"Identifier" => Identifier,
"MetricQueries" => MetricQueries,
"ServiceType" => ServiceType,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_available_resource_dimensions(identifier, metrics, service_type)
list_available_resource_dimensions(identifier, metrics, service_type, params::Dict{String,<:Any})
Retrieve the dimensions that can be queried for each specified metric type on a specified
DB instance.
# Arguments
- `identifier`: An immutable identifier for a data source that is unique within an Amazon
Web Services Region. Performance Insights gathers metrics from this data source. To use an
Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example,
specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
- `metrics`: The types of metrics for which to retrieve dimensions. Valid values include
db.load.
- `service_type`: The Amazon Web Services service for which Performance Insights returns
metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthorizedActions"`: The actions to discover the dimensions you are authorized to
access. If you specify multiple actions, then the response will contain the dimensions
common for all the actions. When you don't specify this request parameter or provide an
empty list, the response contains all the available dimensions for the target database
engine whether or not you are authorized to access them.
- `"MaxResults"`: The maximum number of items to return in the response. If more items
exist than the specified MaxRecords value, a pagination token is included in the response
so that the remaining results can be retrieved.
- `"NextToken"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the token, up to the
value specified by MaxRecords.
"""
function list_available_resource_dimensions(
Identifier, Metrics, ServiceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"ListAvailableResourceDimensions",
Dict{String,Any}(
"Identifier" => Identifier, "Metrics" => Metrics, "ServiceType" => ServiceType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_available_resource_dimensions(
Identifier,
Metrics,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"ListAvailableResourceDimensions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identifier" => Identifier,
"Metrics" => Metrics,
"ServiceType" => ServiceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_available_resource_metrics(identifier, metric_types, service_type)
list_available_resource_metrics(identifier, metric_types, service_type, params::Dict{String,<:Any})
Retrieve metrics of the specified types that can be queried for a specified DB instance.
# Arguments
- `identifier`: An immutable identifier for a data source that is unique within an Amazon
Web Services Region. Performance Insights gathers metrics from this data source. To use an
Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example,
specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
- `metric_types`: The types of metrics to return in the response. Valid values in the array
include the following: os (OS counter metrics) - All engines db (DB load metrics) -
All engines except for Amazon DocumentDB db.sql.stats (per-SQL metrics) - All engines
except for Amazon DocumentDB db.sql_tokenized.stats (per-SQL digest metrics) - All
engines except for Amazon DocumentDB
- `service_type`: The Amazon Web Services service for which Performance Insights returns
metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return. If the MaxRecords value is less
than the number of existing items, the response includes a pagination token.
- `"NextToken"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the token, up to the
value specified by MaxRecords.
"""
function list_available_resource_metrics(
Identifier, MetricTypes, ServiceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"ListAvailableResourceMetrics",
Dict{String,Any}(
"Identifier" => Identifier,
"MetricTypes" => MetricTypes,
"ServiceType" => ServiceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_available_resource_metrics(
Identifier,
MetricTypes,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"ListAvailableResourceMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identifier" => Identifier,
"MetricTypes" => MetricTypes,
"ServiceType" => ServiceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_performance_analysis_reports(identifier, service_type)
list_performance_analysis_reports(identifier, service_type, params::Dict{String,<:Any})
Lists all the analysis reports created for the DB instance. The reports are sorted based on
the start time of each report.
# Arguments
- `identifier`: An immutable identifier for a data source that is unique for an Amazon Web
Services Region. Performance Insights gathers metrics from this data source. In the
console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the
identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its
DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
- `service_type`: The Amazon Web Services service for which Performance Insights returns
metrics. Valid value is RDS.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ListTags"`: Specifies whether or not to include the list of tags in the response.
- `"MaxResults"`: The maximum number of items to return in the response. If more items
exist than the specified MaxResults value, a pagination token is included in the response
so that the remaining results can be retrieved.
- `"NextToken"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the token, up to the
value specified by MaxResults.
"""
function list_performance_analysis_reports(
Identifier, ServiceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"ListPerformanceAnalysisReports",
Dict{String,Any}("Identifier" => Identifier, "ServiceType" => ServiceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_performance_analysis_reports(
Identifier,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"ListPerformanceAnalysisReports",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Identifier" => Identifier, "ServiceType" => ServiceType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn, service_type)
list_tags_for_resource(resource_arn, service_type, params::Dict{String,<:Any})
Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
# Arguments
- `resource_arn`: Lists all the tags for the Amazon RDS Performance Insights resource. This
value is an Amazon Resource Name (ARN). For information about creating an ARN, see
Constructing an RDS Amazon Resource Name (ARN).
- `service_type`: List the tags for the Amazon Web Services service for which Performance
Insights returns metrics. Valid value is RDS.
"""
function list_tags_for_resource(
ResourceARN, ServiceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"ListTagsForResource",
Dict{String,Any}("ResourceARN" => ResourceARN, "ServiceType" => ServiceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceARN,
ServiceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"ListTagsForResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceARN" => ResourceARN, "ServiceType" => ServiceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, service_type, tags)
tag_resource(resource_arn, service_type, tags, params::Dict{String,<:Any})
Adds metadata tags to the Amazon RDS Performance Insights resource.
# Arguments
- `resource_arn`: The Amazon RDS Performance Insights resource that the tags are added to.
This value is an Amazon Resource Name (ARN). For information about creating an ARN, see
Constructing an RDS Amazon Resource Name (ARN).
- `service_type`: The Amazon Web Services service for which Performance Insights returns
metrics. Valid value is RDS.
- `tags`: The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
"""
function tag_resource(
ResourceARN, ServiceType, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"TagResource",
Dict{String,Any}(
"ResourceARN" => ResourceARN, "ServiceType" => ServiceType, "Tags" => Tags
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceARN,
ServiceType,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceARN" => ResourceARN,
"ServiceType" => ServiceType,
"Tags" => Tags,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, service_type, tag_keys)
untag_resource(resource_arn, service_type, tag_keys, params::Dict{String,<:Any})
Deletes the metadata tags from the Amazon RDS Performance Insights resource.
# Arguments
- `resource_arn`: The Amazon RDS Performance Insights resource that the tags are added to.
This value is an Amazon Resource Name (ARN). For information about creating an ARN, see
Constructing an RDS Amazon Resource Name (ARN).
- `service_type`: List the tags for the Amazon Web Services service for which Performance
Insights returns metrics. Valid value is RDS.
- `tag_keys`: The metadata assigned to an Amazon RDS Performance Insights resource
consisting of a key-value pair.
"""
function untag_resource(
ResourceARN, ServiceType, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pi(
"UntagResource",
Dict{String,Any}(
"ResourceARN" => ResourceARN, "ServiceType" => ServiceType, "TagKeys" => TagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceARN,
ServiceType,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pi(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceARN" => ResourceARN,
"ServiceType" => ServiceType,
"TagKeys" => TagKeys,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 176209 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pinpoint
using AWS.Compat
using AWS.UUIDs
"""
create_app(create_application_request)
create_app(create_application_request, params::Dict{String,<:Any})
Creates an application.
# Arguments
- `create_application_request`:
"""
function create_app(
CreateApplicationRequest; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps",
Dict{String,Any}("CreateApplicationRequest" => CreateApplicationRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app(
CreateApplicationRequest,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CreateApplicationRequest" => CreateApplicationRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_campaign(write_campaign_request, application-id)
create_campaign(write_campaign_request, application-id, params::Dict{String,<:Any})
Creates a new campaign for an application or updates the settings of an existing campaign
for an application.
# Arguments
- `write_campaign_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function create_campaign(
WriteCampaignRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/campaigns",
Dict{String,Any}("WriteCampaignRequest" => WriteCampaignRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_campaign(
WriteCampaignRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/campaigns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WriteCampaignRequest" => WriteCampaignRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_email_template(email_template_request, template-name)
create_email_template(email_template_request, template-name, params::Dict{String,<:Any})
Creates a message template for messages that are sent through the email channel.
# Arguments
- `email_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
"""
function create_email_template(
EmailTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/email",
Dict{String,Any}("EmailTemplateRequest" => EmailTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_email_template(
EmailTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/email",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EmailTemplateRequest" => EmailTemplateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_export_job(export_job_request, application-id)
create_export_job(export_job_request, application-id, params::Dict{String,<:Any})
Creates an export job for an application.
# Arguments
- `export_job_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function create_export_job(
ExportJobRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/jobs/export",
Dict{String,Any}("ExportJobRequest" => ExportJobRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_export_job(
ExportJobRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/jobs/export",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ExportJobRequest" => ExportJobRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_import_job(import_job_request, application-id)
create_import_job(import_job_request, application-id, params::Dict{String,<:Any})
Creates an import job for an application.
# Arguments
- `import_job_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function create_import_job(
ImportJobRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/jobs/import",
Dict{String,Any}("ImportJobRequest" => ImportJobRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_import_job(
ImportJobRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/jobs/import",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ImportJobRequest" => ImportJobRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_in_app_template(in_app_template_request, template-name)
create_in_app_template(in_app_template_request, template-name, params::Dict{String,<:Any})
Creates a new message template for messages using the in-app message channel.
# Arguments
- `in_app_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
"""
function create_in_app_template(
InAppTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/inapp",
Dict{String,Any}("InAppTemplateRequest" => InAppTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_in_app_template(
InAppTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/inapp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InAppTemplateRequest" => InAppTemplateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_journey(write_journey_request, application-id)
create_journey(write_journey_request, application-id, params::Dict{String,<:Any})
Creates a journey for an application.
# Arguments
- `write_journey_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function create_journey(
WriteJourneyRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/journeys",
Dict{String,Any}("WriteJourneyRequest" => WriteJourneyRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_journey(
WriteJourneyRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/journeys",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WriteJourneyRequest" => WriteJourneyRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_push_template(push_notification_template_request, template-name)
create_push_template(push_notification_template_request, template-name, params::Dict{String,<:Any})
Creates a message template for messages that are sent through a push notification channel.
# Arguments
- `push_notification_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
"""
function create_push_template(
PushNotificationTemplateRequest,
template_name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/push",
Dict{String,Any}(
"PushNotificationTemplateRequest" => PushNotificationTemplateRequest
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_push_template(
PushNotificationTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/push",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PushNotificationTemplateRequest" => PushNotificationTemplateRequest
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recommender_configuration(create_recommender_configuration)
create_recommender_configuration(create_recommender_configuration, params::Dict{String,<:Any})
Creates an Amazon Pinpoint configuration for a recommender model.
# Arguments
- `create_recommender_configuration`:
"""
function create_recommender_configuration(
CreateRecommenderConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/recommenders",
Dict{String,Any}(
"CreateRecommenderConfiguration" => CreateRecommenderConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recommender_configuration(
CreateRecommenderConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/recommenders",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreateRecommenderConfiguration" => CreateRecommenderConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_segment(write_segment_request, application-id)
create_segment(write_segment_request, application-id, params::Dict{String,<:Any})
Creates a new segment for an application or updates the configuration, dimension, and other
settings for an existing segment that's associated with an application.
# Arguments
- `write_segment_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function create_segment(
WriteSegmentRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/segments",
Dict{String,Any}("WriteSegmentRequest" => WriteSegmentRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_segment(
WriteSegmentRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/segments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WriteSegmentRequest" => WriteSegmentRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sms_template(smstemplate_request, template-name)
create_sms_template(smstemplate_request, template-name, params::Dict{String,<:Any})
Creates a message template for messages that are sent through the SMS channel.
# Arguments
- `smstemplate_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
"""
function create_sms_template(
SMSTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/sms",
Dict{String,Any}("SMSTemplateRequest" => SMSTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sms_template(
SMSTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/sms",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SMSTemplateRequest" => SMSTemplateRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_voice_template(voice_template_request, template-name)
create_voice_template(voice_template_request, template-name, params::Dict{String,<:Any})
Creates a message template for messages that are sent through the voice channel.
# Arguments
- `voice_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
"""
function create_voice_template(
VoiceTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/voice",
Dict{String,Any}("VoiceTemplateRequest" => VoiceTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_voice_template(
VoiceTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/templates/$(template-name)/voice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VoiceTemplateRequest" => VoiceTemplateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_adm_channel(application-id)
delete_adm_channel(application-id, params::Dict{String,<:Any})
Disables the ADM channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_adm_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/adm";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_adm_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/adm",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_apns_channel(application-id)
delete_apns_channel(application-id, params::Dict{String,<:Any})
Disables the APNs channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_apns_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_apns_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_apns_sandbox_channel(application-id)
delete_apns_sandbox_channel(application-id, params::Dict{String,<:Any})
Disables the APNs sandbox channel for an application and deletes any existing settings for
the channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_apns_sandbox_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns_sandbox";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_apns_sandbox_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns_sandbox",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_apns_voip_channel(application-id)
delete_apns_voip_channel(application-id, params::Dict{String,<:Any})
Disables the APNs VoIP channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_apns_voip_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns_voip";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_apns_voip_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns_voip",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_apns_voip_sandbox_channel(application-id)
delete_apns_voip_sandbox_channel(application-id, params::Dict{String,<:Any})
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings
for the channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_apns_voip_sandbox_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns_voip_sandbox";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_apns_voip_sandbox_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/apns_voip_sandbox",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app(application-id)
delete_app(application-id, params::Dict{String,<:Any})
Deletes an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_app(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_baidu_channel(application-id)
delete_baidu_channel(application-id, params::Dict{String,<:Any})
Disables the Baidu channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_baidu_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/baidu";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_baidu_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/baidu",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_campaign(application-id, campaign-id)
delete_campaign(application-id, campaign-id, params::Dict{String,<:Any})
Deletes a campaign from an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
"""
function delete_campaign(
application_id, campaign_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_campaign(
application_id,
campaign_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_email_channel(application-id)
delete_email_channel(application-id, params::Dict{String,<:Any})
Disables the email channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_email_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/email";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_email_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/email",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_email_template(template-name)
delete_email_template(template-name, params::Dict{String,<:Any})
Deletes a message template for messages that were sent through the email channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function delete_email_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/email";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_email_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/email",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint(application-id, endpoint-id)
delete_endpoint(application-id, endpoint-id, params::Dict{String,<:Any})
Deletes an endpoint from an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `endpoint-id`: The case insensitive unique identifier for the endpoint. The identifier
can't contain , { or }.
"""
function delete_endpoint(
application_id, endpoint_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint(
application_id,
endpoint_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_stream(application-id)
delete_event_stream(application-id, params::Dict{String,<:Any})
Deletes the event stream for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_event_stream(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/eventstream";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_stream(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/eventstream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_gcm_channel(application-id)
delete_gcm_channel(application-id, params::Dict{String,<:Any})
Disables the GCM channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_gcm_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/gcm";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_gcm_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/gcm",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_in_app_template(template-name)
delete_in_app_template(template-name, params::Dict{String,<:Any})
Deletes a message template for messages sent using the in-app message channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function delete_in_app_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/inapp";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_in_app_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/inapp",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_journey(application-id, journey-id)
delete_journey(application-id, journey-id, params::Dict{String,<:Any})
Deletes a journey from an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
"""
function delete_journey(
application_id, journey_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/journeys/$(journey-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_journey(
application_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/journeys/$(journey-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_push_template(template-name)
delete_push_template(template-name, params::Dict{String,<:Any})
Deletes a message template for messages that were sent through a push notification channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function delete_push_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/push";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_push_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/push",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recommender_configuration(recommender-id)
delete_recommender_configuration(recommender-id, params::Dict{String,<:Any})
Deletes an Amazon Pinpoint configuration for a recommender model.
# Arguments
- `recommender-id`: The unique identifier for the recommender model configuration. This
identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
"""
function delete_recommender_configuration(
recommender_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/recommenders/$(recommender-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recommender_configuration(
recommender_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/recommenders/$(recommender-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_segment(application-id, segment-id)
delete_segment(application-id, segment-id, params::Dict{String,<:Any})
Deletes a segment from an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
"""
function delete_segment(
application_id, segment_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/segments/$(segment-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_segment(
application_id,
segment_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/segments/$(segment-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sms_channel(application-id)
delete_sms_channel(application-id, params::Dict{String,<:Any})
Disables the SMS channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_sms_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/sms";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sms_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/sms",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sms_template(template-name)
delete_sms_template(template-name, params::Dict{String,<:Any})
Deletes a message template for messages that were sent through the SMS channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function delete_sms_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/sms";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sms_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/sms",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_endpoints(application-id, user-id)
delete_user_endpoints(application-id, user-id, params::Dict{String,<:Any})
Deletes all the endpoints that are associated with a specific user ID.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `user-id`: The unique identifier for the user.
"""
function delete_user_endpoints(
application_id, user_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/users/$(user-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_endpoints(
application_id,
user_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/users/$(user-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_voice_channel(application-id)
delete_voice_channel(application-id, params::Dict{String,<:Any})
Disables the voice channel for an application and deletes any existing settings for the
channel.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function delete_voice_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/voice";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_voice_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/apps/$(application-id)/channels/voice",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_voice_template(template-name)
delete_voice_template(template-name, params::Dict{String,<:Any})
Deletes a message template for messages that were sent through the voice channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function delete_voice_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/voice";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_voice_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/templates/$(template-name)/voice",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_adm_channel(application-id)
get_adm_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the ADM channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_adm_channel(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/adm";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_adm_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/adm",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_apns_channel(application-id)
get_apns_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the APNs channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_apns_channel(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_apns_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_apns_sandbox_channel(application-id)
get_apns_sandbox_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the APNs sandbox channel for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_apns_sandbox_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns_sandbox";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_apns_sandbox_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns_sandbox",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_apns_voip_channel(application-id)
get_apns_voip_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the APNs VoIP channel for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_apns_voip_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns_voip";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_apns_voip_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns_voip",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_apns_voip_sandbox_channel(application-id)
get_apns_voip_sandbox_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_apns_voip_sandbox_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns_voip_sandbox";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_apns_voip_sandbox_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/apns_voip_sandbox",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_app(application-id)
get_app(application-id, params::Dict{String,<:Any})
Retrieves information about an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_app(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_app(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_date_range_kpi(application-id, kpi-name)
get_application_date_range_kpi(application-id, kpi-name, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard metric that applies to an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `kpi-name`: The name of the metric, also referred to as a key performance indicator
(KPI), to retrieve data for. This value describes the associated metric and consists of two
or more terms, which are comprised of lowercase alphanumeric characters, separated by a
hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid
values, see the Amazon Pinpoint Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"end-time"`: The last date and time to retrieve data for, as part of an inclusive date
range that filters the query results. This value should be in extended ISO 8601 format and
use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC
July 26, 2019.
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"start-time"`: The first date and time to retrieve data for, as part of an inclusive
date range that filters the query results. This value should be in extended ISO 8601 format
and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC
July 19, 2019. This value should also be fewer than 90 days from the current day.
"""
function get_application_date_range_kpi(
application_id, kpi_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/kpis/daterange/$(kpi-name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_date_range_kpi(
application_id,
kpi_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/kpis/daterange/$(kpi-name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_settings(application-id)
get_application_settings(application-id, params::Dict{String,<:Any})
Retrieves information about the settings for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_application_settings(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_settings(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_apps()
get_apps(params::Dict{String,<:Any})
Retrieves information about all the applications that are associated with your Amazon
Pinpoint account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_apps(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET", "/v1/apps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_apps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET", "/v1/apps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_baidu_channel(application-id)
get_baidu_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the Baidu channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_baidu_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/baidu";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_baidu_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/baidu",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign(application-id, campaign-id)
get_campaign(application-id, campaign-id, params::Dict{String,<:Any})
Retrieves information about the status, configuration, and other settings for a campaign.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
"""
function get_campaign(
application_id, campaign_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign(
application_id,
campaign_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign_activities(application-id, campaign-id)
get_campaign_activities(application-id, campaign-id, params::Dict{String,<:Any})
Retrieves information about all the activities for a campaign.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_campaign_activities(
application_id, campaign_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/activities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign_activities(
application_id,
campaign_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/activities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign_date_range_kpi(application-id, campaign-id, kpi-name)
get_campaign_date_range_kpi(application-id, campaign-id, kpi-name, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
- `kpi-name`: The name of the metric, also referred to as a key performance indicator
(KPI), to retrieve data for. This value describes the associated metric and consists of two
or more terms, which are comprised of lowercase alphanumeric characters, separated by a
hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid
values, see the Amazon Pinpoint Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"end-time"`: The last date and time to retrieve data for, as part of an inclusive date
range that filters the query results. This value should be in extended ISO 8601 format and
use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC
July 26, 2019.
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"start-time"`: The first date and time to retrieve data for, as part of an inclusive
date range that filters the query results. This value should be in extended ISO 8601 format
and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC
July 19, 2019. This value should also be fewer than 90 days from the current day.
"""
function get_campaign_date_range_kpi(
application_id, campaign_id, kpi_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/kpis/daterange/$(kpi-name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign_date_range_kpi(
application_id,
campaign_id,
kpi_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/kpis/daterange/$(kpi-name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign_version(application-id, campaign-id, version)
get_campaign_version(application-id, campaign-id, version, params::Dict{String,<:Any})
Retrieves information about the status, configuration, and other settings for a specific
version of a campaign.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
- `version`: The unique version number (Version property) for the campaign version.
"""
function get_campaign_version(
application_id, campaign_id, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/versions/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign_version(
application_id,
campaign_id,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/versions/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign_versions(application-id, campaign-id)
get_campaign_versions(application-id, campaign-id, params::Dict{String,<:Any})
Retrieves information about the status, configuration, and other settings for all versions
of a campaign.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_campaign_versions(
application_id, campaign_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign_versions(
application_id,
campaign_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaigns(application-id)
get_campaigns(application-id, params::Dict{String,<:Any})
Retrieves information about the status, configuration, and other settings for all the
campaigns that are associated with an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_campaigns(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaigns(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/campaigns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_channels(application-id)
get_channels(application-id, params::Dict{String,<:Any})
Retrieves information about the history and status of each channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_channels(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_channels(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_email_channel(application-id)
get_email_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the email channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_email_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/email";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_email_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/email",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_email_template(template-name)
get_email_template(template-name, params::Dict{String,<:Any})
Retrieves the content and settings of a message template for messages that are sent through
the email channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function get_email_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/email";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_email_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/email",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_endpoint(application-id, endpoint-id)
get_endpoint(application-id, endpoint-id, params::Dict{String,<:Any})
Retrieves information about the settings and attributes of a specific endpoint for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `endpoint-id`: The case insensitive unique identifier for the endpoint. The identifier
can't contain , { or }.
"""
function get_endpoint(
application_id, endpoint_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_endpoint(
application_id,
endpoint_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_stream(application-id)
get_event_stream(application-id, params::Dict{String,<:Any})
Retrieves information about the event stream settings for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_event_stream(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/eventstream";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_stream(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/eventstream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_export_job(application-id, job-id)
get_export_job(application-id, job-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of a specific export job for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `job-id`: The unique identifier for the job.
"""
function get_export_job(
application_id, job_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/export/$(job-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_export_job(
application_id,
job_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/export/$(job-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_export_jobs(application-id)
get_export_jobs(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of all the export jobs for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_export_jobs(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/export";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_export_jobs(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/export",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_gcm_channel(application-id)
get_gcm_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the GCM channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_gcm_channel(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/gcm";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_gcm_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/gcm",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import_job(application-id, job-id)
get_import_job(application-id, job-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of a specific import job for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `job-id`: The unique identifier for the job.
"""
function get_import_job(
application_id, job_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/import/$(job-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import_job(
application_id,
job_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/import/$(job-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import_jobs(application-id)
get_import_jobs(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of all the import jobs for an
application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_import_jobs(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/import";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import_jobs(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/jobs/import",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_in_app_messages(application-id, endpoint-id)
get_in_app_messages(application-id, endpoint-id, params::Dict{String,<:Any})
Retrieves the in-app messages targeted for the provided endpoint ID.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `endpoint-id`: The unique identifier for the endpoint.
"""
function get_in_app_messages(
application_id, endpoint_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)/inappmessages";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_in_app_messages(
application_id,
endpoint_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)/inappmessages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_in_app_template(template-name)
get_in_app_template(template-name, params::Dict{String,<:Any})
Retrieves the content and settings of a message template for messages sent through the
in-app channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function get_in_app_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/inapp";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_in_app_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/inapp",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey(application-id, journey-id)
get_journey(application-id, journey-id, params::Dict{String,<:Any})
Retrieves information about the status, configuration, and other settings for a journey.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
"""
function get_journey(
application_id, journey_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey(
application_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey_date_range_kpi(application-id, journey-id, kpi-name)
get_journey_date_range_kpi(application-id, journey-id, kpi-name, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a
journey.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
- `kpi-name`: The name of the metric, also referred to as a key performance indicator
(KPI), to retrieve data for. This value describes the associated metric and consists of two
or more terms, which are comprised of lowercase alphanumeric characters, separated by a
hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid
values, see the Amazon Pinpoint Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"end-time"`: The last date and time to retrieve data for, as part of an inclusive date
range that filters the query results. This value should be in extended ISO 8601 format and
use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC
July 26, 2019.
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"start-time"`: The first date and time to retrieve data for, as part of an inclusive
date range that filters the query results. This value should be in extended ISO 8601 format
and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC
July 19, 2019. This value should also be fewer than 90 days from the current day.
"""
function get_journey_date_range_kpi(
application_id, journey_id, kpi_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/kpis/daterange/$(kpi-name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey_date_range_kpi(
application_id,
journey_id,
kpi_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/kpis/daterange/$(kpi-name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey_execution_activity_metrics(application-id, journey-activity-id, journey-id)
get_journey_execution_activity_metrics(application-id, journey-activity-id, journey-id, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a
journey activity.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-activity-id`: The unique identifier for the journey activity.
- `journey-id`: The unique identifier for the journey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
"""
function get_journey_execution_activity_metrics(
application_id,
journey_activity_id,
journey_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/activities/$(journey-activity-id)/execution-metrics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey_execution_activity_metrics(
application_id,
journey_activity_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/activities/$(journey-activity-id)/execution-metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey_execution_metrics(application-id, journey-id)
get_journey_execution_metrics(application-id, journey-id, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a
journey.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
"""
function get_journey_execution_metrics(
application_id, journey_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/execution-metrics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey_execution_metrics(
application_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/execution-metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey_run_execution_activity_metrics(application-id, journey-activity-id, journey-id, run-id)
get_journey_run_execution_activity_metrics(application-id, journey-activity-id, journey-id, run-id, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to
a journey activity.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-activity-id`: The unique identifier for the journey activity.
- `journey-id`: The unique identifier for the journey.
- `run-id`: The unique identifier for the journey run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
"""
function get_journey_run_execution_activity_metrics(
application_id,
journey_activity_id,
journey_id,
run_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/runs/$(run-id)/activities/$(journey-activity-id)/execution-metrics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey_run_execution_activity_metrics(
application_id,
journey_activity_id,
journey_id,
run_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/runs/$(run-id)/activities/$(journey-activity-id)/execution-metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey_run_execution_metrics(application-id, journey-id, run-id)
get_journey_run_execution_metrics(application-id, journey-id, run-id, params::Dict{String,<:Any})
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to
a journey.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
- `run-id`: The unique identifier for the journey run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
"""
function get_journey_run_execution_metrics(
application_id, journey_id, run_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/runs/$(run-id)/execution-metrics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey_run_execution_metrics(
application_id,
journey_id,
run_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/runs/$(run-id)/execution-metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_journey_runs(application-id, journey-id)
get_journey_runs(application-id, journey-id, params::Dict{String,<:Any})
Provides information about the runs of a journey.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_journey_runs(
application_id, journey_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/runs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_journey_runs(
application_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys/$(journey-id)/runs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_push_template(template-name)
get_push_template(template-name, params::Dict{String,<:Any})
Retrieves the content and settings of a message template for messages that are sent through
a push notification channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function get_push_template(template_name; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/templates/$(template-name)/push";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_push_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/push",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommender_configuration(recommender-id)
get_recommender_configuration(recommender-id, params::Dict{String,<:Any})
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
# Arguments
- `recommender-id`: The unique identifier for the recommender model configuration. This
identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
"""
function get_recommender_configuration(
recommender_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/recommenders/$(recommender-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommender_configuration(
recommender_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/recommenders/$(recommender-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommender_configurations()
get_recommender_configurations(params::Dict{String,<:Any})
Retrieves information about all the recommender model configurations that are associated
with your Amazon Pinpoint account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_recommender_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET", "/v1/recommenders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_recommender_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/recommenders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment(application-id, segment-id)
get_segment(application-id, segment-id, params::Dict{String,<:Any})
Retrieves information about the configuration, dimension, and other settings for a specific
segment that's associated with an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
"""
function get_segment(
application_id, segment_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment(
application_id,
segment_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment_export_jobs(application-id, segment-id)
get_segment_export_jobs(application-id, segment-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the export jobs for a segment.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_segment_export_jobs(
application_id, segment_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/jobs/export";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment_export_jobs(
application_id,
segment_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/jobs/export",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment_import_jobs(application-id, segment-id)
get_segment_import_jobs(application-id, segment-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the import jobs for a segment.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_segment_import_jobs(
application_id, segment_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/jobs/import";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment_import_jobs(
application_id,
segment_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/jobs/import",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment_version(application-id, segment-id, version)
get_segment_version(application-id, segment-id, version, params::Dict{String,<:Any})
Retrieves information about the configuration, dimension, and other settings for a specific
version of a segment that's associated with an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
- `version`: The unique version number (Version property) for the campaign version.
"""
function get_segment_version(
application_id, segment_id, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/versions/$(version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment_version(
application_id,
segment_id,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/versions/$(version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment_versions(application-id, segment-id)
get_segment_versions(application-id, segment-id, params::Dict{String,<:Any})
Retrieves information about the configuration, dimension, and other settings for all the
versions of a specific segment that's associated with an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_segment_versions(
application_id, segment_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment_versions(
application_id,
segment_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments/$(segment-id)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segments(application-id)
get_segments(application-id, params::Dict{String,<:Any})
Retrieves information about the configuration, dimension, and other settings for all the
segments that are associated with an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function get_segments(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segments(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/segments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sms_channel(application-id)
get_sms_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the SMS channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_sms_channel(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/sms";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sms_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/sms",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sms_template(template-name)
get_sms_template(template-name, params::Dict{String,<:Any})
Retrieves the content and settings of a message template for messages that are sent through
the SMS channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function get_sms_template(template_name; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/templates/$(template-name)/sms";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sms_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/sms",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_endpoints(application-id, user-id)
get_user_endpoints(application-id, user-id, params::Dict{String,<:Any})
Retrieves information about all the endpoints that are associated with a specific user ID.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `user-id`: The unique identifier for the user.
"""
function get_user_endpoints(
application_id, user_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/users/$(user-id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_endpoints(
application_id,
user_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/users/$(user-id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_voice_channel(application-id)
get_voice_channel(application-id, params::Dict{String,<:Any})
Retrieves information about the status and settings of the voice channel for an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function get_voice_channel(
application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/voice";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_voice_channel(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/channels/voice",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_voice_template(template-name)
get_voice_template(template-name, params::Dict{String,<:Any})
Retrieves the content and settings of a message template for messages that are sent through
the voice channel.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function get_voice_template(
template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/voice";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_voice_template(
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/voice",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_journeys(application-id)
list_journeys(application-id, params::Dict{String,<:Any})
Retrieves information about the status, configuration, and other settings for all the
journeys that are associated with an application.
# Arguments
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"token"`: The NextToken string that specifies which page of results to return in a
paginated response.
"""
function list_journeys(application_id; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_journeys(
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/apps/$(application-id)/journeys",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})
Retrieves all the tags (keys and values) that are associated with an application, campaign,
message template, or segment.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_versions(template-name, template-type)
list_template_versions(template-name, template-type, params::Dict{String,<:Any})
Retrieves information about all the versions of a specific message template.
# Arguments
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
- `template-type`: The type of channel that the message template is designed for. Valid
values are: EMAIL, PUSH, SMS, and VOICE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
"""
function list_template_versions(
template_name, template_type; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/$(template-type)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_versions(
template_name,
template_type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"GET",
"/v1/templates/$(template-name)/$(template-type)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates()
list_templates(params::Dict{String,<:Any})
Retrieves information about all the message templates that are associated with your Amazon
Pinpoint account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"next-token"`: The string that specifies which page of results to return in a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"page-size"`: The maximum number of items to include in each page of a paginated
response. This parameter is not supported for application, campaign, and journey metrics.
- `"prefix"`: The substring to match in the names of the message templates to include in
the results. If you specify this value, Amazon Pinpoint returns only those templates whose
names begin with the value that you specify.
- `"template-type"`: The type of message template to include in the results. Valid values
are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't
include this parameter in your request.
"""
function list_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint(
"GET", "/v1/templates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"GET",
"/v1/templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
phone_number_validate(number_validate_request)
phone_number_validate(number_validate_request, params::Dict{String,<:Any})
Retrieves information about a phone number.
# Arguments
- `number_validate_request`:
"""
function phone_number_validate(
NumberValidateRequest; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/phone/number/validate",
Dict{String,Any}("NumberValidateRequest" => NumberValidateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function phone_number_validate(
NumberValidateRequest,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/phone/number/validate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NumberValidateRequest" => NumberValidateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_event_stream(write_event_stream, application-id)
put_event_stream(write_event_stream, application-id, params::Dict{String,<:Any})
Creates a new event stream for an application or updates the settings of an existing event
stream for an application.
# Arguments
- `write_event_stream`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function put_event_stream(
WriteEventStream, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/eventstream",
Dict{String,Any}("WriteEventStream" => WriteEventStream);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_event_stream(
WriteEventStream,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/eventstream",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WriteEventStream" => WriteEventStream), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_events(events_request, application-id)
put_events(events_request, application-id, params::Dict{String,<:Any})
Creates a new event to record for endpoints, or creates or updates endpoint data that
existing events are associated with.
# Arguments
- `events_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function put_events(
EventsRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/events",
Dict{String,Any}("EventsRequest" => EventsRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_events(
EventsRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/events",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EventsRequest" => EventsRequest), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_attributes(update_attributes_request, application-id, attribute-type)
remove_attributes(update_attributes_request, application-id, attribute-type, params::Dict{String,<:Any})
Removes one or more custom attributes, of the same attribute type, from the application.
Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or
changed values for these attributes.
# Arguments
- `update_attributes_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `attribute-type`: The type of attribute or attributes to remove. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date
when an associated user opted in or out of receiving communications from you through a
specific type of channel. endpoint-metric-attributes - Custom metrics that your app reports
to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items
left in a cart. endpoint-user-attributes - Custom attributes that describe users, such as
first name, last name, and age.
"""
function remove_attributes(
UpdateAttributesRequest,
application_id,
attribute_type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/attributes/$(attribute-type)",
Dict{String,Any}("UpdateAttributesRequest" => UpdateAttributesRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_attributes(
UpdateAttributesRequest,
application_id,
attribute_type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/attributes/$(attribute-type)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UpdateAttributesRequest" => UpdateAttributesRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_messages(message_request, application-id)
send_messages(message_request, application-id, params::Dict{String,<:Any})
Creates and sends a direct message.
# Arguments
- `message_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function send_messages(
MessageRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/messages",
Dict{String,Any}("MessageRequest" => MessageRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_messages(
MessageRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/messages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MessageRequest" => MessageRequest), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_otpmessage(send_otpmessage_request_parameters, application-id)
send_otpmessage(send_otpmessage_request_parameters, application-id, params::Dict{String,<:Any})
Send an OTP message
# Arguments
- `send_otpmessage_request_parameters`:
- `application-id`: The unique ID of your Amazon Pinpoint application.
"""
function send_otpmessage(
SendOTPMessageRequestParameters,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/otp",
Dict{String,Any}(
"SendOTPMessageRequestParameters" => SendOTPMessageRequestParameters
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_otpmessage(
SendOTPMessageRequestParameters,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/otp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SendOTPMessageRequestParameters" => SendOTPMessageRequestParameters
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_users_messages(send_users_message_request, application-id)
send_users_messages(send_users_message_request, application-id, params::Dict{String,<:Any})
Creates and sends a message to a list of users.
# Arguments
- `send_users_message_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function send_users_messages(
SendUsersMessageRequest,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/users-messages",
Dict{String,Any}("SendUsersMessageRequest" => SendUsersMessageRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_users_messages(
SendUsersMessageRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/users-messages",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SendUsersMessageRequest" => SendUsersMessageRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags_model, resource-arn)
tag_resource(tags_model, resource-arn, params::Dict{String,<:Any})
Adds one or more tags (keys and values) to an application, campaign, message template, or
segment.
# Arguments
- `tags_model`:
- `resource-arn`: The Amazon Resource Name (ARN) of the resource.
"""
function tag_resource(
TagsModel, resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"POST",
"/v1/tags/$(resource-arn)",
Dict{String,Any}("TagsModel" => TagsModel);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
TagsModel,
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/tags/$(resource-arn)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TagsModel" => TagsModel), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags (keys and values) from an application, campaign, message template,
or segment.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The key of the tag to remove from the resource. To remove multiple tags,
append the tagKeys parameter and argument for each additional tag to remove, separated by
an ampersand (&).
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"DELETE",
"/v1/tags/$(resource-arn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resource_arn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"DELETE",
"/v1/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_adm_channel(admchannel_request, application-id)
update_adm_channel(admchannel_request, application-id, params::Dict{String,<:Any})
Enables the ADM channel for an application or updates the status and settings of the ADM
channel for an application.
# Arguments
- `admchannel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_adm_channel(
ADMChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/adm",
Dict{String,Any}("ADMChannelRequest" => ADMChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_adm_channel(
ADMChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/adm",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ADMChannelRequest" => ADMChannelRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_apns_channel(apnschannel_request, application-id)
update_apns_channel(apnschannel_request, application-id, params::Dict{String,<:Any})
Enables the APNs channel for an application or updates the status and settings of the APNs
channel for an application.
# Arguments
- `apnschannel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_apns_channel(
APNSChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns",
Dict{String,Any}("APNSChannelRequest" => APNSChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_apns_channel(
APNSChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("APNSChannelRequest" => APNSChannelRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_apns_sandbox_channel(apnssandbox_channel_request, application-id)
update_apns_sandbox_channel(apnssandbox_channel_request, application-id, params::Dict{String,<:Any})
Enables the APNs sandbox channel for an application or updates the status and settings of
the APNs sandbox channel for an application.
# Arguments
- `apnssandbox_channel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_apns_sandbox_channel(
APNSSandboxChannelRequest,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns_sandbox",
Dict{String,Any}("APNSSandboxChannelRequest" => APNSSandboxChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_apns_sandbox_channel(
APNSSandboxChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns_sandbox",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("APNSSandboxChannelRequest" => APNSSandboxChannelRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_apns_voip_channel(apnsvoip_channel_request, application-id)
update_apns_voip_channel(apnsvoip_channel_request, application-id, params::Dict{String,<:Any})
Enables the APNs VoIP channel for an application or updates the status and settings of the
APNs VoIP channel for an application.
# Arguments
- `apnsvoip_channel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_apns_voip_channel(
APNSVoipChannelRequest,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns_voip",
Dict{String,Any}("APNSVoipChannelRequest" => APNSVoipChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_apns_voip_channel(
APNSVoipChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns_voip",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("APNSVoipChannelRequest" => APNSVoipChannelRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_apns_voip_sandbox_channel(apnsvoip_sandbox_channel_request, application-id)
update_apns_voip_sandbox_channel(apnsvoip_sandbox_channel_request, application-id, params::Dict{String,<:Any})
Enables the APNs VoIP sandbox channel for an application or updates the status and settings
of the APNs VoIP sandbox channel for an application.
# Arguments
- `apnsvoip_sandbox_channel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_apns_voip_sandbox_channel(
APNSVoipSandboxChannelRequest,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns_voip_sandbox",
Dict{String,Any}("APNSVoipSandboxChannelRequest" => APNSVoipSandboxChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_apns_voip_sandbox_channel(
APNSVoipSandboxChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/apns_voip_sandbox",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"APNSVoipSandboxChannelRequest" => APNSVoipSandboxChannelRequest
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application_settings(write_application_settings_request, application-id)
update_application_settings(write_application_settings_request, application-id, params::Dict{String,<:Any})
Updates the settings for an application.
# Arguments
- `write_application_settings_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_application_settings(
WriteApplicationSettingsRequest,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/settings",
Dict{String,Any}(
"WriteApplicationSettingsRequest" => WriteApplicationSettingsRequest
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_settings(
WriteApplicationSettingsRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/settings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"WriteApplicationSettingsRequest" => WriteApplicationSettingsRequest
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_baidu_channel(baidu_channel_request, application-id)
update_baidu_channel(baidu_channel_request, application-id, params::Dict{String,<:Any})
Enables the Baidu channel for an application or updates the status and settings of the
Baidu channel for an application.
# Arguments
- `baidu_channel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_baidu_channel(
BaiduChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/baidu",
Dict{String,Any}("BaiduChannelRequest" => BaiduChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_baidu_channel(
BaiduChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/baidu",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BaiduChannelRequest" => BaiduChannelRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_campaign(write_campaign_request, application-id, campaign-id)
update_campaign(write_campaign_request, application-id, campaign-id, params::Dict{String,<:Any})
Updates the configuration and other settings for a campaign.
# Arguments
- `write_campaign_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `campaign-id`: The unique identifier for the campaign.
"""
function update_campaign(
WriteCampaignRequest,
application_id,
campaign_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)",
Dict{String,Any}("WriteCampaignRequest" => WriteCampaignRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_campaign(
WriteCampaignRequest,
application_id,
campaign_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/campaigns/$(campaign-id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WriteCampaignRequest" => WriteCampaignRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_email_channel(email_channel_request, application-id)
update_email_channel(email_channel_request, application-id, params::Dict{String,<:Any})
Enables the email channel for an application or updates the status and settings of the
email channel for an application.
# Arguments
- `email_channel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_email_channel(
EmailChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/email",
Dict{String,Any}("EmailChannelRequest" => EmailChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_email_channel(
EmailChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/email",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EmailChannelRequest" => EmailChannelRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_email_template(email_template_request, template-name)
update_email_template(email_template_request, template-name, params::Dict{String,<:Any})
Updates an existing message template for messages that are sent through the email channel.
# Arguments
- `email_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"create-new-version"`: Specifies whether to save the updates as a new version of the
message template. Valid values are: true, save the updates as a new version; and, false,
save the updates to (overwrite) the latest existing version of the template. If you don't
specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the
latest existing version of the template. If you specify a value of true for this parameter,
don't specify a value for the version parameter. Otherwise, an error will occur.
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function update_email_template(
EmailTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/email",
Dict{String,Any}("EmailTemplateRequest" => EmailTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_email_template(
EmailTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/email",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EmailTemplateRequest" => EmailTemplateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoint(endpoint_request, application-id, endpoint-id)
update_endpoint(endpoint_request, application-id, endpoint-id, params::Dict{String,<:Any})
Creates a new endpoint for an application or updates the settings and attributes of an
existing endpoint for an application. You can also use this operation to define custom
attributes for an endpoint. If an update includes one or more values for a custom
attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
# Arguments
- `endpoint_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `endpoint-id`: The case insensitive unique identifier for the endpoint. The identifier
can't contain , { or }.
"""
function update_endpoint(
EndpointRequest,
application_id,
endpoint_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)",
Dict{String,Any}("EndpointRequest" => EndpointRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint(
EndpointRequest,
application_id,
endpoint_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/endpoints/$(endpoint-id)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointRequest" => EndpointRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoints_batch(endpoint_batch_request, application-id)
update_endpoints_batch(endpoint_batch_request, application-id, params::Dict{String,<:Any})
Creates a new batch of endpoints for an application or updates the settings and attributes
of a batch of existing endpoints for an application. You can also use this operation to
define custom attributes for a batch of endpoints. If an update includes one or more values
for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the
new values.
# Arguments
- `endpoint_batch_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_endpoints_batch(
EndpointBatchRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/endpoints",
Dict{String,Any}("EndpointBatchRequest" => EndpointBatchRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoints_batch(
EndpointBatchRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/endpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndpointBatchRequest" => EndpointBatchRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_gcm_channel(gcmchannel_request, application-id)
update_gcm_channel(gcmchannel_request, application-id, params::Dict{String,<:Any})
Enables the GCM channel for an application or updates the status and settings of the GCM
channel for an application.
# Arguments
- `gcmchannel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_gcm_channel(
GCMChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/gcm",
Dict{String,Any}("GCMChannelRequest" => GCMChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_gcm_channel(
GCMChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/gcm",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GCMChannelRequest" => GCMChannelRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_in_app_template(in_app_template_request, template-name)
update_in_app_template(in_app_template_request, template-name, params::Dict{String,<:Any})
Updates an existing message template for messages sent through the in-app message channel.
# Arguments
- `in_app_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"create-new-version"`: Specifies whether to save the updates as a new version of the
message template. Valid values are: true, save the updates as a new version; and, false,
save the updates to (overwrite) the latest existing version of the template. If you don't
specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the
latest existing version of the template. If you specify a value of true for this parameter,
don't specify a value for the version parameter. Otherwise, an error will occur.
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function update_in_app_template(
InAppTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/inapp",
Dict{String,Any}("InAppTemplateRequest" => InAppTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_in_app_template(
InAppTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/inapp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InAppTemplateRequest" => InAppTemplateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_journey(write_journey_request, application-id, journey-id)
update_journey(write_journey_request, application-id, journey-id, params::Dict{String,<:Any})
Updates the configuration and other settings for a journey.
# Arguments
- `write_journey_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
"""
function update_journey(
WriteJourneyRequest,
application_id,
journey_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/journeys/$(journey-id)",
Dict{String,Any}("WriteJourneyRequest" => WriteJourneyRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_journey(
WriteJourneyRequest,
application_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/journeys/$(journey-id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WriteJourneyRequest" => WriteJourneyRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_journey_state(journey_state_request, application-id, journey-id)
update_journey_state(journey_state_request, application-id, journey-id, params::Dict{String,<:Any})
Cancels (stops) an active journey.
# Arguments
- `journey_state_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `journey-id`: The unique identifier for the journey.
"""
function update_journey_state(
JourneyStateRequest,
application_id,
journey_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/journeys/$(journey-id)/state",
Dict{String,Any}("JourneyStateRequest" => JourneyStateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_journey_state(
JourneyStateRequest,
application_id,
journey_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/journeys/$(journey-id)/state",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JourneyStateRequest" => JourneyStateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_push_template(push_notification_template_request, template-name)
update_push_template(push_notification_template_request, template-name, params::Dict{String,<:Any})
Updates an existing message template for messages that are sent through a push notification
channel.
# Arguments
- `push_notification_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"create-new-version"`: Specifies whether to save the updates as a new version of the
message template. Valid values are: true, save the updates as a new version; and, false,
save the updates to (overwrite) the latest existing version of the template. If you don't
specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the
latest existing version of the template. If you specify a value of true for this parameter,
don't specify a value for the version parameter. Otherwise, an error will occur.
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function update_push_template(
PushNotificationTemplateRequest,
template_name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/push",
Dict{String,Any}(
"PushNotificationTemplateRequest" => PushNotificationTemplateRequest
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_push_template(
PushNotificationTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/push",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PushNotificationTemplateRequest" => PushNotificationTemplateRequest
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_recommender_configuration(update_recommender_configuration, recommender-id)
update_recommender_configuration(update_recommender_configuration, recommender-id, params::Dict{String,<:Any})
Updates an Amazon Pinpoint configuration for a recommender model.
# Arguments
- `update_recommender_configuration`:
- `recommender-id`: The unique identifier for the recommender model configuration. This
identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
"""
function update_recommender_configuration(
UpdateRecommenderConfiguration,
recommender_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/recommenders/$(recommender-id)",
Dict{String,Any}(
"UpdateRecommenderConfiguration" => UpdateRecommenderConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_recommender_configuration(
UpdateRecommenderConfiguration,
recommender_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/recommenders/$(recommender-id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"UpdateRecommenderConfiguration" => UpdateRecommenderConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_segment(write_segment_request, application-id, segment-id)
update_segment(write_segment_request, application-id, segment-id, params::Dict{String,<:Any})
Creates a new segment for an application or updates the configuration, dimension, and other
settings for an existing segment that's associated with an application.
# Arguments
- `write_segment_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
- `segment-id`: The unique identifier for the segment.
"""
function update_segment(
WriteSegmentRequest,
application_id,
segment_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/segments/$(segment-id)",
Dict{String,Any}("WriteSegmentRequest" => WriteSegmentRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_segment(
WriteSegmentRequest,
application_id,
segment_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/segments/$(segment-id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WriteSegmentRequest" => WriteSegmentRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sms_channel(smschannel_request, application-id)
update_sms_channel(smschannel_request, application-id, params::Dict{String,<:Any})
Enables the SMS channel for an application or updates the status and settings of the SMS
channel for an application.
# Arguments
- `smschannel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_sms_channel(
SMSChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/sms",
Dict{String,Any}("SMSChannelRequest" => SMSChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sms_channel(
SMSChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/sms",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SMSChannelRequest" => SMSChannelRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sms_template(smstemplate_request, template-name)
update_sms_template(smstemplate_request, template-name, params::Dict{String,<:Any})
Updates an existing message template for messages that are sent through the SMS channel.
# Arguments
- `smstemplate_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"create-new-version"`: Specifies whether to save the updates as a new version of the
message template. Valid values are: true, save the updates as a new version; and, false,
save the updates to (overwrite) the latest existing version of the template. If you don't
specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the
latest existing version of the template. If you specify a value of true for this parameter,
don't specify a value for the version parameter. Otherwise, an error will occur.
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function update_sms_template(
SMSTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/sms",
Dict{String,Any}("SMSTemplateRequest" => SMSTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sms_template(
SMSTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/sms",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SMSTemplateRequest" => SMSTemplateRequest), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template_active_version(template_active_version_request, template-name, template-type)
update_template_active_version(template_active_version_request, template-name, template-type, params::Dict{String,<:Any})
Changes the status of a specific version of a message template to active.
# Arguments
- `template_active_version_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
- `template-type`: The type of channel that the message template is designed for. Valid
values are: EMAIL, PUSH, SMS, and VOICE.
"""
function update_template_active_version(
TemplateActiveVersionRequest,
template_name,
template_type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/$(template-type)/active-version",
Dict{String,Any}("TemplateActiveVersionRequest" => TemplateActiveVersionRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template_active_version(
TemplateActiveVersionRequest,
template_name,
template_type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/$(template-type)/active-version",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TemplateActiveVersionRequest" => TemplateActiveVersionRequest
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_voice_channel(voice_channel_request, application-id)
update_voice_channel(voice_channel_request, application-id, params::Dict{String,<:Any})
Enables the voice channel for an application or updates the status and settings of the
voice channel for an application.
# Arguments
- `voice_channel_request`:
- `application-id`: The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
"""
function update_voice_channel(
VoiceChannelRequest, application_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/voice",
Dict{String,Any}("VoiceChannelRequest" => VoiceChannelRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_voice_channel(
VoiceChannelRequest,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/apps/$(application-id)/channels/voice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VoiceChannelRequest" => VoiceChannelRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_voice_template(voice_template_request, template-name)
update_voice_template(voice_template_request, template-name, params::Dict{String,<:Any})
Updates an existing message template for messages that are sent through the voice channel.
# Arguments
- `voice_template_request`:
- `template-name`: The name of the message template. A template name must start with an
alphanumeric character and can contain a maximum of 128 characters. The characters can be
alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"create-new-version"`: Specifies whether to save the updates as a new version of the
message template. Valid values are: true, save the updates as a new version; and, false,
save the updates to (overwrite) the latest existing version of the template. If you don't
specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the
latest existing version of the template. If you specify a value of true for this parameter,
don't specify a value for the version parameter. Otherwise, an error will occur.
- `"version"`: The unique identifier for the version of the message template to update,
retrieve information about, or delete. To retrieve identifiers and other information for
all the versions of a template, use the Template Versions resource. If specified, this
value must match the identifier for an existing template version. If specified for an
update operation, this value must match the identifier for the latest existing version of
the template. This restriction helps ensure that race conditions don't occur. If you don't
specify a value for this parameter, Amazon Pinpoint does the following: For a get
operation, retrieves information about the active version of the template. For an update
operation, saves the updates to (overwrites) the latest existing version of the template,
if the create-new-version parameter isn't used or is set to false. For a delete operation,
deletes the template, including all versions of the template.
"""
function update_voice_template(
VoiceTemplateRequest, template_name; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/voice",
Dict{String,Any}("VoiceTemplateRequest" => VoiceTemplateRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_voice_template(
VoiceTemplateRequest,
template_name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"PUT",
"/v1/templates/$(template-name)/voice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VoiceTemplateRequest" => VoiceTemplateRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_otpmessage(verify_otpmessage_request_parameters, application-id)
verify_otpmessage(verify_otpmessage_request_parameters, application-id, params::Dict{String,<:Any})
Verify an OTP
# Arguments
- `verify_otpmessage_request_parameters`:
- `application-id`: The unique ID of your Amazon Pinpoint application.
"""
function verify_otpmessage(
VerifyOTPMessageRequestParameters,
application_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/verify-otp",
Dict{String,Any}(
"VerifyOTPMessageRequestParameters" => VerifyOTPMessageRequestParameters
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_otpmessage(
VerifyOTPMessageRequestParameters,
application_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint(
"POST",
"/v1/apps/$(application-id)/verify-otp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifyOTPMessageRequestParameters" => VerifyOTPMessageRequestParameters
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 66457 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pinpoint_email
using AWS.Compat
using AWS.UUIDs
"""
create_configuration_set(configuration_set_name)
create_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Create a configuration set. Configuration sets are groups of rules that you can apply to
the emails you send using Amazon Pinpoint. You apply a configuration set to an email by
including a reference to the configuration set in the headers of the email. When you apply
a configuration set to an email, all of the rules in that configuration set are applied to
the email.
# Arguments
- `configuration_set_name`: The name of the configuration set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryOptions"`: An object that defines the dedicated IP pool that is used to send
emails that you send using the configuration set.
- `"ReputationOptions"`: An object that defines whether or not Amazon Pinpoint collects
reputation metrics for the emails that you send that use the configuration set.
- `"SendingOptions"`: An object that defines whether or not Amazon Pinpoint can send email
that you send using the configuration set.
- `"Tags"`: An array of objects that define the tags (keys and values) that you want to
associate with the configuration set.
- `"TrackingOptions"`: An object that defines the open and click tracking options for
emails that you send using the configuration set.
"""
function create_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"POST",
"/v1/email/configuration-sets",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/configuration-sets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name)
create_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name, params::Dict{String,<:Any})
Create an event destination. In Amazon Pinpoint, events include message sends, deliveries,
opens, clicks, bounces, and complaints. Event destinations are places that you can send
information about these events to. For example, you can send event data to Amazon SNS to
receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis
Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set
can include more than one event destination.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to add an event
destination to.
- `event_destination`: An object that defines the event destination.
- `event_destination_name`: A name that identifies the event destination within the
configuration set.
"""
function create_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations",
Dict{String,Any}(
"EventDestination" => EventDestination,
"EventDestinationName" => EventDestinationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventDestination" => EventDestination,
"EventDestinationName" => EventDestinationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dedicated_ip_pool(pool_name)
create_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP
addresses that are associated with your Amazon Pinpoint account. You can associate a pool
with a configuration set. When you send an email that uses that configuration set, Amazon
Pinpoint sends it using only the IP addresses in the associated pool.
# Arguments
- `pool_name`: The name of the dedicated IP pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An object that defines the tags (keys and values) that you want to associate
with the pool.
"""
function create_dedicated_ip_pool(
PoolName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"POST",
"/v1/email/dedicated-ip-pools",
Dict{String,Any}("PoolName" => PoolName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dedicated_ip_pool(
PoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/dedicated-ip-pools",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PoolName" => PoolName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deliverability_test_report(content, from_email_address)
create_deliverability_test_report(content, from_email_address, params::Dict{String,<:Any})
Create a new predictive inbox placement test. Predictive inbox placement tests can help you
predict how your messages will be handled by various email providers around the world. When
you perform a predictive inbox placement test, you provide a sample message that contains
the content that you plan to send to your customers. Amazon Pinpoint then sends that
message to special email addresses spread across several major email providers. After about
24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation
to view the results of the test.
# Arguments
- `content`: The HTML body of the message that you sent when you performed the predictive
inbox placement test.
- `from_email_address`: The email address that the predictive inbox placement test email
was sent from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReportName"`: A unique name that helps you to identify the predictive inbox placement
test when you retrieve the results.
- `"Tags"`: An array of objects that define the tags (keys and values) that you want to
associate with the predictive inbox placement test.
"""
function create_deliverability_test_report(
Content, FromEmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"POST",
"/v1/email/deliverability-dashboard/test",
Dict{String,Any}("Content" => Content, "FromEmailAddress" => FromEmailAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deliverability_test_report(
Content,
FromEmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/deliverability-dashboard/test",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content, "FromEmailAddress" => FromEmailAddress
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_email_identity(email_identity)
create_email_identity(email_identity, params::Dict{String,<:Any})
Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is
an email address or domain that you use when you send email. Before you can use an identity
to send email with Amazon Pinpoint, you first have to verify it. By verifying an address,
you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint
permission to send email from the address. When you verify an email address, Amazon
Pinpoint sends an email to the address. Your email address is verified as soon as you
follow the link in the verification email. When you verify a domain, this operation
provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME
tokens to the DNS configuration for your domain. Your domain is verified when Amazon
Pinpoint detects these records in the DNS configuration for your domain. It usually takes
around 72 hours to complete the domain verification process.
# Arguments
- `email_identity`: The email address or domain that you want to verify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An array of objects that define the tags (keys and values) that you want to
associate with the email identity.
"""
function create_email_identity(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"POST",
"/v1/email/identities",
Dict{String,Any}("EmailIdentity" => EmailIdentity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_email_identity(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/identities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EmailIdentity" => EmailIdentity), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set(configuration_set_name)
delete_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Delete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of
rules that you can apply to the emails you send. You apply a configuration set to an email
by including a reference to the configuration set in the headers of the email. When you
apply a configuration set to an email, all of the rules in that configuration set are
applied to the email.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to delete.
"""
function delete_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"DELETE",
"/v1/email/configuration-sets/$(ConfigurationSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"DELETE",
"/v1/email/configuration-sets/$(ConfigurationSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set_event_destination(configuration_set_name, event_destination_name)
delete_configuration_set_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Delete an event destination. In Amazon Pinpoint, events include message sends, deliveries,
opens, clicks, bounces, and complaints. Event destinations are places that you can send
information about these events to. For example, you can send event data to Amazon SNS to
receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis
Data Firehose to stream data to Amazon S3 for long-term storage.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination that you want to delete.
- `event_destination_name`: The name of the event destination that you want to delete.
"""
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"DELETE",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"DELETE",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dedicated_ip_pool(pool_name)
delete_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})
Delete a dedicated IP pool.
# Arguments
- `pool_name`: The name of the dedicated IP pool that you want to delete.
"""
function delete_dedicated_ip_pool(
PoolName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"DELETE",
"/v1/email/dedicated-ip-pools/$(PoolName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dedicated_ip_pool(
PoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"DELETE",
"/v1/email/dedicated-ip-pools/$(PoolName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_email_identity(email_identity)
delete_email_identity(email_identity, params::Dict{String,<:Any})
Deletes an email identity that you previously verified for use with Amazon Pinpoint. An
identity can be either an email address or a domain name.
# Arguments
- `email_identity`: The identity (that is, the email address or domain) that you want to
delete from your Amazon Pinpoint account.
"""
function delete_email_identity(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"DELETE",
"/v1/email/identities/$(EmailIdentity)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_email_identity(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"DELETE",
"/v1/email/identities/$(EmailIdentity)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account()
get_account(params::Dict{String,<:Any})
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint
account in the current AWS Region.
"""
function get_account(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"GET", "/v1/email/account"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/account",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_blacklist_reports(blacklist_item_names)
get_blacklist_reports(blacklist_item_names, params::Dict{String,<:Any})
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
# Arguments
- `blacklist_item_names`: A list of IP addresses that you want to retrieve blacklist
information about. You can only specify the dedicated IP addresses that you use to send
email using Amazon Pinpoint or Amazon SES.
"""
function get_blacklist_reports(
BlacklistItemNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/blacklist-report",
Dict{String,Any}("BlacklistItemNames" => BlacklistItemNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_blacklist_reports(
BlacklistItemNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/blacklist-report",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("BlacklistItemNames" => BlacklistItemNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_set(configuration_set_name)
get_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Get information about an existing configuration set, including the dedicated IP pool that
it's associated with, whether or not it's enabled for sending email, and more. In Amazon
Pinpoint, configuration sets are groups of rules that you can apply to the emails you send.
You apply a configuration set to an email by including a reference to the configuration set
in the headers of the email. When you apply a configuration set to an email, all of the
rules in that configuration set are applied to the email.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to obtain more
information about.
"""
function get_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/configuration-sets/$(ConfigurationSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/configuration-sets/$(ConfigurationSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_set_event_destinations(configuration_set_name)
get_configuration_set_event_destinations(configuration_set_name, params::Dict{String,<:Any})
Retrieve a list of event destinations that are associated with a configuration set. In
Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and
complaints. Event destinations are places that you can send information about these events
to. For example, you can send event data to Amazon SNS to receive notifications when you
receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data
to Amazon S3 for long-term storage.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination.
"""
function get_configuration_set_event_destinations(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_set_event_destinations(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dedicated_ip(ip)
get_dedicated_ip(ip, params::Dict{String,<:Any})
Get information about a dedicated IP address, including the name of the dedicated IP pool
that it's associated with, as well information about the automatic warm-up process for the
address.
# Arguments
- `ip`: The IP address that you want to obtain more information about. The value you
specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint
account.
"""
function get_dedicated_ip(IP; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"GET",
"/v1/email/dedicated-ips/$(IP)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dedicated_ip(
IP, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/dedicated-ips/$(IP)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dedicated_ips()
get_dedicated_ips(params::Dict{String,<:Any})
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to GetDedicatedIps to indicate the
position of the dedicated IP pool in the list of IP pools.
- `"PageSize"`: The number of results to show in a single call to GetDedicatedIpsRequest.
If the number of results is larger than the number you specified in this parameter, then
the response includes a NextToken element, which you can use to obtain additional results.
- `"PoolName"`: The name of the IP pool that the dedicated IP address is associated with.
"""
function get_dedicated_ips(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"GET",
"/v1/email/dedicated-ips";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dedicated_ips(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/dedicated-ips",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deliverability_dashboard_options()
get_deliverability_dashboard_options(params::Dict{String,<:Any})
Retrieve information about the status of the Deliverability dashboard for your Amazon
Pinpoint account. When the Deliverability dashboard is enabled, you gain access to
reputation, deliverability, and other metrics for the domains that you use to send email
using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement
tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in
addition to any other fees that you accrue by using Amazon Pinpoint. For more information
about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint
Pricing.
"""
function get_deliverability_dashboard_options(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deliverability_dashboard_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deliverability_test_report(report_id)
get_deliverability_test_report(report_id, params::Dict{String,<:Any})
Retrieve the results of a predictive inbox placement test.
# Arguments
- `report_id`: A unique string that identifies the predictive inbox placement test.
"""
function get_deliverability_test_report(
ReportId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/test-reports/$(ReportId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deliverability_test_report(
ReportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/test-reports/$(ReportId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_deliverability_campaign(campaign_id)
get_domain_deliverability_campaign(campaign_id, params::Dict{String,<:Any})
Retrieve all the deliverability data for a specific campaign. This data is available for a
campaign only if the campaign sent email by using a domain that the Deliverability
dashboard is enabled for (PutDeliverabilityDashboardOption operation).
# Arguments
- `campaign_id`: The unique identifier for the campaign. Amazon Pinpoint automatically
generates and assigns this identifier to a campaign. This value is not the same as the
campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by
using the Amazon Pinpoint API or the Amazon Pinpoint console.
"""
function get_domain_deliverability_campaign(
CampaignId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/campaigns/$(CampaignId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_deliverability_campaign(
CampaignId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/campaigns/$(CampaignId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_statistics_report(domain, end_date, start_date)
get_domain_statistics_report(domain, end_date, start_date, params::Dict{String,<:Any})
Retrieve inbox placement and engagement rates for the domains that you use to send email.
# Arguments
- `domain`: The domain that you want to obtain deliverability metrics for.
- `end_date`: The last day (in Unix time) that you want to obtain domain deliverability
metrics for. The EndDate that you specify has to be less than or equal to 30 days after the
StartDate.
- `start_date`: The first day (in Unix time) that you want to obtain domain deliverability
metrics for.
"""
function get_domain_statistics_report(
Domain, EndDate, StartDate; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/statistics-report/$(Domain)",
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_statistics_report(
Domain,
EndDate,
StartDate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/statistics-report/$(Domain)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_email_identity(email_identity)
get_email_identity(email_identity, params::Dict{String,<:Any})
Provides information about a specific identity associated with your Amazon Pinpoint
account, including the identity's verification status, its DKIM authentication status, and
its custom Mail-From settings.
# Arguments
- `email_identity`: The email identity that you want to retrieve details for.
"""
function get_email_identity(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/identities/$(EmailIdentity)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_email_identity(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/identities/$(EmailIdentity)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_sets()
list_configuration_sets(params::Dict{String,<:Any})
List all of the configuration sets associated with your Amazon Pinpoint account in the
current region. In Amazon Pinpoint, configuration sets are groups of rules that you can
apply to the emails you send. You apply a configuration set to an email by including a
reference to the configuration set in the headers of the email. When you apply a
configuration set to an email, all of the rules in that configuration set are applied to
the email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListConfigurationSets to indicate
the position in the list of configuration sets.
- `"PageSize"`: The number of results to show in a single call to ListConfigurationSets. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results.
"""
function list_configuration_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"GET",
"/v1/email/configuration-sets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/configuration-sets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dedicated_ip_pools()
list_dedicated_ip_pools(params::Dict{String,<:Any})
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the
current AWS Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListDedicatedIpPools to indicate
the position in the list of dedicated IP pools.
- `"PageSize"`: The number of results to show in a single call to ListDedicatedIpPools. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results.
"""
function list_dedicated_ip_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"GET",
"/v1/email/dedicated-ip-pools";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dedicated_ip_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/dedicated-ip-pools",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deliverability_test_reports()
list_deliverability_test_reports(params::Dict{String,<:Any})
Show a list of the predictive inbox placement tests that you've performed, regardless of
their statuses. For predictive inbox placement tests that are complete, you can use the
GetDeliverabilityTestReport operation to view the results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListDeliverabilityTestReports to
indicate the position in the list of predictive inbox placement tests.
- `"PageSize"`: The number of results to show in a single call to
ListDeliverabilityTestReports. If the number of results is larger than the number you
specified in this parameter, then the response includes a NextToken element, which you can
use to obtain additional results. The value you specify has to be at least 0, and can be no
more than 1000.
"""
function list_deliverability_test_reports(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/test-reports";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deliverability_test_reports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/test-reports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domain_deliverability_campaigns(end_date, start_date, subscribed_domain)
list_domain_deliverability_campaigns(end_date, start_date, subscribed_domain, params::Dict{String,<:Any})
Retrieve deliverability data for all the campaigns that used a specific domain to send
email during a specified time range. This data is available for a domain only if you
enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the
domain.
# Arguments
- `end_date`: The last day, in Unix time format, that you want to obtain deliverability
data for. This value has to be less than or equal to 30 days after the value of the
StartDate parameter.
- `start_date`: The first day, in Unix time format, that you want to obtain deliverability
data for.
- `subscribed_domain`: The domain to obtain deliverability data for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns operation. This token indicates the position of a
campaign in the list of campaigns.
- `"PageSize"`: The maximum number of results to include in response to a single call to
the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than
the number that you specify in this parameter, the response includes a NextToken element,
which you can use to obtain additional results.
"""
function list_domain_deliverability_campaigns(
EndDate, StartDate, SubscribedDomain; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/domains/$(SubscribedDomain)/campaigns",
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_domain_deliverability_campaigns(
EndDate,
StartDate,
SubscribedDomain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/deliverability-dashboard/domains/$(SubscribedDomain)/campaigns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_email_identities()
list_email_identities(params::Dict{String,<:Any})
Returns a list of all of the email identities that are associated with your Amazon Pinpoint
account. An identity can be either an email address or a domain. This operation returns
identities that are verified as well as those that aren't.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListEmailIdentities to indicate
the position in the list of identities.
- `"PageSize"`: The number of results to show in a single call to ListEmailIdentities. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results. The
value you specify has to be at least 0, and can be no more than 1000.
"""
function list_email_identities(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"GET",
"/v1/email/identities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_email_identities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/identities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieve a list of the tags (keys and values) that are associated with a specified
resource. A tag is a label that you optionally define and associate with a resource in
Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag
value. A tag key is a general label that acts as a category for more specific tag values. A
tag value acts as a descriptor within a tag key.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to retrieve
tag information for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"GET",
"/v1/email/tags",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"GET",
"/v1/email/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_dedicated_ip_warmup_attributes()
put_account_dedicated_ip_warmup_attributes(params::Dict{String,<:Any})
Enable or disable the automatic warm-up feature for dedicated IP addresses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoWarmupEnabled"`: Enables or disables the automatic warm-up feature for dedicated IP
addresses that are associated with your Amazon Pinpoint account in the current AWS Region.
Set to true to enable the automatic warm-up feature, or set to false to disable it.
"""
function put_account_dedicated_ip_warmup_attributes(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/account/dedicated-ips/warmup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_dedicated_ip_warmup_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/account/dedicated-ips/warmup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_sending_attributes()
put_account_sending_attributes(params::Dict{String,<:Any})
Enable or disable the ability of your account to send email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SendingEnabled"`: Enables or disables your account's ability to send email. Set to true
to enable email sending, or set to false to disable email sending. If AWS paused your
account's ability to send email, you can't use this operation to resume your account's
ability to send email.
"""
function put_account_sending_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"PUT",
"/v1/email/account/sending";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_sending_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/account/sending",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_delivery_options(configuration_set_name)
put_configuration_set_delivery_options(configuration_set_name, params::Dict{String,<:Any})
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to
create groups of dedicated IP addresses for sending specific types of email.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to associate
with a dedicated IP pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SendingPoolName"`: The name of the dedicated IP pool that you want to associate with
the configuration set.
- `"TlsPolicy"`: Specifies whether messages that use the configuration set are required to
use Transport Layer Security (TLS). If the value is Require, messages are only delivered if
a TLS connection can be established. If the value is Optional, messages can be delivered in
plain text if a TLS connection can't be established.
"""
function put_configuration_set_delivery_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/delivery-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_delivery_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/delivery-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_reputation_options(configuration_set_name)
put_configuration_set_reputation_options(configuration_set_name, params::Dict{String,<:Any})
Enable or disable collection of reputation metrics for emails that you send using a
particular configuration set in a specific AWS Region.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to enable or
disable reputation metric tracking for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReputationMetricsEnabled"`: If true, tracking of reputation metrics is enabled for the
configuration set. If false, tracking of reputation metrics is disabled for the
configuration set.
"""
function put_configuration_set_reputation_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/reputation-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_reputation_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/reputation-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_sending_options(configuration_set_name)
put_configuration_set_sending_options(configuration_set_name, params::Dict{String,<:Any})
Enable or disable email sending for messages that use a particular configuration set in a
specific AWS Region.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to enable or
disable email sending for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SendingEnabled"`: If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
"""
function put_configuration_set_sending_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/sending";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_sending_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/sending",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_tracking_options(configuration_set_name)
put_configuration_set_tracking_options(configuration_set_name, params::Dict{String,<:Any})
Specify a custom domain to use for open and click tracking elements in email that you send
using Amazon Pinpoint.
# Arguments
- `configuration_set_name`: The name of the configuration set that you want to add a custom
tracking domain to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomRedirectDomain"`: The domain that you want to use to track open and click events.
"""
function put_configuration_set_tracking_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/tracking-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_tracking_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/tracking-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_dedicated_ip_in_pool(destination_pool_name, ip)
put_dedicated_ip_in_pool(destination_pool_name, ip, params::Dict{String,<:Any})
Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address
that you specify must already exist, and must be associated with your Amazon Pinpoint
account. The dedicated IP pool you specify must already exist. You can create a new pool
by using the CreateDedicatedIpPool operation.
# Arguments
- `destination_pool_name`: The name of the IP pool that you want to add the dedicated IP
address to. You have to specify an IP pool that already exists.
- `ip`: The IP address that you want to move to the dedicated IP pool. The value you
specify has to be a dedicated IP address that's associated with your Amazon Pinpoint
account.
"""
function put_dedicated_ip_in_pool(
DestinationPoolName, IP; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/dedicated-ips/$(IP)/pool",
Dict{String,Any}("DestinationPoolName" => DestinationPoolName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_dedicated_ip_in_pool(
DestinationPoolName,
IP,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/dedicated-ips/$(IP)/pool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DestinationPoolName" => DestinationPoolName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_dedicated_ip_warmup_attributes(ip, warmup_percentage)
put_dedicated_ip_warmup_attributes(ip, warmup_percentage, params::Dict{String,<:Any})
# Arguments
- `ip`: The dedicated IP address that you want to update the warm-up attributes for.
- `warmup_percentage`: The warm-up percentage that you want to associate with the dedicated
IP address.
"""
function put_dedicated_ip_warmup_attributes(
IP, WarmupPercentage; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/dedicated-ips/$(IP)/warmup",
Dict{String,Any}("WarmupPercentage" => WarmupPercentage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_dedicated_ip_warmup_attributes(
IP,
WarmupPercentage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/dedicated-ips/$(IP)/warmup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WarmupPercentage" => WarmupPercentage), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_deliverability_dashboard_option(dashboard_enabled)
put_deliverability_dashboard_option(dashboard_enabled, params::Dict{String,<:Any})
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you
enable the Deliverability dashboard, you gain access to reputation, deliverability, and
other metrics for the domains that you use to send email using Amazon Pinpoint. You also
gain the ability to perform predictive inbox placement tests. When you use the
Deliverability dashboard, you pay a monthly subscription charge, in addition to any other
fees that you accrue by using Amazon Pinpoint. For more information about the features and
cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
# Arguments
- `dashboard_enabled`: Specifies whether to enable the Deliverability dashboard for your
Amazon Pinpoint account. To enable the dashboard, set this value to true.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubscribedDomains"`: An array of objects, one for each verified domain that you use to
send email and enabled the Deliverability dashboard for.
"""
function put_deliverability_dashboard_option(
DashboardEnabled; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/deliverability-dashboard",
Dict{String,Any}("DashboardEnabled" => DashboardEnabled);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_deliverability_dashboard_option(
DashboardEnabled,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/deliverability-dashboard",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DashboardEnabled" => DashboardEnabled), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_dkim_attributes(email_identity)
put_email_identity_dkim_attributes(email_identity, params::Dict{String,<:Any})
Used to enable or disable DKIM authentication for an email identity.
# Arguments
- `email_identity`: The email identity that you want to change the DKIM settings for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SigningEnabled"`: Sets the DKIM signing configuration for the identity. When you set
this value true, then the messages that Amazon Pinpoint sends from the identity are
DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends
from the identity aren't DKIM-signed.
"""
function put_email_identity_dkim_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/identities/$(EmailIdentity)/dkim";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_dkim_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/identities/$(EmailIdentity)/dkim",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_feedback_attributes(email_identity)
put_email_identity_feedback_attributes(email_identity, params::Dict{String,<:Any})
Used to enable or disable feedback forwarding for an identity. This setting determines what
happens when an identity is used to send an email that results in a bounce or complaint
event. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications
when bounce or complaint events occur. Amazon Pinpoint sends this notification to the
address that you specified in the Return-Path header of the original email. When you
disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms,
such as by notifying an Amazon SNS topic. You're required to have a method of tracking
bounces and complaints. If you haven't set up another mechanism for receiving bounce or
complaint notifications, Amazon Pinpoint sends an email notification when these events
occur (even if this setting is disabled).
# Arguments
- `email_identity`: The email identity that you want to configure bounce and complaint
feedback forwarding for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EmailForwardingEnabled"`: Sets the feedback forwarding configuration for the identity.
If the value is true, Amazon Pinpoint sends you email notifications when bounce or
complaint events occur. Amazon Pinpoint sends this notification to the address that you
specified in the Return-Path header of the original email. When you set this value to
false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying
an Amazon SNS topic or another event destination. You're required to have a method of
tracking bounces and complaints. If you haven't set up another mechanism for receiving
bounce or complaint notifications, Amazon Pinpoint sends an email notification when these
events occur (even if this setting is disabled).
"""
function put_email_identity_feedback_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/identities/$(EmailIdentity)/feedback";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_feedback_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/identities/$(EmailIdentity)/feedback",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_mail_from_attributes(email_identity)
put_email_identity_mail_from_attributes(email_identity, params::Dict{String,<:Any})
Used to enable or disable the custom Mail-From domain configuration for an email identity.
# Arguments
- `email_identity`: The verified email identity that you want to set up the custom MAIL
FROM domain for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BehaviorOnMxFailure"`: The action that you want Amazon Pinpoint to take if it can't
read the required MX record when you send an email. When you set this value to
UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set
this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and
doesn't attempt to deliver the email. These behaviors are taken when the custom MAIL FROM
domain configuration is in the Pending, Failed, and TemporaryFailure states.
- `"MailFromDomain"`: The custom MAIL FROM domain that you want the verified identity to
use. The MAIL FROM domain must meet the following criteria: It has to be a subdomain of
the verified identity. It can't be used to receive email. It can't be used in a
\"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails.
"""
function put_email_identity_mail_from_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"PUT",
"/v1/email/identities/$(EmailIdentity)/mail-from";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_mail_from_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/identities/$(EmailIdentity)/mail-from",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_email(content, destination)
send_email(content, destination, params::Dict{String,<:Any})
Sends an email message. You can use the Amazon Pinpoint Email API to send two types of
messages: Simple – A standard email message. When you create this type of message, you
specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the
message for you. Raw – A raw, MIME-formatted email message. When you send this type of
email, you have to specify all of the message headers, as well as the message body. You can
use this message type to send messages that contain attachments. The message that you
specify has to be a valid MIME message.
# Arguments
- `content`: An object that contains the body of the message. You can send either a Simple
message or a Raw message.
- `destination`: An object that contains the recipients of the email message.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set that you want to use when
sending the email.
- `"EmailTags"`: A list of tags, in the form of name/value pairs, to apply to an email that
you send using the SendEmail operation. Tags correspond to characteristics of the email
that you define, so that you can publish email sending events.
- `"FeedbackForwardingEmailAddress"`: The address that Amazon Pinpoint should send bounce
and complaint notifications to.
- `"FromEmailAddress"`: The email address that you want to use as the \"From\" address for
the email. The address that you specify has to be verified.
- `"ReplyToAddresses"`: The \"Reply-to\" email addresses for the message. When the
recipient replies to the message, each Reply-to address receives the reply.
"""
function send_email(Content, Destination; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"POST",
"/v1/email/outbound-emails",
Dict{String,Any}("Content" => Content, "Destination" => Destination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_email(
Content,
Destination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/outbound-emails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Content" => Content, "Destination" => Destination),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Add one or more tags (keys and values) to a specified resource. A tag is a label that you
optionally define and associate with a resource in Amazon Pinpoint. Tags can help you
categorize and manage resources in different ways, such as by purpose, owner, environment,
or other criteria. A resource can have as many as 50 tags. Each tag consists of a
required tag key and an associated tag value, both of which you define. A tag key is a
general label that acts as a category for more specific tag values. A tag value acts as a
descriptor within a tag key.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to add one
or more tags to.
- `tags`: A list of the tags that you want to add to the resource. A tag consists of a
required tag key (Key) and an associated tag value (Value). The maximum length of a tag key
is 128 characters. The maximum length of a tag value is 256 characters.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_email(
"POST",
"/v1/email/tags",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"POST",
"/v1/email/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Remove one or more tags (keys and values) from a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to remove
one or more tags from.
- `tag_keys`: The tags (tag keys) that you want to remove from the resource. When you
specify a tag key, the action removes both that key and its associated tag value. To remove
more than one tag from the resource, append the TagKeys parameter and argument for each
additional tag to remove, separated by an ampersand. For example:
/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_email(
"DELETE",
"/v1/email/tags",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"DELETE",
"/v1/email/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name)
update_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name, params::Dict{String,<:Any})
Update the configuration of an event destination for a configuration set. In Amazon
Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints.
Event destinations are places that you can send information about these events to. For
example, you can send event data to Amazon SNS to receive notifications when you receive
bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon
S3 for long-term storage.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination that you want to modify.
- `event_destination`: An object that defines the event destination.
- `event_destination_name`: The name of the event destination that you want to modify.
"""
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
Dict{String,Any}("EventDestination" => EventDestination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_email(
"PUT",
"/v1/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EventDestination" => EventDestination), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 9747 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pinpoint_sms_voice
using AWS.Compat
using AWS.UUIDs
"""
create_configuration_set()
create_configuration_set(params::Dict{String,<:Any})
Create a new configuration set. After you create the configuration set, you can add one or
more event destinations to it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name that you want to give the configuration set.
"""
function create_configuration_set(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice(
"POST",
"/v1/sms-voice/configuration-sets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice(
"POST",
"/v1/sms-voice/configuration-sets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set_event_destination(configuration_set_name)
create_configuration_set_event_destination(configuration_set_name, params::Dict{String,<:Any})
Create a new event destination in a configuration set.
# Arguments
- `configuration_set_name`: ConfigurationSetName
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventDestination"`:
- `"EventDestinationName"`: A name that identifies the event destination.
"""
function create_configuration_set_event_destination(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice(
"POST",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set_event_destination(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"POST",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set(configuration_set_name)
delete_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Deletes an existing configuration set.
# Arguments
- `configuration_set_name`: ConfigurationSetName
"""
function delete_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice(
"DELETE",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"DELETE",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set_event_destination(configuration_set_name, event_destination_name)
delete_configuration_set_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Deletes an event destination in a configuration set.
# Arguments
- `configuration_set_name`: ConfigurationSetName
- `event_destination_name`: EventDestinationName
"""
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"DELETE",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"DELETE",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_set_event_destinations(configuration_set_name)
get_configuration_set_event_destinations(configuration_set_name, params::Dict{String,<:Any})
Obtain information about an event destination, including the types of events it reports,
the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
# Arguments
- `configuration_set_name`: ConfigurationSetName
"""
function get_configuration_set_event_destinations(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice(
"GET",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_set_event_destinations(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"GET",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_sets()
list_configuration_sets(params::Dict{String,<:Any})
List all of the configuration sets associated with your Amazon Pinpoint account in the
current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to the API that indicates the
position in the list of results.
- `"PageSize"`: Used to specify the number of items that should be returned in the response.
"""
function list_configuration_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice(
"GET",
"/v1/sms-voice/configuration-sets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice(
"GET",
"/v1/sms-voice/configuration-sets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_voice_message()
send_voice_message(params::Dict{String,<:Any})
Create a new voice message and send it to a recipient's phone number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CallerId"`: The phone number that appears on recipients' devices when they receive the
message.
- `"ConfigurationSetName"`: The name of the configuration set that you want to use to send
the message.
- `"Content"`:
- `"DestinationPhoneNumber"`: The phone number that you want to send the voice message to.
- `"OriginationPhoneNumber"`: The phone number that Amazon Pinpoint should use to send the
voice message. This isn't necessarily the phone number that appears on recipients' devices
when they receive the message, because you can specify a CallerId parameter in the request.
"""
function send_voice_message(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice(
"POST",
"/v1/sms-voice/voice/message";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_voice_message(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice(
"POST",
"/v1/sms-voice/voice/message",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_event_destination(configuration_set_name, event_destination_name)
update_configuration_set_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Update an event destination in a configuration set. An event destination is a location that
you publish information about your voice calls to. For example, you can log an event to an
Amazon CloudWatch destination when a call fails.
# Arguments
- `configuration_set_name`: ConfigurationSetName
- `event_destination_name`: EventDestinationName
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventDestination"`:
"""
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"PUT",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice(
"PUT",
"/v1/sms-voice/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.